Documentation
Start
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 |
起步
如果项目还没有接入 RitsuLib，先读 快速入门。之后按正在编写的功能跳到对应页面。
| 目标 | 页面 |
|---|---|
| 给 Mod 接入 RitsuLib | 快速入门 |
| 理解文档使用的术语 | 术语 |
| 选择正确 API 入口 | 框架组织方式 |
| 注册模型和稳定 ID | 内容编写 |
| 直接使用注册器 | 内容包与注册器 |
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 |
编写内容
| 目标 | 页面 |
|---|---|
| 编写卡牌、遗物、药水、能力、事件、Act 与占位内容 | 内容编写 |
| 创建角色和初始牌组 | 角色与解锁脚手架 |
| 添加卡牌动态数值和 Tooltip | 卡牌动态变量 |
| 添加事件和 Ancient 选项 | 自定义事件 |
| 添加 Story / Epoch 进度 | 时间线与解锁 |
| 覆写美术资源和回退配置 | 资源配置与回退 |
| 安全编写 Godot 场景 | Godot 场景编写 |
| 添加生物动画播放 | 生物视觉与动画 |
Runtime APIs
| Goal | Page |
|---|---|
| Save mod data and run migrations | Persistence |
| Add combat-side secondary resources and card costs | Secondary resources |
| 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 |
| Inspect live session logs in a browser | Debug log viewer |
| Show an update toast from a mirrored manifest | Update checks |
| Build a telemetry backend | Telemetry backend |
| Check diagnostics and game-source notes | Diagnostics and compatibility |