Skip to content

Documentation

Read Getting started first if the mod does not already reference RitsuLib. Then choose the page that matches the feature you are adding.

GoalPage
Add RitsuLib to a modGetting started
Learn the names used by the docsTerminology
Pick the right API surfaceHow the framework is organized
Register models and idsContent authoring
Work with registries directlyContent packs and registries
GoalPage
Build cards, relics, potions, powers, events, acts, and placeholder entriesContent authoring
Create a character and starter loadoutCharacter and unlock scaffolding
Add dynamic card numbers and tooltipsCard dynamic variables
Add events and ancient optionsCustom events
Add story / epoch progressionTimeline and unlocks
Override art and fallback profilesAsset profiles and fallbacks
Author Godot scenes safelyGodot scene authoring
Add creature visual playbackCreature visuals and animation
GoalPage
Save mod data and run migrationsPersistence
Add settings pagesMod settings
Use localized text, keywords, and SmartFormatLocalization and keywords
Understand LocString placeholdersLocString placeholders
Subscribe to game eventsLifecycle events
Patch game methodsPatching
Play FMOD events and local audio filesFMOD and audio
Add runtime UI helpersShell theme
Build a telemetry backendTelemetry backend
Check diagnostics and game-source notesDiagnostics and compatibility

Sources: Docs/en. Site: miooowo.github.io/STS2-RitsuLib_Docs. Upstream: BAKAOLC/STS2-RitsuLib.