Forgot to save the readme....whoops.

This commit is contained in:
graywolf336 2015-06-30 16:11:48 -05:00
parent c9696b8671
commit 07938209bb

215
README.md
View File

@ -1,107 +1,108 @@
[Jail 3.0](http://ci.graywolf336.com/job/Jail/) - [JavaDoc](http://ci.graywolf336.com/job/Jail/javadoc) - [Wiki](https://github.com/graywolf336/Jail/wiki) - [Translate](https://poeditor.com/join/project/zK1CT5cash) [Jail 3.0](http://ci.graywolf336.com/job/Jail/) - [JavaDoc](http://ci.graywolf336.com/job/Jail/javadoc) - [Wiki](https://github.com/graywolf336/Jail/wiki) - [Translate](https://poeditor.com/join/project/zK1CT5cash)
==== ====
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. 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/) [![Build Status](http://ci.graywolf336.com/job/Jail/badge/icon)](http://ci.graywolf336.com/job/Jail/)
Developing/Building Developing/Building
=== ===
If you want to make some changes, build, and run the unit tests you will notice we require CraftBukkit 1.8 with maven and it isn't hosted anywhere publically for legal reasons. You will need to build CraftBukkit 1.8 yourself and then put it locally for maven with the following command: If you want to make some changes, build, and run the unit tests you will notice we require CraftBukkit 1.8 with maven and it isn't hosted anywhere publically for legal reasons. You will need to build CraftBukkit 1.8 yourself and then put it locally for maven with the following command:
`mvn install:install-file -Dfile=craftbukkit-1.8.jar -DgroupId=org.bukkit -DartifactId=craftbukkit -Dversion=1.8-R0.1-SNAPSHOT -Dpackaging=jar` `mvn install:install-file -Dfile=craftbukkit-1.8.jar -DgroupId=org.bukkit -DartifactId=craftbukkit -Dversion=1.8-R0.1-SNAPSHOT -Dpackaging=jar`
Beta 5 Changes Beta 5 Changes
=== ===
*Changes since Beta 4* *Changes since Beta 4*
* Added a command to update, verify, refresh, and clean signs on cells. [#79](https://github.com/graywolf336/Jail/issues/79) * Added a command to update, verify, refresh, and clean signs on cells. [#79](https://github.com/graywolf336/Jail/issues/79)
* Added an api to get the build number, this way we can reference it in the future. * Added an api to get the build number, this way we can reference it in the future.
* Added a password requirement on the broadcast of jailing, defaults to everyone. [#54](https://github.com/graywolf336/Jail/issues/54) * Added a password requirement on the broadcast of jailing, defaults to everyone. [#54](https://github.com/graywolf336/Jail/issues/54)
* Added the ability to show `reason`, `jail`, and `cell` to the broadcast messages. [#53](https://github.com/graywolf336/Jail/issues/53) * Added the ability to show `reason`, `jail`, and `cell` to the broadcast messages. [#53](https://github.com/graywolf336/Jail/issues/53)
* Added tab complete to all the commands. [#77](https://github.com/graywolf336/Jail/issues/77) * Added tab complete to all the commands. [#77](https://github.com/graywolf336/Jail/issues/77)
* Changed cell names to be semi-sorted alphabetically. [#80](https://github.com/graywolf336/Jail/issues/80) * Changed cell names to be semi-sorted alphabetically. [#80](https://github.com/graywolf336/Jail/issues/80)
* Changed how we handle inventory when storing is set to false. Don't remove their inventory when they are unjailed and we don't store it. [#57](https://github.com/graywolf336/Jail/issues/57) * Changed how we handle inventory when storing is set to false. Don't remove their inventory when they are unjailed and we don't store it. [#57](https://github.com/graywolf336/Jail/issues/57)
* Changed offline players jailing, don't allow jailing players unless they've played before (can be overwrote with -f). [#82](https://github.com/graywolf336/Jail/issues/82) * Changed offline players jailing, don't allow jailing players unless they've played before (can be overwrote with -f). [#82](https://github.com/graywolf336/Jail/issues/82)
* Changed the jail api, see [#72's comment](https://github.com/graywolf336/Jail/issues/72#issuecomment-104757472) for some details. * Changed the jail api, see [#72's comment](https://github.com/graywolf336/Jail/issues/72#issuecomment-104757472) for some details.
* Changed jailing items, we run all jailing sync so that any api usage async won't cause problems. [#73](https://github.com/graywolf336/Jail/issues/73) * Changed jailing items, we run all jailing sync so that any api usage async won't cause problems. [#73](https://github.com/graywolf336/Jail/issues/73)
* Changed the format of the jail check command, thanks to stevoh6. [#65](https://github.com/graywolf336/Jail/pull/65) * Changed the format of the jail check command, thanks to stevoh6. [#65](https://github.com/graywolf336/Jail/pull/65)
* Changed the explanation of why the gamemode setting was problematic and give the available options. [#73](https://github.com/graywolf336/Jail/issues/73) * Changed the explanation of why the gamemode setting was problematic and give the available options. [#73](https://github.com/graywolf336/Jail/issues/73)
* Changed pretty time to be the default of the signs. * Changed pretty time to be the default of the signs.
* Fixed a sqlite issue which was preventing plugin from launching. [#78](https://github.com/graywolf336/Jail/issues/78) * Fixed a sqlite issue which was preventing plugin from launching. [#78](https://github.com/graywolf336/Jail/issues/78)
* Fixed an issue where cell data was being duplicated (or more) in the database. [#74](https://github.com/graywolf336/Jail/issues/74) * Fixed an issue where cell data was being duplicated (or more) in the database. [#74](https://github.com/graywolf336/Jail/issues/74)
* Fixed an on load issue when the config didn't have four lines for the signs. [#61](https://github.com/graywolf336/Jail/issues/61) * Fixed an on load issue when the config didn't have four lines for the signs. [#61](https://github.com/graywolf336/Jail/issues/61)
* Fixed cell signs not updating when an offline player is jailed. [#68](https://github.com/graywolf336/Jail/issues/68) * Fixed cell signs not updating when an offline player is jailed. [#68](https://github.com/graywolf336/Jail/issues/68)
* Fixed chests being selectable if trapped and regular were next to each other. * Fixed chests being selectable if trapped and regular were next to each other.
* Fixed inventory not being stored in chests, trapped chests and chests work just fine now. * Fixed inventory not being stored in chests, trapped chests and chests work just fine now.
* Fixed jail names being case sensitive. [#76](https://github.com/graywolf336/Jail/issues/76) * Fixed jail names being case sensitive. [#76](https://github.com/graywolf336/Jail/issues/76)
* Fixed jail sticks not putting players into cells. [#68](https://github.com/graywolf336/Jail/issues/68) * Fixed jail sticks not putting players into cells. [#68](https://github.com/graywolf336/Jail/issues/68)
* Fixed pretty time not working with jailed forever time. * Fixed pretty time not working with jailed forever time.
* Fixed respawning after dying not placing players back into their cells when another plugin sets their respawn point. [#55](https://github.com/graywolf336/Jail/issues/55) * Fixed respawning after dying not placing players back into their cells when another plugin sets their respawn point. [#55](https://github.com/graywolf336/Jail/issues/55)
* Fixed time being added/subtracted from a player's time when they were jailed forever, resulting in them being able to get out. [#69](https://github.com/graywolf336/Jail/issues/69) * Fixed time being added/subtracted from a player's time when they were jailed forever, resulting in them being able to get out. [#69](https://github.com/graywolf336/Jail/issues/69)
* Fixed transferring players who've never been on before not working. [#83](https://github.com/graywolf336/Jail/issues/83) * Fixed transferring players who've never been on before not working. [#83](https://github.com/graywolf336/Jail/issues/83)
* Fixed signs disappearing after reloading the plugin. [#67](https://github.com/graywolf336/Jail/issues/67) * Fixed signs disappearing after reloading the plugin. [#67](https://github.com/graywolf336/Jail/issues/67)
* Fixed signs not updating after transferring someone. * Fixed signs not updating after transferring someone.
* Fixed storage not changing when reloading the plugin, allows converting from one type to another. [#75](https://github.com/graywolf336/Jail/issues/75) * Fixed storage not changing when reloading the plugin, allows converting from one type to another. [#75](https://github.com/graywolf336/Jail/issues/75)
* Fixed subcommands of `/jail` being case sensitive.
[Beta 4](https://github.com/graywolf336/Jail/releases/tag/v3.0.0-beta.4) Changes
=== [Beta 4](https://github.com/graywolf336/Jail/releases/tag/v3.0.0-beta.4) Changes
*Changes since Beta 3* ===
* Added `/jail vote`. [Jail Vote Wiki Page](https://github.com/graywolf336/Jail/wiki/Jail-Vote). [#8](https://github.com/graywolf336/Jail/issues/8) *Changes since Beta 3*
* Added support for `%prettytime%` on signs, formats the time with `1h4m20s`. [#35](https://github.com/graywolf336/Jail/issues/35) * Added `/jail vote`. [Jail Vote Wiki Page](https://github.com/graywolf336/Jail/wiki/Jail-Vote). [#8](https://github.com/graywolf336/Jail/issues/8)
* Added temporary help command, see the wiki for *wip* information: https://github.com/graywolf336/Jail/wiki/ * Added support for `%prettytime%` on signs, formats the time with `1h4m20s`. [#35](https://github.com/graywolf336/Jail/issues/35)
* Added the ability to set a prisoner's time with `/jail time set [player] [amount]` * Added temporary help command, see the wiki for *wip* information: https://github.com/graywolf336/Jail/wiki/
* Fixed updating signs throwing an error on Spigot. [#36](https://github.com/graywolf336/Jail/issues/36) * Added the ability to set a prisoner's time with `/jail time set [player] [amount]`
* Fixed incorrect permissions for `/jail listcells`. [#39](https://github.com/graywolf336/Jail/issues/39) * Fixed updating signs throwing an error on Spigot. [#36](https://github.com/graywolf336/Jail/issues/36)
* Fixed some permissions not being included in `jail.command.*`. [#38](https://github.com/graywolf336/Jail/issues/38) * Fixed incorrect permissions for `/jail listcells`. [#39](https://github.com/graywolf336/Jail/issues/39)
* Fixed teleport free not sending the prisoner to the correct world. * Fixed some permissions not being included in `jail.command.*`. [#38](https://github.com/graywolf336/Jail/issues/38)
* Fixed jailed players not being able to destory and place whitelisted blocks. [#34](https://github.com/graywolf336/Jail/issues/34) * Fixed teleport free not sending the prisoner to the correct world.
* Fixed the plugin being loaded before the worlds, if using Multiverse-Core. [#41](https://github.com/graywolf336/Jail/issues/41) * Fixed jailed players not being able to destory and place whitelisted blocks. [#34](https://github.com/graywolf336/Jail/issues/34)
* Fixed automatically jailing to open cells missing. [#42](https://github.com/graywolf336/Jail/issues/42) * Fixed the plugin being loaded before the worlds, if using Multiverse-Core. [#41](https://github.com/graywolf336/Jail/issues/41)
* Fixed capital letters being ignore when creating cells. [#47](https://github.com/graywolf336/Jail/issues/47) * Fixed automatically jailing to open cells missing. [#42](https://github.com/graywolf336/Jail/issues/42)
* Fixed some cells not being created when a chest wasn't defined. [#46](https://github.com/graywolf336/Jail/issues/46) * Fixed capital letters being ignore when creating cells. [#47](https://github.com/graywolf336/Jail/issues/47)
* Fixed not being able to jail someone for an infinite amount of time. [#49](https://github.com/graywolf336/Jail/issues/49) * Fixed some cells not being created when a chest wasn't defined. [#46](https://github.com/graywolf336/Jail/issues/46)
* Fixed not being able to jail someone for an infinite amount of time. [#49](https://github.com/graywolf336/Jail/issues/49)
[Beta 3](https://github.com/graywolf336/Jail/releases/tag/v3.0.0-beta.3) Changes
=== [Beta 3](https://github.com/graywolf336/Jail/releases/tag/v3.0.0-beta.3) Changes
*Changes since Beta 2* ===
* Added support for sqlite storage *Changes since Beta 2*
* Add advanced update notifications, even for beta builds * Added support for sqlite storage
* Move cellcreate command to createcell * Add advanced update notifications, even for beta builds
* Fix an out of bounds exception when using old jail stick configurations * Move cellcreate command to createcell
* Make the timer async, this helps performance when you have a ton of prisoners * Fix an out of bounds exception when using old jail stick configurations
* Lots of work on unit testing * Make the timer async, this helps performance when you have a ton of prisoners
* Changed the encoding of the project in maven to utf8 * Lots of work on unit testing
* Fixed the language system not copying over new values * Changed the encoding of the project in maven to utf8
* Fixed confirmations not expiring, ever * Fixed the language system not copying over new values
* Commands clear and clear force have been combined, use -f (-force) if you want to forcefully clear * Fixed confirmations not expiring, ever
* Commands clear and clear force have been combined, use -f (-force) if you want to forcefully clear
[Beta 2](https://github.com/graywolf336/Jail/releases/tag/v3.0.0-beta.2) Changes
=== [Beta 2](https://github.com/graywolf336/Jail/releases/tag/v3.0.0-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 *Changes since Beta 1*
* Jailings via jail sticks are now recorded, [#20](https://github.com/graywolf336/Jail/issues/20) * Using UUID as the only means of knowing if someone is jailed or not, last known username is stored for commands
* Fix the default Jail Stick not being loaded correctly, [#21](https://github.com/graywolf336/Jail/issues/21) * Jailings via jail sticks are now recorded, [#20](https://github.com/graywolf336/Jail/issues/20)
* Implement Scoreboards, with title and time configurable. ([#15](https://github.com/graywolf336/Jail/issues/15)) * Fix the default Jail Stick not being loaded correctly, [#21](https://github.com/graywolf336/Jail/issues/21)
* Implemented Jail Pay [#11](https://github.com/graywolf336/Jail/issues/11) * Implement Scoreboards, with title and time configurable. ([#15](https://github.com/graywolf336/Jail/issues/15))
* Convert old data and config values, only some are done and if you don't want the old data delete your `global.yml` * Implemented Jail Pay [#11](https://github.com/graywolf336/Jail/issues/11)
* Add config option to disallow the usage of Jail Sticks * Convert old data and config values, only some are done and if you don't want the old data delete your `global.yml`
* Added `/jail time` for easy access to adding/subtracting time - [Bukkit Dev Ticket #432](http://dev.bukkit.org/bukkit-plugins/jail/tickets/432/) * Add config option to disallow the usage of Jail Sticks
* Added `/togglejaildebug` for easily toggling the debugging state, enable if you have a problem and want to send me information * Added `/jail time` for easy access to adding/subtracting time - [Bukkit Dev Ticket #432](http://dev.bukkit.org/bukkit-plugins/jail/tickets/432/)
* Added some caching of online prisoners and where they're located at, this improves performance on servers with 500+ prisoners jailed * Added `/togglejaildebug` for easily toggling the debugging state, enable if you have a problem and want to send me information
* Only updating prisoners in the database if they were changed, this should help improve saving speed * 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](https://github.com/graywolf336/Jail/releases/tag/v3.0.0-beta.1) Changes
=== [Beta 1](https://github.com/graywolf336/Jail/releases/tag/v3.0.0-beta.1) Changes
*Changes since alpha* ===
* MySQL storage is now a valid option for storage ([#18](https://github.com/graywolf336/Jail/issues/18)) *Changes since alpha*
* MySQL data validation, basically if a cell or prisoner reference a jail which no longer exists they are removed * MySQL storage is now a valid option for storage ([#18](https://github.com/graywolf336/Jail/issues/18))
* 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)) * MySQL data validation, basically if a cell or prisoner reference a jail which no longer exists they are removed
* Add the record keeping system ([#12](https://github.com/graywolf336/Jail/issues/12)) * 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))
* Added Jail Sticks, format of them has slightly changed ([#16](https://github.com/graywolf336/Jail/issues/16)) * 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))
To Do
=== To Do
* Jail set ===
* Jailing for swearing * Jail set
* Guards (PlayerMoveProtectionAction - when they try to move do we teleport them back, let the guards get them, or nothing) * Jailing for swearing
* Storing permissions * Guards (PlayerMoveProtectionAction - when they try to move do we teleport them back, let the guards get them, or nothing)
* Pages on jail list * Storing permissions
* Pages on jail list