RITSULIB

Slay the Spire 2 mod framework — registries, lifecycle, patches & tooling

Slay the Spire 2

Overview

A shared mod framework for Slay the Spire 2: registry-driven content, Harmony patching helpers, persistence stores, lifecycle events, localization (`I18N` / keywords), Godot scene registration, FMOD helpers, and diagnostics that align with vanilla progression checks.

  • Content & registries

    Fixed identity, content packs, character/unlock scaffolding, custom events, timelines, and placeholder content rules.

  • Patching & lifecycle

    `ModPatcher`, `IPatchMethod`, grouped targets, plus lifecycle subscriptions and replay semantics for engine events.

  • Persistence & settings

    Scoped mod data stores with migrations and profile switching; optional settings UI bound to `ModDataStore`.

  • Localization & audio

    `I18N`, keyword registry, LocString tooling, and FMOD Studio path → GUID mapping helpers on top of the vanilla audio pipeline.

  • Godot & diagnostics

    Scene script registration, asset profile fallbacks, narrow compatibility patches, and one-time diagnostic warnings.

  • Documentation

    Guides are maintained as Markdown under `docs/pages/guide/` in this repository and built with Valaxy.