mirror of
https://github.com/JEFF-Media-GbR/ChestSort.git
synced 2024-12-12 04:17:44 +01:00
22 lines
1.7 KiB
Markdown
22 lines
1.7 KiB
Markdown
# ChestSort
|
|
1.8 to 1.16 compatible Minecraft-/Spigot-Plugin to allow automatic chest and inventory sorting.
|
|
|
|
## Download & more information
|
|
Please see the related topic at spigotmc.org for information regarding the commands, permissions and download links:
|
|
|
|
https://www.spigotmc.org/resources/1-13-chestsort.59773/
|
|
|
|
## Maven repository
|
|
If you want to use ChestSort as dependency for your own plugin, you can use our public maven repository. More information can be found in the [API documentation](https://github.com/JEFF-Media-GbR/Spigot-ChestSort/blob/master/HOW_TO_USE_API.md).
|
|
|
|
## Building .jar file
|
|
To build the .jar file, you will need maven. Also, the CrackShot library is in no public repository, so please create a directory called `lib` and put the latest CrackShot.jar file [(available here)](https://www.spigotmc.org/resources/crackshot-guns.48301/) inside it. Now you can do `mvn install`
|
|
|
|
## API
|
|
If you want to use ChestSort's advanced sorting features for your own plugin, you can use the ChestSort API. It provides methods to sort any given inventory, following the rules you have specified in your ChestSort's plugin.yml and the corresponding category files.
|
|
|
|
More information about the API can be found [HERE](https://github.com/JEFF-Media-GbR/Spigot-ChestSort/blob/master/HOW_TO_USE_API.md).
|
|
|
|
## Technical stuff
|
|
ChestSort takes an instance of org.bukkit.inventory.Inventory and copies the contents. The resulting array is sorted by rules defined in the config.yml. This takes far less than one millisecond for a whole chest. So there should be no problems even on big servers, where hundreds of players are using chests at the same time.
|
|
The plugin should cause no lag at all. |