Configuration

SoapsAdmin splits settings across domain-specific YAML files at the plugin root. config.yml holds bootstrap options only (storage, help visibility, integrations). Feature tuning lives in clearly named domain files.

File Map

File	Purpose
config.yml	Storage, help/tab visibility, soft integrations
staff.yml	Staff mode tools, vanish, spectator, inventory snapshots
teleport.yml	Warmups, homes, warps, TPA, spawn, death respawn
server.yml	Backups, worlds, broadcasts, announcements, tickets, spawnmob
player.yml	AFK, friends, nicknames, playtime, double doors, seek item
modules.yml	Module on/off toggles
economy.yml	Currencies, Vault bridge, mob drops, Mythic tables, spawner kill limits
chat.yml	Staff chat, filter, spam, slowmode, spy
moderation.yml	Freeze, warn escalation, QP templates, item blacklist
messages.yml	All player-facing text (MiniMessage)
customcommands.yml	Aliases, overrides, blocked vanilla commands
kits.yml	Kit definitions
prices.yml	Shop buy/sell catalog
recipes.yml	Custom recipes (vanilla + crucible: items)
rtp.yml	Random teleport settings
waypoints.yml	Waypoint limits and GUI
trade.yml	Player trade session settings
player-utilities.yml	Item filter, autopickup, privacy defaults
playervaults.yml	Extra player storage vaults
daily.yml	Daily reward economy and items
jails.yml	Jail rooms and jailed player data
rules.yml	Numbered server rules
joinmessages.yml	Join, leave, first-join messages
deathmessages.yml	Per-cause death message pools
clearlag.yml	Automatic item clearing schedule
mining-audit.yml	X-ray check thresholds
gui/_settings.yml	Master GUI toggle, filler, border, click sound
gui/*.yml	System menu cosmetics (Java panels + MERGED skins)
data/spawners.yml	Per-spawner Mythic/FX/budget overrides
data/mail/{uuid}.yml	Per-player offline mail

Reload Behavior

Command	Reloads
/sa reload	Full reload (config domains, messages, GUI, modules that need it)
/sa reload config	config.yml + staff.yml / teleport.yml / server.yml / player.yml + chat/moderation/clearlag/jails
/sa reload staff	staff.yml (+ staff tools)
/sa reload teleport	teleport.yml
/sa reload server	server.yml
/sa reload player	player.yml
/sa reload messages	messages.yml only
/sa reload gui	GUI menus and gui/_settings.yml
/sa reload all	Everything including custom commands
/sa reload shop	prices.yml only

Key bootstrap (config.yml)

Storage

storage:
  type: flatfile   # flatfile | sqlite | mysql

Use mysql for multi-server networks that share punishments and economy data.

Help Visibility

help:
  permissionFiltered: true

customCommands:
  permissionVisibility: true

When enabled, /sa help and tab completion only show commands the sender can run.

Staff (staff.yml)

staffmode.tools defines the hotbar loadout (slot, material, action). Actions include open_player_action, toggle_freeze, spectate, and toggle_vanish.

Inventory snapshots: auto-capture on death, clearinv, and optional quit. Risky vanilla commands like /clear and /kill can trigger snapshots when command-intercept is enabled.

Teleportation (teleport.yml)

teleportation:
  warmup-seconds: 3
  cooldown-seconds: 0
  cancel-on-move: true
  cancel-on-damage: true

Players with soapsadmin.teleport.bypass skip warmup and cooldown.

homes:
  default-max: 3
  max-name-length: 16

warps:
  per-warp-permission: false

death-settings:
  insta-respawn: false
  bed-respawn: true
  spawn-respawn: true
  rtp-respawn: false

Override home limits with soapsadmin.home.limit.<n> permissions.

GUI Master Toggle

Edit gui/_settings.yml (not config.yml):

enabled: true

When false, all SoapsAdmin GUIs are disabled.

Messages

All text uses MiniMessage format. Edit messages.yml for usage strings, success/error feedback, and help descriptions. The display prefix is general.prefix in messages.yml.

GUI Folder

SoapsAdmin uses a multi-file gui/ layout (unlike other Soaps plugins that ship a single gui.yml). See GUIs and Menus.

Data Folder

Runtime data is stored under plugins/SoapsAdmin/data/. Notable paths:

Path	Contents
spawners.yml	Mythic override, particles, sound, kill budget
mail/{uuid}.yml	Per-player offline mail
economy/	Spawner kill counters and related economy data

Do not edit punishment or balance files while the server is running.

Feature Guides

Topic	Doc
Mythic / Crucible soft deps	Integrations
Mob drops + shop	Economy and Shop
Spawner editor	Spawners
Recipes	Recipes
Item editor	Item-Editor
Mail / playerinfo	Mail and Player Info

Full Defaults

See Default Config Files for bundled file contents and GUI summaries.