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.

Full shipped defaults: Config Reference (one page per file). Do not edit jar resources; edit copies under plugins/SoapsAdmin/. Jar updates do not overwrite live YAML.

File Map

Shipped under src/main/resources (copied on first run when missing):

File	Purpose
config.yml	Storage, help/tab visibility, soft integrations
modules.yml	Module on/off toggles (each key lists its config file)
staff.yml	Staff mode tools, vanish, spectator, inventory snapshots
teleport.yml	Warmups, homes, warps, TPA, spawn, death respawn, claims
rtp.yml	Random teleport settings
waypoints.yml	Waypoint limits, tracking, display labels
server.yml	Backups, worlds, broadcasts, announcements, tickets, spawnmob
player.yml	AFK, friends, nicknames, playtime, double doors, seek item
player-utilities.yml	Item filter, autopickup, autosell, privacy defaults
economy.yml	Currencies, Vault bridge, mob drops, Mythic tables, spawner kill limits
prices.yml	Shop buy/sell catalog
daily.yml	Daily reward economy and items
chat.yml	Staff chat, filter, spam, slowmode, spy, PM sound
moderation.yml	Freeze, warn escalation, QP templates, reports, item blacklist
jails.yml	Jail radius, allowed commands, rooms, jailed players
messages.yml	All player-facing text (MiniMessage)
customcommands.yml	Aliases, overrides, blocked vanilla commands
kits.yml	Kit definitions
recipes.yml	Custom recipes (vanilla + crucible: items)
trade.yml	Player trade session settings
playervaults.yml	Extra player storage vaults
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
plugin.yml	Plugin metadata / permissions (jar; not a live edit target)
gui.yml	GUI look, actions, master toggle, filler/border/sound (/sa guiconfig)

Runtime / data paths (created by the plugin; not all are jar resources):

Path	Contents
data/server/spawns.yml	Server spawn / first-join spawn
data/server/spawners.yml	Per-spawner Mythic/FX/budget (legacy data/spawners.yml migrates)
data/social/mail/{uuid}.yml	Per-player offline mail (legacy data/mail/ migrates)
data/storage/vaults/{uuid}.yml	Player vault contents
worlds.yml	World manager metadata (generator: VOID, etc.)
interactive.yml	Block → custom-command binds (created on first bind)

Reload Behavior

Command	Reloads
/sa reload	Full reload (config domains, messages, GUI, modules that need it)
/sa reload all	Same as full reload including custom commands
/sa reload config	config.yml + staff.yml / teleport.yml / server.yml / player.yml / chat.yml / moderation.yml / clearlag.yml / jails.yml (+ kits/staff tools side effects)
/sa reload staff / stafftools	staff.yml
/sa reload teleport	teleport.yml
/sa reload server	server.yml
/sa reload player	player.yml
/sa reload messages	messages.yml
/sa reload gui	GUI file (gui.yml; same as /sa guiconfig reload)
/sa reload shop / prices	prices.yml
/sa reload economy	economy.yml (+ drop manager)
/sa reload daily	daily.yml
/sa reload rtp	rtp.yml
/sa reload waypoints	waypoints.yml
/sa reload recipes	recipes.yml
/sa reload kits	kits.yml
/sa reload customcommands	customcommands.yml
/sa reload modules	modules.yml
/sa reload module <name>	One feature module
/sa reload playervaults / vaults / vault	playervaults.yml
/sa reload player-utilities	player-utilities.yml
/sa reload trade	trade.yml
/sa reload moderation	moderation.yml
/sa reload jails / jail	jails.yml
/sa reload clearlag	clearlag.yml
/sa reload mining-audit	mining-audit.yml
/sa reload joinmessages	joinmessages.yml
/sa reload deathmessages	deathmessages.yml
/sa reload rules	rules.yml
/sa reload motd	MOTD section of server.yml
/sa reload worlds	worlds.yml

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. See Teleportation for claims / RTP / waypoints key tables.

GUI Master Toggle

Edit gui.yml → settings (one switch):

settings:
  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 Skins

Customize panels in gui.yml with /sa guiconfig. See GUIs and Menus.

Data Folder

Runtime data is stored under plugins/SoapsAdmin/data/ (and root worlds.yml / interactive.yml). Notable paths are listed in the file map above.

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

Feature Guides

Topic	Doc
Module toggles + config map	Modules
Mythic / Crucible / Arena / Floor	Integrations · Mythic Setup
Mob drops + shop	Economy and Shop
Spawner editor	Spawners
Recipes	Recipes
Item editor	Item-Editor
Mail / playerinfo	Mail and Player Info

Full Defaults

See Config Reference. Start with Default config.yml · Default modules.yml · Default messages.yml.

Reload policy: Getting Started.