SoapsUniverse

Event GUI

Last updated Oct 9, 2026

Event GUI

Each definition has three parts:

  1. When (what starts it)
  2. Only if (optional rules)
  3. Do (actions), or Steps for longer events

On the edit screen: Start, Test, and More (cooldown, stop, copy, delete).

Engine panels use the same chrome as SoapsAdmin: black border panes, then gray filler on empty slots.

Opening

Staff: /soaps
Players: /soaps me

/soaps dashboard
├── Your events      (create, edit, enable, start)
├── Running now      (extend, stop, cleanup)
├── Pools            (create, pick mode, auto When, start)
└── Player view      (joinable events / mute)

First-time checklist

  1. Open Your events (showcase examples are already seeded, disabled) or create a blank quick / blank multi-step.
  2. Fix locations and optional world filters. Stand at the spot and type here in chat prompts (reach, deliver, teleport, join_prompt, world Only-if).
  3. Enable the definition (name dye at the top).
  4. Use Test, then Start when When is manual. Schedule / join / kill automations only need Enable.

Pools: Create pool → add events → choose pick mode (weight / chance / list) → optional auto-start When → enable listed events → enable the pool.

Your events

Control Action
Click Open the editor
Shift-left If running: stop. Staff-start (when: manual): enable and start. Otherwise: enable or disable.
Shift-right Enable or disable only
Filter All / Enabled / Disabled / Automations / Events / Running / Invalid
Create Blank automation or blank multi-step event
Search Find by name

Automations / Events filters use Kind (type: automation vs type: event), not whether When is manual. Staff-start shows in lore as Event (staff start). See FAQ.

Edit event

Control What it does
Name (top) Click enable/disable. Shift-click rename. Right-click description.
When Opens the When screen (current trigger). Change trigger opens the catalog
Only if Root rules list
Do / Steps Action list, or the steps board
Start Enable if needed and start now (staff ignores cooldown)
Test Dry run
More Cooldown, max running, stop, copy, convert, delete

Status lore shows up to two validation problems and a tip when a location is blank or still looks like a placeholder. Prefer typing here while standing at the spot.

Steps editor

Steps show in list order (left to right). Shift-left moves a step earlier, shift-right moves it later, and Drop deletes it. Open a step to edit duration, Only if, Do, goal, and next. Use Move earlier / Move later, or Shift-click the step title to mark which step starts the event. Failed Only if skips Do and goal for that entry. Time-based next can still apply.

Next opens a rule editor (no presets): pick goal_done / goal_fail / after_time / then, then a destination step id. Patterns live in the example events.

When screen

Click When on the edit screen to open the summary (not the catalog first):

Control Action
Current trigger Shows the live When. Click opens the settings editor. Right-click opens the catalog.
Change trigger / Set trigger Opens the catalog. The current type glows with a ★.
Staff start Sets When to manual (menu / command start only).
Back Returns to the event editor

Settings editor

Click a When / Only-if / Do / Goal row to edit its settings. The list shows set values plus useful suggestions for that type, not every optional meta on every row.

Control Action
Setting row Click to edit in chat. Shift-left toggles booleans or adds a suggestion. Shift-right clears.
Add common Menu of optional meta: world (When), fail_message / fail_cancel (Only-if), target / chance / delay / cooldown (Do), scope (Goal). Click to add.
Browse settings Full catalog for this type. Click to add / toggle / edit. Rare keys: Type a custom name.
Durations Bare number = ticks (20/s). Or 3s / 2m / 1h.

Nested Do on pulse / around_players / around_mobs / to_victim / to_attacker opens the same Do list editor. Only-if On fail Do is editable the same way. Comma-separated lists (items, words, lore) edit in chat.

Pickers

  • Filter: one cycle button (All → Player → Item → World → Entity → Region → Control). Click next, right-click previous, Shift-click All.
  • Soft-dep types show unavailable until the plugin is installed
  • Use world_effect_begin + world_rule_* for world rules
  • Shift-click item types while holding an item to fill matcher fields
  • Nested any / all / not Only if groups are edited in YAML

Test vs Start

Test Start
Enabled required? No Yes
Validation Soft Blocks start if invalid
Rewards / money Skipped when possible Live
Cooldown Ignored Staff Start / CLI start ignore definition cooldown

Start fails with the first Only if rule that did not pass.

Stop and cleanup

Path Default Cleanup
List Shift-left (running) Stop No
More → Stop Click = no cleanup Shift = run cleanup Dos
Running now Right-click = no cleanup Shift-right = run cleanup
/soaps events stop <id> No cleanup Add --cleanup

Locations

Use world;x;y;z, or type here / stand here while standing on the block.

See also