45 lines
1.5 KiB
Markdown
45 lines
1.5 KiB
Markdown
# Spigot Inventory Helper
|
||
|
||
A Purpur 26.2 plugin that sorts inventories with a craftable Sorting Stick and automatically replaces broken tools with equivalent tools from the player's inventory.
|
||
|
||
The approved behavior is specified in the [OKF design bundle](design/index.md).
|
||
|
||
## Requirements
|
||
|
||
- Purpur 26.2 build 2618
|
||
- Java 25 or newer
|
||
|
||
## Build
|
||
|
||
```bash
|
||
./gradlew clean check jar
|
||
```
|
||
|
||
The plugin JAR is written to `build/libs/`.
|
||
|
||
## Sorting Stick recipe
|
||
|
||
Place these ingredients vertically in the crafting grid's center column:
|
||
|
||
```text
|
||
Chest or Barrel
|
||
Redstone Dust
|
||
Stick
|
||
```
|
||
|
||
Either storage-block variant produces one Sorting Stick.
|
||
|
||
## Sorting inventories
|
||
|
||
Hold an authentic Sorting Stick and right-click:
|
||
|
||
- A chest or either half of a double chest to sort its complete inventory.
|
||
- A barrel to sort its inventory.
|
||
- Air or another block to sort player inventory slots 9–35.
|
||
|
||
Player hotbar, armor, and off-hand slots remain unchanged during player sorting. Compatible stacks are consolidated first, then items are ordered alphabetically by Minecraft material. Dissimilar metadata variants of the same material retain their relative order. Locked containers and interactions cancelled by protection plugins are not sorted.
|
||
|
||
## Releases
|
||
|
||
Gitea Actions checks pushes and pull requests and stores a development JAR. Pull requests validate conventional commits. Main-branch conventional commits drive semantic releases when the repository defines a `RELEASE_TOKEN` with contents-write permission.
|