Configuration
Last updated Jul 6, 2026
Configuration
SoapsCommon does not ship its own config.yml. Instead, suite plugins share a small set of canonical config keys. When you see these paths in SoapsAdmin, SoapsQuest, or another plugin, they follow the same rules.
Shared keys
| Key | Default | What it does |
|---|---|---|
settings.debug |
false |
Extra debug logging when enabled |
gui.enabled |
true |
Master switch for YAML inventory menus in that plugin |
integrations.soapsquest.enabled |
false |
Lets a plugin run SoapsQuest hooks (used where that integration exists) |
These keys live in each consumer plugin's config.yml, not in a SoapsCommon folder.
settings.debug
settings:
debug: false
When true, suite plugins that use the shared debug helper write more detail to the console. Leave this off on a live server unless you are tracking down a problem.
gui.enabled
gui:
enabled: true
When false, plugins that respect this key will not open their YAML menus. Commands that only use chat still work. This is useful if you want to disable GUIs without removing the plugin.
integrations.soapsquest.enabled
integrations:
soapsquest:
enabled: false
Some plugins (for example SoapsArena) can run console commands through SoapsQuest when a match ends. This toggle is off by default. Turn it on only if you use SoapsQuest and have configured the integration block in that plugin's config.
GUI folder settings
Global menu cosmetics for plugins that use a gui/ folder are controlled by gui/_settings.yml in that plugin's data folder. See Default Config Files for defaults.
Per-menu options (title, size, open-permission, items) are in each menu YAML file. See GUI System.