参考手册
参考区回答「确切是什么」:字段名、取值、约束、原因码与已裁定的架构结论。它不替代概念解释与操作指南;第一次接触项目时,先读快速开始,需要理解取舍时再回到这里查证。
这组页面怎么用
| 页面 | 回答什么问题 | 典型时机 |
|---|---|---|
| 剧本 IR v1 | 剧本图有哪些字段,节点、边、条件、文本怎么写,预算多少 | 写剧本、做编辑器、排查 GUARD_IR_UNSUPPORTED |
| 装载与运行原因码 | 某个码是什么意思,出现在哪个阶段,能不能重试 | 看到拒绝、待裁决或运行期错误 |
| 包清单与目录 | pack.json 怎么填,目录怎么放,三种包形态与签名文件是什么 | 打包、签名、排查 LOADER_MANIFEST_INVALID |
| 术语速查 | 一个词在本项目里的确切含义 | 读文档遇到不熟悉的词 |
| 架构决策摘要 | 哪些结论已经定下,为什么,哪些还没有定 | 设计扩展、评审实现、判断能不能改 |
建议的查阅顺序
- 先定位对象:是剧本数据、包清单、装载结果,还是术语与决策。
- 再查字段表:字段的必填性、取值范围与拒绝码在同一页给出。
- 最后看流程:字段合法不代表允许装载;准入、签名与 policy 见装载管线与 guard与信任与签名。
例如,一张剧本图被拒绝时:
text
先看 /reference/ir-schema 的预算与跨字段检查
→ 再看 /reference/error-codes 确认码的类别
→ 若是落点或 policy 问题,转 /architecture/loader-guard
→ 若是签名或发布者问题,转 /concepts/trust规范来源与优先级
本站是面向公众的整理,不是规范的唯一副本。出现不一致时按以下顺序判断:
| 优先级 | 来源 | 说明 |
|---|---|---|
| 1 | 代码与契约测试 | src/、test/contract/ 的实际行为;两端测试都通过才算「已完成」 |
| 2 | 共享定义 | src/shared/ir.ts、src/shared/codes.ts、src/core/kernel/manifest.ts 等 |
| 3 | 发布的 schema | schema/ir-1.schema.json 由共享定义生成 |
| 4 | 本站文档 | 对上述内容的解释与索引 |
文档不编造接口、字段、命令、端口或文件名。遇到文档没有写清的接口细节,以对应大插件的 contract.ts 为准;遇到文档与代码不一致,以代码与测试为准,并通过反馈渠道告知维护者。
写作与阅读约定
- 文档用中文,代码标识符保持英文;字段名、服务名、指令名按原样书写。
- 引用代码位置时写仓库内相对路径,例如
src/core/kernel/manifest.ts,不使用本机绝对路径。 - 实现状态只取「已完成/测试中/实现中/未实现」。「已完成」指网页与宿主两端的契约测试都通过。
- 内部链接使用站点绝对路径,不带
.md后缀。 - 需要图示时用表格、列表或纯文本树,不引入图形渲染扩展。
- 不在文档中记录密钥、令牌、内部端点或部署配置。
页面之间的连接
| 想进一步了解 | 从这里进入 |
|---|---|
| 四档扩展模型与写边 | 四档扩展模型、policy 与写边 |
| 插槽、实现位与 registry | 插槽与实现位、Kernel |
| 包如何被读取与判定 | 分发包与包结构、装载管线与 guard |
| 签名、TOFU 与安全关键 UI | 信任与签名、隔离运行 |
| 翻译层与隔离 codec | 翻译层、Translate |
| 资源管线与 VPath | 资源管线、Asset |
| 剧本播放、存档与章节 | ScriptPlay、Save |
| 网页与 Tauri 的差异 | 网页与 Tauri、Platform |
参考区的维护边界
参考区只写可核对的事实与已裁定的结论。以下内容不进入参考区:
- 尚未裁定的接口字段、默认值与协议细节;这类内容只在架构决策摘要的「仍待裁定」中标注。
- 内部编号、讨论记录、审计材料与内部参照值。
- 任何密钥、令牌、服务器地址、内部端点或部署配置。
- 针对具体外部内容的操作说明;本站只描述框架、翻译层、数据包、资源包、插件与 Mod 的通用机制。