Documentation index
Last updated:
- Published on
Overview
概述
Use the sidebar or the tables below. Guide pages are Markdown in this repo under docs/pages/guide/.
可通过侧栏或下方表格浏览。正文为仓库内 docs/pages/guide/ 下的 Markdown，可直接编辑。
Start here
从这里开始
| Page | Description |
|---|---|
| Getting started | Dependency, bootstrap, first registered content |
| Framework design | Architecture and recommended reading order |
| Terminology | Canonical terms used across these docs |
Content authoring
内容编写
| Page | Description |
|---|---|
| Content authoring toolkit | Identity rules, localization contracts, asset overrides |
| Content packs & registries | Registry model, fixed identity, registration flow |
| Character & unlock scaffolding | Character assembly, registration, unlock integration |
| Card dynamic variables | Custom card vars with tooltip support |
| Custom events | Event registration, localization, custom scenes |
| Timeline & unlocks | Story / epoch registration, progression, compatibility |
| Asset profiles & fallbacks | Placeholder fallback, profiles, path diagnostics |
| Godot scene authoring | Scene-script wrappers, editor notes, runtime registration |
| Mod settings | Settings UI architecture, bindings, controls, pages |
| 文档 | 说明 |
|---|---|
| 内容注册规则 | 身份规则、本地化约束与资源覆写基础 |
| 内容包与注册器 | 注册器模型、固定身份与注册流程 |
| 角色与解锁模板 | 角色装配、注册与解锁集成 |
| 卡牌动态变量 | 带 Tooltip 支持的自定义卡牌变量 |
| 自定义事件 | 事件注册、本地化对齐与自定义场景 |
| 时间线与解锁 | Story / Epoch 注册、进度规则与兼容桥接 |
| 资源配置与回退 | Placeholder、Profile 与路径诊断 |
| Godot 场景编写 | 场景脚本包装、编辑器注意事项与运行时注册 |
| Mod 设置界面 | 设置 UI、绑定、控件与页面组合 |
Localization
本地化
| Page | Description |
|---|---|
| Localization & keywords | I18N, keyword registration, ancient dialogue |
| LocString placeholder resolution | Placeholder syntax, formatters, extension points |
| 文档 | 说明 |
|---|---|
| 本地化与关键词 | I18N、关键词注册与 Ancient 对话本地化 |
| LocString 占位符解析 | 占位符语法、格式化器与扩展点 |
Runtime & infrastructure
运行时与基础设施
| Page | Description |
|---|---|
| Lifecycle events | Lifecycle reference and timing |
| Patching guide | ModPatcher, IPatchMethod, dynamic patches |
| Persistence guide | Store scopes, save lifecycle, migrations |
| FMOD & audio | GameFmod, banks, buses, streaming files |
| Diagnostics & compatibility | Diagnostics policy, fallbacks, bridge patches |