查看“JS模组教程-框架”的源代码

=模组框架=
其实，你完全可以前往[[官方维基教程-模组制造介绍]]。

== 模组目录结构 ==

一个标准的 Mindustry 模组是一个文件夹'''''的<code>.zip</code>压缩包'''，其内部结构如下所示：

<pre>StarlyMds/ # 模组文件名称，本页面使用`星耀科技|StarlyMds`作为示范。
├── bundles/ # 多语言本地化文件（必须，不能改名）
│ └── bundle_zh_CN.properties # 中文语言包（必须，不能改名）
├── scripts/ # JavaScript 脚本（必须，不能改名）
│ ├── content/ # 自定义项目文件夹
│ │ ├── 1炮台.js # 代码文件
│ │ └── ...
│ ├── lib/ # 自定义规范库
│ │ ├── libMain.js # 库代码文件
│ │ └── ...
│ └── main.js # 主程序文件（必须，不能改名）
├── sprites/ # 图片资源文件夹（必须，不能改名）
│ ├── HighPressureDrill/ # 贴图组，如对于项目`HighPressureDrill`，这是其贴图文件夹，是否使用文件夹同游戏源码
│ │ ├── HighPressureDrill.png # 贴图，如对于项目`HighPressureDrill`，而且改贴图与下方的不是同一个
│ │ └── ...
│ ├── ...
│ ├── HighPressureDrill.png # 贴图，如对于项目`HighPressureDrill`
│ └── ...
└── mod.json # 模组元数据配置文件（必须，不能改名）
</pre>

== 核心配置文件：mod.hjson ==

在模组根目录下必须存在 <code>mod.json</code>，它定义了模组的基本信息。<br/>
<code>json</code>比<code>hjson</code>更易被常见编辑器支持，故不推荐使用<code>hjson</code>。

示例内容，对于<code>mod.json</code>：
<pre>
{
	"name": "starlymds",
	"displayName": "星耀科技",
	"author": "利航星",
	"description": "设施与物品模组",
	"version": "1.0.0",
	"minGameVersion": "158",
	"dependencies": [ ],
	"hidden": false
}
</pre>

'''name''': 模组的唯一标识符，只能包含小写字母、数字和连字符。
'''displayName''': 在游戏模组列表中显示的名称。
'''author''': 你的名字。本模组由利航星（[[用户:利航星]]）编写，但'''请勿在你的模组里写上本页作者的名字'''。
'''description''': 模组描述。
'''version''': 模组版本。
'''minGameVersion''': 模组兼容的最小游戏版本号。
'''dependencies''': 依赖，可见[[官方维基教程-模组制造介绍#依赖|官方维基教程]]。
'''hidden''': 隐藏影响模组能否用于多人游戏，默认为 false。'''请填false。'''