Documentation
Read Getting started first if the mod does not already reference RitsuLib. Then choose the page that matches the feature you are adding.
| Goal | Page |
|---|---|
| Add RitsuLib to a mod | Getting started |
| Learn the names used by the docs | Terminology |
| Pick the right API surface | How the framework is organized |
| Register models and ids | Content authoring |
| Work with registries directly | Content packs and registries |
Authoring Content
Section titled “Authoring Content”| Goal | Page |
|---|---|
| Build cards, relics, potions, powers, events, acts, and placeholder entries | Content authoring |
| Create a character and starter loadout | Character and unlock scaffolding |
| Add dynamic card numbers and tooltips | Card dynamic variables |
| Add events and ancient options | Custom events |
| Add story / epoch progression | Timeline and unlocks |
| Override art and fallback profiles | Asset profiles and fallbacks |
| Author Godot scenes safely | Godot scene authoring |
| Add creature visual playback | Creature visuals and animation |
Runtime APIs
Section titled “Runtime APIs”| Goal | Page |
|---|---|
| Save mod data and run migrations | Persistence |
| Add settings pages | Mod settings |
| Use localized text, keywords, and SmartFormat | Localization and keywords |
| Understand LocString placeholders | LocString placeholders |
| Subscribe to game events | Lifecycle events |
| Patch game methods | Patching |
| Play FMOD events and local audio files | FMOD and audio |
| Add runtime UI helpers | Shell theme |
| Build a telemetry backend | Telemetry backend |
| Check diagnostics and game-source notes | Diagnostics and compatibility |
Sources: Docs/en. Site: miooowo.github.io/STS2-RitsuLib_Docs. Upstream: BAKAOLC/STS2-RitsuLib.