Introduction

SoapsFloor runs vertical dungeon sessions on your Paper server. Each room is a multi-floor challenge built from WorldEdit schematics.

Core concepts

Term	Meaning
Room	A saved dungeon with a starter area and one or more floors
Session	A live party inside one room
Floor	One schematic layer; mobs spawn, then the floor drops when cleared
Wand	Admin editor tool for creating and editing rooms
Weakness	Optional challenge modifier voted before the run; boosts rewards

What players do

1. Join a room with /sf room <id> or the GUI hub.
2. Wait in the starter room while a timer counts down.
3. Vote on a weakness (if enabled).
4. Survive the countdown, then clear mobs on each floor.
5. Reach the final floor to win. Stats and rewards are recorded.

What admins do

1. Place .schem files in plugins/SoapsFloor/schematics/.
2. Run /sf wand create <id> and define the starter box, entry/exit, and floors.
3. Tune mob counts, gaps, and player limits in the editor hotbar.
4. Assign reward tables with /sf setreward if you use rewards.yml.
5. Adjust global behavior in config.yml and reload with /sf reload.

Plugin files

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

Rooms are stored as YAML under rooms/. Schematics are never overwritten on update if they already exist.