machine-maker/arierajail

Custom Bukkit plugin requested by BananaBiscuits

ArieraJail

Custom Bukkit plugin requested by BananaBiscuits

Setting up Jails and Cells

Step 0:

Make sure you have WorldEdit installed. This plugin will give an error on server startup if it is not installed!

Step 1:

Select an area in the shape of a cube using the WorldEdit axe (use //wand to get one).

Step 2:

Create the jail with a custom name by running the command /aj createjail <jail> after you have selected the jail area.

Step 3:

Set the release location, the location will players will be teleported to when they are released, with the command /aj setrelease <jailname>. If no jail exists with that name, you will receive an error message saying as much.

Step 4:

Create cells inside the jail with /aj createcell <jail> <cell>. You must specify the jail you want to create the cell for as well as a custom cell name. The name for the cell must be unique for each cell per jail.

Step 5:

For each cell you create, you must also specify a spawn point in a cell. This is pretty simple as all you have to do is stand inside the cell area and do /aj setcellspawn.

Step 6:

Once you've handcuffed a player, to get him into a cell you have to create a sign for each cell that displays information on the cell and who's inside. Place a sign and while your crosshairs are on the sign, do /aj createsign <jailname> <cellname>. If everything goes as planned, the sign should look something like this.

You're done!

The jail and cells are now setup and ready for use!

---

Using handcuffs

To get a pair of handcuffs in your inventory do /handcuffs. With the handcuffs, right click on another player. You (and they) will receive a message when they are successfully handcuffed. While the player is handcuffed, they will be walking at half speed and if they get more than 4 blocks away from you, they are teleported to you. The default 4 block distance is configurable. When you arrive at the jail, find an unoccupied cell and right click the sign. When you hover over the sign you should get a message on the action bar telling you to click. When you click, all the items/armor on the player are removed (and stored) and they are teleported into the cell where they stay for a configurable amount of time. You can also choose to release them early by clicking on the sign with a player in the corresponding cell.

---

Commands and Permissions

Commands	Aliases	Description	Permissions
/aj createjail <jail>	(createj, cj)	Creates a jail	arierajail.createjail
/aj deletejail <jail>	(deljail, dj)	Deletes a jail	arierajail.deletejail
/aj createcell <jail> <cell>	(createc, cc)	Creates a cell	arierajail.createcell
/aj deletecell <jail> <cell>	(delcell, dc)	Deletes a cell	arierajail.deletecell
/aj setrelease <jail>	(setr, sr)	Sets the release point	arierajail.setrelease
/aj setcellspawn	(setcs, scs)	Sets the cell spawn	arierajail.setcellspawn
/aj reload <config-type>	(rel, r)	Reloads configurations	arierajail.reload
/aj jaillist	(jlist, jl)	Lists jails and cells	arierajail.jaillist
/aj log <playername|all>	(l)	Displays a jail log	arierajail.log
/aj clearlog	(clog, cl)	Clears all logs	arierajail.clearlog
/handcuffs	(cuffs)	Gives handcuffs	arierajail.handcuffs
/unhandcuff	(uncuff)	Unhandcuffs player	arierajail.handcuffs
/timeleft	(tl)	Shows time left in jail	arierajail.timeleft

Standalone Permissions

Permission	Description
arierajail.log.self	Allows player to see their own log
arierajail.log.others	Allows player to see other's logs
arierajail.log.all	Allows player to see all logs
arierajail.putinjail	Allows cops to put player in a cell
arierajail.releasefromjail	Allows cops to release a player
arierajail.handcuffs.bypass	Makes handcuffs not work on this player
arierajail.handcuffs.use	Allows the use of handcuffs on other players
arierajail.playerquit.bypass	Allows player to avoid quitting penalties

---

Configuration

• must-stay-still-time-if-handcuffed-in-seconds: 5 -> Time that player must not move for handcuffs to take effect
• max-distance-squared: 16 -> Distance squared (so 4 is default) that the player is allowed to be from the player that cuffed them
• if-player-quits: -> This section deals with what happens to the player if he disconnects while in handcuffs
  • kill-player: false -> If true, player will die and all items will be dropped if he disconnects
  • temp-ban: -> This section deals with banning the player if he disconnects while in handcuffs
    • enable: true -> if true player will be temporarily banned (true by default)
    • time-in-minutes: 10 -> Time in minutes the player will be banned
    • ban-message: "&4You left the game after you were caught!" -> Ban message (supports colors)
• sentence-length-in-minutes: 5 -> The length the player is in jail before released.

---

Other info

The messages.yml file which is generated on first startup contains the configuration for all the messages the plugin sends to players. Feel free to change them as you see fit. The messages that have macros such as %playername% or %jailname% are pretty self-explanatory and can only be used in the messages that start out with them. I recommend not messing with the other files (ie: jails.yml and signs.yml) unless you want to mass delete your jails and signs. Those files just contain location data and information on the jails, cells, and signs that have to be saved when the server is reloaded.