How RitsuLib Is Organized

Choose An Entry Point

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.

选择入口

大多数 Mod 只需要五个入口。

需求使用
注册模型、关键词、Epoch、卡堆和顶栏按钮RitsuLibFramework.CreateContentPack(modId)
Patch 游戏方法RitsuLibFramework.CreatePatcher(modId, patcherName)
响应游戏时机RitsuLibFramework.SubscribeLifecycle<TEvent>(...)
存储 JSON 数据RitsuLibFramework.BeginModDataRegistration(modId)GetDataStore(modId)
添加设置界面RitsuLibFramework.RegisterModSettings(modId, configure)

只有在需要条件注册、数组清单式注册,或要把集成代码复用到多个 Mod 时,才直接使用底层注册器。

User API Layers

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.

用户 API 层级

RitsuLib 的公开 API 按 Mod 作者正在做的事情划分:

  • Scaffolding.Content 提供游戏内容模板和 builder 方法。
  • ContentKeywordsCardTagsCardPilesTimelineUnlocksTopBar 保存注册器。
  • DataUtils.Persistence 处理 Mod 数据。
  • Settings.ModSettingsSettings.ModSettingsUi 构建玩家可见的设置页面。
  • Patching 封装 Harmony 注册和诊断。
  • AudioRuntimeInputUi 提供运行时辅助能力。
  1. Getting started
  2. Content authoring
  3. One feature page: character, settings, persistence, audio, or patching
  4. Diagnostics and compatibility before release

推荐阅读顺序

  1. 快速入门
  2. 内容编写
  3. 选择一个正在使用的专题:角色、设置、持久化、音频或补丁
  4. 发布前阅读 诊断与兼容