战国 Mod 开发文档

模块声明(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选填挂点说明

[Distribution.Tools]

字段必填说明
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 上,模块自己读。引擎只认识上面这些通用段。

装载器读到的其它字段

装载器读到的字段都在上面的契约表里。