feat(build): establish plugin foundation

2026-09-04 11:24:14 -04:00
parent e9de8e6034
commit 7e6beab9a4
13 changed files with 652 additions and 0 deletions
@@ -0,0 +1,34 @@
+# 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.
+
+## 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.