Getting Started

Install SoapsCommon 2.0.1 and confirm the library (and Event Engine, if you leave it on) load.

Requirements

Requirement	Details
Plugins	None hard. Soft deps optional (Integrations).
Server	Paper / Spigot 26.1–26.3
Folia	Not supported
Java	21+ (Java 25 recommended)
Suite	Match SoapsCommon 2.0.x

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

Installation

1. Download SoapsCommon; extract the jar.
2. Put the jar in plugins/ and fully restart (not /reload).
3. Install suite plugins the same way when you use them.
4. Run /soaps if the engine is enabled (default).

Symptom	Fix
Red suite plugin, no data folder	JAR still inside a ZIP, or Common missing / wrong major
Common green, no Common folder	Normal for library-only until the engine creates data

First-run files

Library

No required plugins/SoapsCommon/config.yml. Suite menus live in each plugin folder, for example plugins/SoapsAdmin/gui/.

Event Engine (default on)

plugins/SoapsCommon/
  engine.yml
  pools.yml
  automations/
  events/
  running-state.yml

Full defaults: Config Reference

Admin path

1. /soaps — dashboard, Your events, Running, Pools
2. YAML — bulk edits under automations/ / events/ / pools.yml
3. /soaps reload — after file edits outside the GUI

Prefer the GUI day-to-day. Map: Event GUI.

Reload policy

Change	What to run
GUI edits to definitions	Apply on save (live runs keep their snapshot)
YAML file edits under Common	/soaps reload
engine.enabled / jar upgrade / first install	Full server restart
Consumer plugin YAML	That plugin’s reload command
Bukkit /reload	Do not use for jar changes

Verify

1. Console shows the SoapsCommon banner; suite plugins that depend on it enable after Common.
2. /soaps opens the dashboard (engine on).
3. Enable welcome_kit (or Create blank) → join fires the Do list.
4. With Vault installed, a money Do changes balance (Vault Setup).
5. With engine.enabled: false and a restart, suite menus still open; engine stays off.

Common goals

Goal	Page
Welcome kit	Want welcome kit
Daily login coins	Want daily login
Weekend pool	Want weekend pool
Money rewards	Want money rewards
Library only	Want library only

Next: Configuration · Upgrading to 2.0.1 · FAQ