RitsuLib
A shared framework library for Slay the Spire 2 mods, with a large set of QoL and tooling components for both mod authors and regular players.
RitsuLib itself does not add cards, relics, enemies, or balance changes. It provides runtime framework support, compatibility helpers, and several player-facing management tools.
- In-game mod settings hub: organized RitsuLib settings pages, interface themes, a main-menu settings shortcut, and an overview of registered hotkeys.
- Content source hover tips: shows which mod provided cards, relics, potions, powers, orbs, events, keywords, creatures, and other content.
- Content mod load-order tools: preview relevant content/dependency mods, apply deterministic sorting, copy the current order, or restore an order from the clipboard.
- Steam Workshop management: search Workshop items by ID, link, or text from inside the game; inspect subscriptions; open item pages; subscribe or unsubscribe; and check update states.
- Update checks: optional RitsuLib and Workshop update checks, manual check buttons, main-menu notifications, and a setting to defer automatic checks while in combat rooms.
- Steam Cloud sync for mod data: optional cloud sync for registered mod data, with manual upload, download, and cloud-clear actions.
- Multiplayer diagnostics: clearer join-failure and state-divergence reports, copyable diagnostics, missing Workshop item hints, mod-order guidance, and direct log-folder access.
- Debug log viewer: browser-based live godot.log viewer with search/filter tools and optional auto-open. Default console command: openlogviewer.
- Content registration: models, keywords, custom card piles, top-bar buttons, timelines, unlocks, rewards, target types, secondary resources, and visual scaffolding.
- Runtime integration: lifecycle events, Harmony patch helpers, IL rewrite tools, runtime hotkeys, synced right-click actions, and compatibility gates across supported game API branches.
- Data and UI: JSON persistence, run-saved data, migrations, Steam Cloud integration, mod settings pages, localization helpers, and runtime interop schemas.
- Presentation and diagnostics: FMOD/audio helpers, toast UI, shell themes, card/relic/potion PNG export, Harmony patch dumps, self-check bundles, startup audits, and diagnostic reports.
RitsuLib aims to maintain compatibility with other mods and framework libraries, so it should normally work with most mods.
BaseLib compatibility is prioritized. However, compatibility issues caused by implementation problems in downstream mods are not guaranteed to be covered.
Search GitHub for BAKAOLC/STS2-RitsuLib.
Please attach godot.log when reporting crashes, load failures, multiplayer join issues, or unexpected behavior.
Without logs, it is usually not possible to reliably determine which mod caused the problem. The issue you see may have been caused by another mod and only exposed indirectly through RitsuLib.
How to find the log
- In game: press ~, `, *, ‘, Shift+8 to open the console, then type open logs to open the log folder.
- Windows: open %appdata%SlayTheSpire2logs and attach godot.log.
- Linux: open ~/.local/share/SlayTheSpire2/logs and attach godot.log.
- macOS: open ~/Library/Application Support/SlayTheSpire2/logs and attach godot.log.
- Email: [email protected]
- Discord: @utsumabo (OLC)
