How RitsuLib Is Organized
Choose An Entry Point
Section titled “Choose An Entry Point”Most mods only need five entry points.
| Need | Use |
|---|---|
| Register models, keywords, epochs, card piles, and top-bar buttons | RitsuLibFramework.CreateContentPack(modId) |
| Patch game methods | RitsuLibFramework.CreatePatcher(modId, patcherName) |
| React to game timing | RitsuLibFramework.SubscribeLifecycle<TEvent>(...) |
| Store JSON data | RitsuLibFramework.BeginModDataRegistration(modId) and GetDataStore(modId) |
| Add settings UI | RitsuLibFramework.RegisterModSettings(modId, configure) |
Use lower-level registries only when you need conditional registration, manifest-style arrays, or integration code shared across several mods.
User API Layers
Section titled “User API Layers”RitsuLib’s public API is split by the work a mod author is doing:
Scaffolding.Contentsupplies templates and builder methods for game content.Content,Keywords,CardTags,CardPiles,Timeline,Unlocks, andTopBarhold registries.DataandUtils.Persistencehandle mod data.Settings.ModSettingsandSettings.ModSettingsUibuild player-facing settings pages.Patchingwraps Harmony registration and diagnostics.Audio,RuntimeInput, andUiprovide runtime helpers.
Recommended Reading Order
Section titled “Recommended Reading Order”- Getting started
- Content authoring
- One feature page: character, settings, persistence, audio, or patching
- Diagnostics and compatibility before release