LearnMindustryMod

Appearance

使用 Anuke 提供的模板 ​

从模仿到超越

模板（Template）是一套即开即用、可以被编译成完整模组的、帮助新人modder快速上手的一套项目。我们接下来的教程都将围绕模板，而非从零搭建项目讲起。本节教程将介绍Mindustry模组的官方模板的使用方式。这里假定你已经拥有GitHub账号。

使用模板 ​

模板的下载地址：

INFO

Mindustry作者网名的正确拼写是Anuke，而GitHub用户名为Anuken是由于Anuke被抢注了

anuken-template-page

打开上述网址，如果你不打算便捷地同步模组，你可以点击“Code -> Download Zip”，并下载即可。下载后解压，使用IDEA打开此文件夹。

如果你想分享模组的源代码，或者上架模组浏览器，你可以在GitHub中使用此模组新建一个项目，直接点击绿色的“Use this template”，选择“Create a new repository”，并在页面中填写模组的仓库名，推荐与模组的名称保持一致。接下来，你将直接跳转到你新建的repo中，以后如果想在GitHub上访问此repo，可以在GitHub网页端右上角转到“Your repositories”。

create-a-new-repository

接下来，在IDEA中找到“从VSC中获取”，选择GitHub并登陆你的账号，在完成登陆后，你应当可以直接看到你的项目，双击之，等待即可。如果此阶段出现网络错误（如TimeOut等），可能需要 改善网络条件 。

本地构建测试 ​

下文所称build.gradle包括build.gradle.kts，Java文件包括Kotlin文件

打开项目后，请先叫停IDEA的所有活动（包括索引和下载gradle），先去找到build.gradle中的mindustryVersion变量，将其设置成最新的Mindustry版本，如果修改了build.gradle文件，屏幕右上部分中可能出现一个“加载Gradle更改的按钮”，按下它，IDEA会自动地帮你“加载gradle”，此过程可能需要耗费一段时间。如果此阶段出现网络错误（如TimeOut Cannot find dependencies等），可能需要 改善网络条件 。

configure-mindustry-version

接下来，在上方菜单“文件-项目结构”的“项目”子面中，设置“SDK”为你刚刚安装的Java 17/21，设置语言级别为对应的版本。

configure-java-version

然后，在软件右边栏中的Gradle（大象）按钮，找到“build/jar”，尝试运行，并等待一段时间，直到游戏输出“BUILD SUCCESSFUL”的字样。这证明你的开发环境已经无虞了。

try-jar

Hjson

JSON 本应易于人类读写——理论上确实如此。但现实中，JSON 仍存在大量稍不注意就会犯错的陷阱。Hjson 是一种基于 JSON 的语法扩展，它并非要取代 JSON 或将其纳入 JSON 规范，而是旨在为人类提供更友好的交互界面：先由人工阅读编辑，再交由机器解析JSON数据。

Hjson相比JSON的改进包括：省略逗号、支持注释、支持键名无引号、支持字符串无引号、支持多行字符串。Mindustry的所谓的json解析都是hjson解析，并且比hjson标准还要宽松，意味着你不如所有逗号和引号都不写了。

然后，找到mod.hjson文件，按照第一节的内容进行更改，特别要注意minGameVersion和main。minGameVersion最好随最好版本保持一致。而main必须是src下那个继承mindustry.mod.Mod的类的 全限定名（Fully Qualified Name） ，即“包名+类名”，如果你还没有修改过源代码，请保持example.ExampleMod才能成功加载模组。

再次编译，把修改好的模组导入游戏当中，重启游戏，你就会在屏幕当中看到一只大大的青蛙或ohno（这取决你有没有修改modName），这说明你的模组在桌面端进行已经不成问题了。如果你想要生成安卓端也能运行的模组，请确保Android SDK已安装，并执行“other/deploy”，如果成功在安卓设备上得到相同的效果，说明你的模组在桌面端进行已经不成问题了。

load-mod

模板文件结构 ​

  • assets/：一切资产文件，也就是媒体文件，默认本文件夹内部所有文件全部原样复制到模组安装包中
  • src/：一切源代码，以后的教程中所有Java/Kotlin文件都应该放在此目录下；
  • gradle/：存储gradle的下载链接，可以在此目录内的gradle-wrapper.properties中更新gradle；
  • build.gradle或build.gradle.kts：模组编译的配置文件；
  • gradlew.bat gradlew：Windows和*nix下gradle的命令行入口；
  • mod.hjson：模组的配置文件。

修改主类 ​

总挂着ExampleMod的名字是不对的，你最好把模组的包名和类名都改一下，这里我们假设把example.ExampleMod改成为tutorial.TutorialMod，记得在mod.hjson中同步更改，否则模组无法找到主类。

我们把主类改成这样:

java
package tutorial;

import arc.util.Log;
import mindustry.mod.Mod;

public class TutorialMod extends Mod {
    
    public TutorialMod() {
        Log.info("Loaded TutorialMod constructor.");
    }
    
    @Override
    public void loadContent() {
        Log.info("Loading some tutorial content.");
    }
}
kotlin

package tutorial

import arc.util.Log
import mindustry.mod.Mod

class TutorialMod : Mod() {
    init {
        Log.info("Loaded TutorialMod constructor.")
    }

    override fun loadContent() {
        Log.info("Loading some tutorial content.")
    }
}

太棒了！我们接下来都会以此为蓝本荡开叙述。

Github Actions ​

使用此模组的另一个好处是你可以不在本地配置Android SDK，而是在需要安卓支持的时候从 GitHub Actions 上获取通用jar。

打开你的GitHub repo，找到Actions选项卡，如果有绿色的确定按钮，请放心按下。接下来，打开最上方的选项卡，如果显示一个绿色对号说明编译成功，如果显示一个红色叉号说明编译失败，需要排查原因。然后在里面找到Artifacts，下载并解压即为全端通用的jar。

github-actions

如果编译失败了，可能是你的模组本身就无法通过编译，存在语法或语义错误，但是崩溃游戏并不会阻止编译过程；也有可能是GitHub Action更新并废止了旧版的写法，这时需要你自己更新.github/workflows/commitTest.yaml 中的内容了

上架模组浏览器 ​

打开模组的GitHub项目，点击右侧About的小齿轮，在其中的Topics项中输入mindustry-mod并点选，然后点击绿色的“Save Changes”。这样就上架成功了。

mod-browser-config

模组浏览器每隔两小时整点更新一次。