GUI System

Last updated Oct 28, 2026

GUI System

SoapsQuest inventory menus are configured in gui.yml. Disable all GUIs with config.yml → gui.enabled: false.

Layouts use MiniMessage or legacy & color codes. gui.yml is shared by Free and Premium (see Default Config Files).


Quest browser

Command: /sq browse or /sq gui
Permission: soapsquest.gui.browser

Players browse available quests and click to receive a paper. Filters (tier, difficulty, type, origin, search) are built into the browser for staff testing; layout slots are in gui.yml under quest-browser:.

Common layout keys under quest-browser:: title, size, layout.quest-slots, page buttons, close-button, optional editor-button, and Premium contract-button.

Premium adds a Get a Contract button that opens the contract board.


Active quests

Command: /sq active (aliases: /sq myquests, /sq quests)
Permission: soapsquest.gui.myquests

Shows in-progress quest papers from the player's inventory. Layout is built in code (54-slot inventory with a close button); it is not driven by a gui.yml section.


Contract board (Premium)

Opened from /sq contract, a contract NPC, or the browser button.

Premium file / section Role
contract-request.yml Costs, channels, brokers (Premium-only file)
gui.yml → contract-request: Board title, difficulty slots, confirm/cancel

Players pick a difficulty, see the fee, and confirm or cancel.

See Contract Request.


Quest editor (Premium)

Command: /sq editor [questid]
Permission: soapsquest.gui.editor

Sub-menus in gui.yml:

Section Purpose
quest-editor Quest list
quest-details Edit one quest
objective-editor Objectives
condition-editor Conditions
reward-editor Rewards
objective-type-selector Pick objective type
condition-type-selector Pick condition type
reward-type-selector Pick reward type

Editor reward types in the GUI registry: xp, money, item, command, quest. YAML-only rewards such as sigils and denizen are edited in quests.yml (or via /sq addreward … sigils on Premium).

Changes save to quests.yml immediately.


Chat alternatives

Command Purpose
/sq list Paginated quest list in chat
/sq claim <id> Claim from list without GUI
/sq progress All held papers with status and timer

Version 1.0.5

Still stuck? Ask about this page