模块声明(mod.toml)
模块清单的全部字段与约定。
每个模块一个 mod.toml,声明它是谁、依赖谁、拥有哪些状态与能力。
发行版入口文件(mods.toml)用 [Load] 声明装哪些模块。
[Mod]
| 字段 | 必填 | 说明 |
|---|
Id | 必填 | 模块唯一 ID;能力名就是「模块ID:能力名」 |
Version | 必填 | 模块版本;存档兼容按它判断 |
Entry | 必填 | 模块:类名,类要实现 GameMod |
Requires | 选填 | 必须存在的依赖模块 |
After | 选填 | 结算顺序:本模块在这些模块之后 |
Before | 选填 | 结算顺序:本模块在这些模块之前 |
Kind | 选填 | 模块种类 |
Aliases | 选填 | 别名列表(政体查找用) |
[State]
| 字段 | 必填 | 说明 |
|---|
Owns | 选填 | 本模块独占的状态键;别人要写必须先在 Requests 里申请 |
Requests | 选填 | 本模块要写别的模块的状态时,在这里申请 |
[Capabilities]
| 字段 | 必填 | 说明 |
|---|
Provides | 选填 | 本模块提供的能力名 |
Needs | 选填 | 本模块用到的其他能力名 |
Optional | 选填 | 可选依赖:对方不在也不报错 |
[Interfaces]
| 字段 | 必填 | 说明 |
|---|
(能力名) | 选填 | 用到的其他能力的方法名清单,形如 "mini:army" = ["seed"] |
[PlayerAPI]
| 字段 | 必填 | 说明 |
|---|
Methods | 选填 | 本模块对玩家开放的方法 |
ReadOnly | 选填 | 其中只读的方法 |
Actions | 选填 | 方法名 → 动作名 的别名表 |
ContentParameters | 选填 | 哪些参数是内容键值 |
[Load]
| 字段 | 必填 | 说明 |
|---|
Packages | 必填 | 发行版入口文件:模块目录列表 |
[Distribution]
| 字段 | 必填 | 说明 |
|---|
Id | 必填 | 发行版 ID |
Version | 必填 | 发行版版本 |
Members | 必填 | 成员模块清单(相对发行版目录的路径) |
RequiredState | 选填 | 必须有人拥有的状态键 |
ActorCollection | 选填 | 玩家集合在世界上的属性名 |
ActionGate | 选填 | 行动资格:能力名 + 方法名 |
PlayerClock | 选填 | 回合时钟:能力名 + 方法名 |
PlayerEvents | 选填 | 玩家事件来源:只读工具名 |
PlayerState | 选填 | 每回合自动发给模型的事实:只读工具名列表 |
PlayerStateInclude | 选填 | 额外并入 PlayerState 的面板 |
PlayerStateExclude | 选填 | 从 PlayerState 里排除的面板 |
ReadOnlyPanel | 选填 | 只读面板名列表 |
ManualOrder | 选填 | 规则正文的章节顺序 |
Scenarios | 选填 | 剧本声明 |
Tools | 选填 | 工具层:Entry 指向工具层入口 |
Session | 必填 | 会话:Entry 指向发行版的会话类 |
Configuration | 选填 | 配置归一化:Entry 指向函数 |
Assembly | 选填 | 装配前按配置选择模块、服务和客户端,Entry指向发行版自有函数 |
Features | 派生 | 发行版装配器记录的实际功能开关;随依赖清单校验 |
ClientFactories | 选填 | 客户端工厂:模型客户端、规则客户端等 |
[Hooks]
| 字段 | 必填 | 说明 |
|---|
Id | 必填 | 挂点 ID |
Name | 选填 | 挂点显示名 |
Description | 选填 | 挂点说明 |
| 字段 | 必填 | 说明 |
|---|
Entry | 必填 | 工具层入口:模块:函数 |
Version | 选填 | 工具层版本 |
[Distribution.ClientFactories.<名字>]
| 字段 | 必填 | 说明 |
|---|
Entry | 选填 | 客户端类:模块:类名 |
Configuration | 选填 | 该客户端的配置归一化函数 |
Services | 选填 | 授予该客户端的能力方法 |
[Distribution.Session]
| 字段 | 必填 | 说明 |
|---|
Entry | 必填 | 会话类:模块:类名 |
Services | 选填 | 会话服务(议会、脚本等) |
Observer | 选填 | 观察者能力:记录、广播、送信 |
[Distribution.Configuration]
| 字段 | 必填 | 说明 |
|---|
Entry | 必填 | 配置归一化函数 |
Preflight | 选填 | 开局前只读检查,不创建Session或调用模型 |
[Distribution.Assembly]
| 字段 | 必填 | 说明 |
|---|
Entry | 必填 | 接收发行版声明与原始配置,返回实际装配声明 |
模块自己的表
模块可以在自己的 mod.toml 里加任意表([Bank]、[Policy]、[Limits] 等),这些表原样挂在 mod.declaration 上,模块自己读。引擎只认识上面这些通用段。
装载器读到的其它字段
装载器读到的字段都在上面的契约表里。