Mod Authoring For Slay The Spire 2
RitsuLib is a Slay the Spire 2 mod framework that unifies content registration, runtime integration, persistence, settings, localization, and presentation helpers under one maintainable workflow.
It is registry-first, id-stable, and explicit by design: define what you own, keep data migrations predictable, and reuse lifecycle hooks instead of scattering ad-hoc compatibility patches.
What RitsuLib Provides
- Content: cards, relics, potions, characters, events, timelines, keywords, tags, and related registries
- Runtime: lifecycle subscriptions, patch helpers, settings UI, persistence stores, migrations, and secondary combat resources
- Presentation: FMOD helpers, top-bar buttons, toasts, hotkeys, shell themes, and runtime UI extensions
- Engineering: consistent terminology, modular boundaries, and diagnosable compatibility behavior
Start Here
Typical Use Cases
- Building a new Slay the Spire 2 mod from scratch with a complete technical baseline
- Refactoring an existing mod into a cleaner and more maintainable architecture
- Standardizing APIs and development flow for team-based mod projects
Feature Map
| Area | What you get | Entry |
|---|---|---|
| Start building | Add package, declare runtime dependency, create first content pack | /guide/getting-started |
| Register content | Cards, relics, potions, characters, events, epochs, keywords, tags, custom piles | /guide/content-authoring-toolkit |
| Keep state safely | Scoped JSON stores, migrations, profile switching support, settings bindings | /guide/persistence-guide |
| Build combat resources | Secondary resources, attached card costs, icon text helpers, and combat UI routing | /guide/secondary-resources |
| Work with the game | Lifecycle events, Harmony patch helpers, Godot script registration, compatibility notes | /guide/lifecycle-events |
| Add polish | FMOD helpers, top-bar buttons, card piles, toast messages, runtime hotkeys, shell themes | /guide/fmod-and-audio |