guide

Static Switching System Documentation

Public documentation for declarative OpenMW world patching with YAML.

Static Switching System (SSS) is a declarative world-patching framework for OpenMW. It replaces static meshes or matches active objects and applies object, inventory, actor, world-state, and scripting actions from YAML.

SSS has two module types: static and instance. Pick one. They are separate pipelines and do not compose. Start with Getting Started, then use Concepts for dispatch, ordering, ranges, and persistence.

Documentation map

  • Getting Started — install SSS, place modules where the VFS can discover them, and make a first change.
  • Concepts — the two pipelines, matching and priority, persistence, edge cases, and diagnostics.
  • API Reference — the YAML format, schema, settings, lifecycle, and the advanced StaticSwitcher_G interface.
  • Recipes — copyable patterns built from the shipped examples, plus lessons from released static modules.
  • Experiments and Oddities — executable documentation for combinations that are useful, cursed, or both.
  • Compatibility and Troubleshooting — VFS, optional dependencies, save updates, and runtime diagnosis.

The shipped YAML examples are source fixtures. They document real module shapes and are intended to be copied or adapted into the discovered VFS data directory; the examples directory itself is not scanned as a module directory.