Getting Started
Last updated Jul 6, 2026
Getting Started
Install
- Install Paper 1.21+ and SoapsCommon 1.3.0+.
- Drop
SoapsFloor-1.0.5.jarintoplugins/. - Install WorldEdit (required for room building) and MythicMobs (optional).
- Start the server once. SoapsFloor creates its data folder and default configs.
- Run
/sf reloadafter 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 | Join with /sf room test or /sf menu |
Verify the plugin works
/sf help
/sf room list
/sf menu
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.
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.