Getting Started

Install

1. Install Paper 26.2, Java 21+, and SoapsCommon. Spigot and Folia are not supported.
2. Drop SoapsFloor-1.0.7.jar into plugins/.
3. Install WorldEdit (needed for schematic paste and room building) and MythicMobs (optional).
4. Optional for locked-floor currency: Vault, SoapsAdmin (economies), and/or SoapsQuest (sigils).
5. Start the server once. SoapsFloor creates its data folder and default configs.
6. Run /sf reload after any config edit.

First-run checklist

Step	Action
1	Confirm SoapsCommon loaded before SoapsFloor
2	Check plugins/SoapsFloor/schematics/ for bundled ROOM and STARTER_ROOM templates
3	Grant staff soapsfloor.admin or specific wand permissions
4	Grant players soapsfloor.player (default: true for all players)
5	Create a test room with /sf wand create test
6	Use Floor Editor (comparator) for Access, Mobs, Countdown, and Commands
7	Open Room Settings (nether star) for PvP, auto-start, party scaling, join-in-progress, countdown, min/max
8	Optionally enable Falling Hazard (magma cream)
9	Finish with /sf wand finish or /sf wand leave
10	Join with /sf join test, /sf quickjoin, clickable /sf list, join signs, or /sf menu

Verify the plugin works

/sf help
/sf list
/sf menu

Join signs

Default sign layout (editable under join-signs in config.yml):

(empty)
[SF]
<room_id>
(empty)

Creating a join sign requires soapsfloor.admin.sign. Breaking one requires soapsfloor.admin.sign.break. Right-click to join (soapsfloor.player.room.join).

Console can run:

/sf reload
/sf help

Default bundled schematics

On first run, SoapsFloor extracts:

File	Use
ROOM.schem	Floor template
STARTER_ROOM.schem	Lobby reference layout

Existing files in schematics/ are not overwritten.

Locked floors

See Locked Floors for lobby buy-in, currency sources, and YAML.

Minimum staff permissions

Permission	Purpose
soapsfloor.admin.wand.create	Create rooms
soapsfloor.admin.wand.edit	Edit rooms
soapsfloor.admin.reload	Reload configs

Use soapsfloor.admin for full staff access.

Player access

soapsfloor.player is default: true. Players can join rooms, open the menu, and view stats without extra setup.

GUI vs commands

Set gui.enabled: false in config.yml to disable inventory menus. All features remain available through /sf commands.