Getting Started

Install SoapsFloor 1.2.4 and confirm it loads.

Requirements

Requirement	Details
Plugins (depend)	SoapsCommon
Soft (practical)	WorldEdit for schematic paste and room building
Server	Paper 26.1, 26.2, 26.3 · Spigot / Folia not supported
Java	21+ (Java 25 recommended)

Downloads are ZIPs. Extract the .jar into plugins/.

Installation

1. Download SoapsCommon and SoapsFloor; extract both jars.
2. Install WorldEdit (needed to paste schematics and build rooms).
3. Put jars in plugins/ and fully restart (not /reload).
4. Confirm SoapsFloor is green and plugins/SoapsFloor/ exists.
5. Optional: MythicMobs (custom mobs), Vault / SoapsAdmin / SoapsQuest (locked-floor currency), Essentials or CMI (run soft hooks). See Integrations.

Symptom	Fix
Red plugin, no data folder	JAR still inside a ZIP, or SoapsCommon missing
SoapsCommon green, Floor red	Check logs/latest.log for enable errors

First-run files

plugins/SoapsFloor/
  config.yml
  messages.yml
  gui.yml
  weaknesses.yml
  rewards.yml
  packs/
  schematics/
  rooms/
  data/

Bundled drop / climb packs and schematics extract when missing. Existing files are not overwritten.

Full defaults: Config Reference

Admin path

1. /sf wand create <id> — build a test room (Floor Editor + Room Settings)
2. /sf schematics — browse schematics, templates, and stair packs
3. YAML — timers, party scaling, join signs, weakness pools, reward tables
4. /sf reload — after YAML edits

Prefer the wand for rooms; YAML for global defaults and tables.

Reload policy

Change	What to run
Wand / room editor saves	Applied when you finish the room
YAML file edits	/sf reload
Jar upgrade / first install	Full server restart (not /reload)

Verify

Check	Passes when
Enable	Console shows SoapsFloor enabled; folder exists
Commands	/sf help, /sf list, /sf menu work
Loop	/sf join <room> → lobby → clear or climb → victory
Soft deps	WorldEdit paste works; optional currency hooks only if installed
Empty	/sf list with no rooms feels empty (not an error spam)

/sf help
/sf list
/sf menu
/sf wand create test

Common goals

Goal	Page
Drop tower	Want drop tower
Climb + flood	Want climb flood
Climb clear	Want climb clear
Locked floors	Want locked floors
Weakness voting	Want weakness voting
Victory rewards	Want victory rewards

Next: Room Creation Guide · Configuration · Upgrading to 1.2.4