chore: scaffold Purpur plugin foundation

2026-09-04 23:23:47 -04:00
parent 97ad506ba7
commit 3b2ebbd0b5
13 changed files with 685 additions and 0 deletions
@@ -0,0 +1,48 @@
+# Spigot Quest Board
+
+A Purpur 26.2 plugin for shared physical quest boards. Players can escrow rewards for requested block items, deliver those blocks at any quest board, and claim delivered or returned items safely.
+
+The approved behavior is specified in the [OKF knowledge bundle](knowledge/index.md).
+
+## Status
+
+The project foundation and user stories are established. Quest-board behavior remains in the backlog until its stories are implemented and verified.
+
+## Requirements
+
+- Purpur 26.2 build 2618
+- Java 25 or newer
+
+## Build
+
+```bash
+./gradlew clean check jar
+```
+
+The plugin JAR is written to `build/libs/`.
+
+## Planned player commands
+
+Player commands are disabled by default and can be enabled by an administrator.
+
+```text
+/quests
+/quests list
+/quests create ...
+/quests complete <quest>
+/quests cancel <quest>
+/quests claim
+```
+
+## Planned administration
+
+The `spigotquestboard.admin` permission is granted to server operators by default.
+
+```text
+/questadmin createboard
+/questadmin commands <enable|disable>
+```
+
+## 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.