Files
spigot-quest-board/README.md
T
dmg bf7f01a39e
CI / build (push) Successful in 1m54s
Release / release (push) Successful in 2m28s
chore(knowledge): move canonical docs to shared SoMC wiki
2026-09-09 23:18:25 -04:00

2.7 KiB

Spigot Quest Board

A Purpur 26.2 plugin for shared physical quest boards. Players can escrow rewards for requested items, deliver those items at any quest board, and claim delivered or returned items safely.

The approved behavior is specified in the SoMC OKF wiki.

Status

Administrators can register persistent shared quest boards by targeting a block within five blocks and running /questadmin createboard. They can instead run /questadmin createboard physical to generate a five-wide oak board above the targeted ground anchor, with glowing centered title and browsing-instruction signs above three decorative signs; its visible panel blocks and all five signs are registered. Right-clicking any registered board opens a compact native dashboard with dedicated browsing, creation, and claim screens. A player can request any inventory item material and quantity while escrowing the exact reward stack held in their main hand. Every board and /quests list show the same active quests with requested items, rewards, issuers, and time remaining; custom reward names are shown together with their material type. Players can complete quests at any board or with /quests complete <quest> by delivering the required items. Exact escrowed rewards are granted immediately, and delivered items are held for the issuer. Issuers can cancel their own active quests at any board or with /quests cancel <quest>. Completed deliveries and rewards from cancelled or seven-day-expired quests are held durably and can be collected at any board or with /quests claim; inventory overflow drops at the claimant's feet.

Requirements

  • Purpur 26.2 build 2618
  • Java 25 or newer

Build

./gradlew clean check jar

The plugin JAR is written to build/libs/.

Player commands

Player commands are disabled by default and can be enabled persistently by an administrator. When disabled, players within five blocks of a registered board can still use /quests create <item> <quantity> with material and quantity autocomplete; other player command forms remain disabled.

/quests
/quests list
/quests create ...
/quests complete <quest>
/quests cancel <quest>
/quests claim

Administration

The spigotquestboard.admin permission is granted to server operators by default.

/questadmin createboard
/questadmin createboard physical
/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.