Files
spigot-quest-board/README.md
T
dmg 638d2328ab
Release / release (push) Successful in 2m17s
CI / build (push) Successful in 1m4s
feat(quests): add quest creation and reward escrow
2026-09-04 23:45:00 -04:00

49 lines
1.5 KiB
Markdown

# 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
Administrators can register persistent shared quest boards by targeting a block within five blocks and running `/questadmin createboard`. Right-clicking any registered board opens a native dialog where a player can request a block and quantity while escrowing the exact reward stack held in their main hand. Delivery and claims remain under development.
## 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.