Configuration

Last updated Nov 2, 2026

SoapsCommon has two stories: shared keys in consumer plugins (library), and engine.yml / pools / saved events when the Event Engine is on.

Shared keys (consumer plugins)

These paths appear in suite config.yml files. They are not inside SoapsCommon’s folder.

Key	Default	What it does
`settings.debug`	`false`	Extra debug logging
`gui.enabled`	`true`	Master switch for that plugin’s YAML menus
`integrations.soapsquest.enabled`	`false`	SoapsQuest hooks where that plugin supports them

Menu cosmetics: each plugin’s gui/_settings.yml. Defaults: Default _settings.yml · Guide: GUI System.

Created under plugins/SoapsCommon/ when the engine loads. Full file: Default engine.yml.

Key	Purpose
`engine.enabled`	Master switch; `false` = library only
`engine.debug`	Engine trace logging
`engine.max-running-events`	Cap on concurrent live instances
`engine.max-actions-per-second`	Safety budget for Do throughput
`engine.max-spawns-per-event`	Cap on mob spawns per run
`engine.max-recursion`	Cap on nested call depth
`engine.autosave-seconds`	How often running state is written
`engine.resume-on-restart`	Restore multi-step runs after reboot

Soft plugins are detected when present. No separate integrations block in this file.

Definitions live as separate files under events/ and automations/. Shape: Event Engine. Edit in the GUI or YAML; GUI saves write immediately.

Pools: Event Pools · Default pools.yml.

Canonical policy: Getting Started.