Jail/README.md

[Jail 3.0](http://ci.graywolf336.com/job/Jail/) - [JavaDoc](http://ci.graywolf336.com/job/Jail/javadoc) - [Wiki](https://github.com/graywolf336/Jail/wiki)
====
This plugins adds Jail to your Minecraft server. Admins can define several jails and then jail/unjail people, can be on a time basis. This plugin also offers wide variety of protections, this way players won't escape out of jail.

[![Build Status](http://ci.graywolf336.com/job/Jail/badge/icon)](http://ci.graywolf336.com/job/Jail/)

Beta 3 Changes
===
*Changes since Beta 2*
* Added support for sqlite storage
* Add advanced update notifications, even for beta builds
* Move cellcreate command to createcell
* Fix an out of bounds exception when using old jail stick configurations
* Make the timer async, this helps performance when you have a ton of prisoners
* Lots of work on unit testing
* Changed the encoding of the project in maven to utf8
* Fixed the language system not copying over new values
* Fixed confirmations not expiring, ever
* Commands clear and clear force have been combined, use -f (-force) if you want to forcefully clear

Beta 2 Changes
===
*Changes since Beta 1*
* Using UUID as the only means of knowing if someone is jailed or not, last known username is stored for commands
* Jailings via jail sticks are now recorded, [#20](https://github.com/graywolf336/Jail/issues/20)
* Fix the default Jail Stick not being loaded correctly, [#21](https://github.com/graywolf336/Jail/issues/21)
* Implement Scoreboards, with title and time configurable. ([#15](https://github.com/graywolf336/Jail/issues/15))
* Implemented Jail Pay [#11](https://github.com/graywolf336/Jail/issues/11)
* Convert old data and config values, only some are done and if you don't want the old data delete your `global.yml`
* Add config option to disallow the usage of Jail Sticks
* Added `/jail time` for easy access to adding/subtracting time - [Bukkit Dev Ticket #432](http://dev.bukkit.org/bukkit-plugins/jail/tickets/432/)
* Added `/togglejaildebug` for easily toggling the debugging state, enable if you have a problem and want to send me information
* Added some caching of online prisoners and where they're located at, this improves performance on servers with 500+ prisoners jailed
* Only updating prisoners in the database if they were changed, this should help improve saving speed

Beta 1 Changes
===
*Changes since alpha*
* MySQL storage is now a valid option for storage ([#18](https://github.com/graywolf336/Jail/issues/18))
* MySQL data validation, basically if a cell or prisoner reference a jail which no longer exists they are removed
* Fix a bug with not being able to unjail someone forcefully if they were in a cell ([#17](https://github.com/graywolf336/Jail/issues/17))
* Add the record keeping system ([#12](https://github.com/graywolf336/Jail/issues/12))
* Added Jail Sticks, format of them has slightly changed ([#16](https://github.com/graywolf336/Jail/issues/16))

Changes
===
*With this being version 3 of this plugin, a couple things have changed but the core concept is still the exact same. Here are some drastic changes:*
* Time can now be entered different formats, 3hours or 15mins or 4days
* New language system
* New config system (per jail configs are going to make a come back)
* Items in the config use item names now, **not** the ids
* All commands are prevented by default, now there is **only** a whitelist
* All interactions are prevented by default, add to the whitelist what you want
* If store inventory is not enabled, inventories are deleted upon jailing
* Sign text has a new format, old format will not be converted
* Max reason length has been removed, might be added back in if needed

ToDo
===
* Jail set
* Jail vote
* Jailing for swearing
* Guards (PlayerMoveProtectionAction - when they try to move do we teleport them back, let the guards get them, or nothing)
* Storing permissions
* Pages on jail list

Notice
===
* Old messages (language) will not be converted
* MaximumAFKTime setting will not convert over, the format isn't clear and the old version didn't provide a way to get values with decimal places
* EnableLogging has been removed, we are always going to be logging (unless major request to control this)
* Prisoner's old inventory strings in the database are lost, we can not convert those
Work on the commands help and usage, sync with the wiki pages. 2014-07-25 07:10:26 +02:00			`[Jail 3.0](http://ci.graywolf336.com/job/Jail/) - [JavaDoc](http://ci.graywolf336.com/job/Jail/javadoc) - [Wiki](https://github.com/graywolf336/Jail/wiki)`
Add .gitattributes 2014-06-12 17:44:13 +02:00			`====`
Just some edits to the readme 2014-07-25 06:31:56 +02:00			`This plugins adds Jail to your Minecraft server. Admins can define several jails and then jail/unjail people, can be on a time basis. This plugin also offers wide variety of protections, this way players won't escape out of jail.`
Add .gitattributes 2014-06-12 17:44:13 +02:00
Just some edits to the readme 2014-07-25 06:31:56 +02:00			`[![Build Status](http://ci.graywolf336.com/job/Jail/badge/icon)](http://ci.graywolf336.com/job/Jail/)`
Add .gitattributes 2014-06-12 17:44:13 +02:00
Update the readme. 2014-07-23 23:44:22 +02:00			`Beta 3 Changes`
			`===`
			`Changes since Beta 2`
Add support for sqlite storage. 2014-08-19 23:54:14 +02:00			`* Added support for sqlite storage`
Update the readme. 2014-07-23 23:44:22 +02:00			`* Add advanced update notifications, even for beta builds`
			`* Move cellcreate command to createcell`
			`* Fix an out of bounds exception when using old jail stick configurations`
			`* Make the timer async, this helps performance when you have a ton of prisoners`
			`* Lots of work on unit testing`
			`* Changed the encoding of the project in maven to utf8`
Simplify the language system and the language calls, also fix the language system not copying over the new values when new values were added. 2014-07-25 04:16:57 +02:00			`* Fixed the language system not copying over new values`
Move clearforce into clear and use -f (-force) to forcefully do it. It does still require the permission `jail.command.jailclearforce` and if it isn't provided then it will fall back to regular clearing. 2014-07-25 06:29:53 +02:00			`* Fixed confirmations not expiring, ever`
Just some edits to the readme 2014-07-25 06:31:56 +02:00			`* Commands clear and clear force have been combined, use -f (-force) if you want to forcefully clear`
Update the readme. 2014-07-23 23:44:22 +02:00
Add .gitattributes 2014-06-12 17:44:13 +02:00			`Beta 2 Changes`
			`===`
			`Changes since Beta 1`
			`* Using UUID as the only means of knowing if someone is jailed or not, last known username is stored for commands`
			`* Jailings via jail sticks are now recorded, [#20](https://github.com/graywolf336/Jail/issues/20)`
			`* Fix the default Jail Stick not being loaded correctly, [#21](https://github.com/graywolf336/Jail/issues/21)`
			`* Implement Scoreboards, with title and time configurable. ([#15](https://github.com/graywolf336/Jail/issues/15))`
			`* Implemented Jail Pay [#11](https://github.com/graywolf336/Jail/issues/11)`
			* Convert old data and config values, only some are done and if you don't want the old data delete your `global.yml`
			`* Add config option to disallow the usage of Jail Sticks`
			* Added `/jail time` for easy access to adding/subtracting time - [Bukkit Dev Ticket #432](http://dev.bukkit.org/bukkit-plugins/jail/tickets/432/)
			* Added `/togglejaildebug` for easily toggling the debugging state, enable if you have a problem and want to send me information
Add reference to the cache in the readme. 2014-06-12 18:03:04 +02:00			`* Added some caching of online prisoners and where they're located at, this improves performance on servers with 500+ prisoners jailed`
Only save the prisoners if they were changed, add that flag. 2014-07-15 01:23:29 +02:00			`* Only updating prisoners in the database if they were changed, this should help improve saving speed`
Add .gitattributes 2014-06-12 17:44:13 +02:00
			`Beta 1 Changes`
			`===`
			`Changes since alpha`
			`* MySQL storage is now a valid option for storage ([#18](https://github.com/graywolf336/Jail/issues/18))`
			`* MySQL data validation, basically if a cell or prisoner reference a jail which no longer exists they are removed`
			`* Fix a bug with not being able to unjail someone forcefully if they were in a cell ([#17](https://github.com/graywolf336/Jail/issues/17))`
			`* Add the record keeping system ([#12](https://github.com/graywolf336/Jail/issues/12))`
			`* Added Jail Sticks, format of them has slightly changed ([#16](https://github.com/graywolf336/Jail/issues/16))`

			`Changes`
			`===`
			`With this being version 3 of this plugin, a couple things have changed but the core concept is still the exact same. Here are some drastic changes:`
			`* Time can now be entered different formats, 3hours or 15mins or 4days`
			`* New language system`
			`* New config system (per jail configs are going to make a come back)`
			`* Items in the config use item names now, not the ids`
			`* All commands are prevented by default, now there is only a whitelist`
			`* All interactions are prevented by default, add to the whitelist what you want`
			`* If store inventory is not enabled, inventories are deleted upon jailing`
			`* Sign text has a new format, old format will not be converted`
			`* Max reason length has been removed, might be added back in if needed`

			`ToDo`
			`===`
			`* Jail set`
			`* Jail vote`
			`* Jailing for swearing`
			`* Guards (PlayerMoveProtectionAction - when they try to move do we teleport them back, let the guards get them, or nothing)`
			`* Storing permissions`
			`* Pages on jail list`

			`Notice`
			`===`
			`* Old messages (language) will not be converted`
			`* MaximumAFKTime setting will not convert over, the format isn't clear and the old version didn't provide a way to get values with decimal places`
			`* EnableLogging has been removed, we are always going to be logging (unless major request to control this)`
			`* Prisoner's old inventory strings in the database are lost, we can not convert those`