Skip to content

How RitsuLib Is Organized

Most mods only need five entry points.

NeedUse
Register models, keywords, epochs, card piles, and top-bar buttonsRitsuLibFramework.CreateContentPack(modId)
Patch game methodsRitsuLibFramework.CreatePatcher(modId, patcherName)
React to game timingRitsuLibFramework.SubscribeLifecycle<TEvent>(...)
Store JSON dataRitsuLibFramework.BeginModDataRegistration(modId) and GetDataStore(modId)
Add settings UIRitsuLibFramework.RegisterModSettings(modId, configure)

Use lower-level registries only when you need conditional registration, manifest-style arrays, or integration code shared across several mods.

RitsuLib’s public API is split by the work a mod author is doing:

  • Scaffolding.Content supplies templates and builder methods for game content.
  • Content, Keywords, CardTags, CardPiles, Timeline, Unlocks, and TopBar hold registries.
  • Data and Utils.Persistence handle mod data.
  • Settings.ModSettings and Settings.ModSettingsUi build player-facing settings pages.
  • Patching wraps Harmony registration and diagnostics.
  • Audio, RuntimeInput, and Ui provide runtime helpers.
  1. Getting started
  2. Content authoring
  3. One feature page: character, settings, persistence, audio, or patching
  4. Diagnostics and compatibility before release