跳到正文

清单文件

mod.json:模组的身份、它加入的定义和定义所用的精灵图,以及如何用多种语言书写文本。

mod.json 就是模组本身。它写明模组的名字和版本,再列出模组加入的内容:它的定义、定义所用的精灵图,以及它携带的其他一切:阵营、地形变体、音效与音乐、主页背景。

文本

name、description 以及定义的 name/desc 都是文本:一个字符串(所有语言共用)、按顺序排列的 ["English", "中文", "한국어"],或 { "en": "…", "zh": "…", "ko": "…" }。只有英文是必填的,缺少的语言会显示英文。

参考

mod.json

字段类型必填默认含义
capacitystandard | largestandard格式 4:large 允许 1024 个定义、2048 张图、512 个音效、4 MiB 元数据和 256 MiB 已编码资源;standard 保留 200/192/60 和 1/24 MiB 限额
requiredCapabilitiescapability id[]由扩展包提供的必需能力 ID
extensionPackages{ id, version, api, capabilities, schema, runtime, presentation? }[]含 SHA-256 校验的配置验证、模拟和可选显示模块的版本化扩展包(格式 4)
formatstring必填固定为 "steel-tide-mod"
vinteger 1–4必填格式版本:仍支持 1;阵营和总部需要 2;扩展配置需要 3;可执行扩展包需要 4
idid必填模组 id:小写字母、数字和 `-`,也是它在仓库中的文件夹名
nametext必填模组列表中显示的名称
versionstring必填如 `1.0.0`;仓库版本更新时游戏会提示更新
authorstring作者
descriptiontext一两句话的介绍
homepagestring主页链接
licensestringCC-BY-4.0模组许可证(SPDX 标识)
minGamestring所需的最低游戏版本
defsdef[]必填单位、建筑与升级等级;提供 terrains、音乐队列或菜单背景时可为空
factionsfaction[]可选阵营,各有自己的总部、初始建造单位和单位表(格式 2)
terrainsterrain[]最多 32 种由地图选择的地形外观变体;保留基础地形的游戏规则
spritessheet[]各定义使用的精灵图(见下)
music{ tracks, menu, setup, battle }自定义背景音乐及菜单、设置、战斗的顺序播放队列(见下)
menuBackground{ cuts, queue }主页背景镜头的顺序队列,可混用原版场景与本模组地图(见下)
soundssound[]武器开火时播放的录音(见下)
screenshotspath[]模组游玩截图,路径相对 mod.json(`screenshots/1.png`):4:3,宽至少 640 像素,每张不超过 2 MB,最多 8 张。仓库要求至少一张,并展示在模组页面上
mapsstring模组自带的地图,路径相对 mod.json(`maps/city.steel-tide-map`):场景编辑器导出的文件,最多 8 张,每张不超过 512 KB。地图上可以预置本模组的单位;模组开启时,设置界面会把它列在自定义地图旁
files{ path: dataURL }仅单文件形式:按路径内嵌的图片、音频与地图(data URL)

最后编辑