Mod 文件

Mod 文件决定哪些 Mod 被打包进 JAR、在“Mods”菜单中显示什么信息，以及游戏应如何加载这些 Mod。

原创说明图，依据 Forge 1.21.x 官方文档 绘制。

mods.toml

mods.toml 定义 Mod 的元数据，也包含“Mods”菜单中显示的信息以及加载方式。文件采用 TOML 格式，必须位于所使用源集的资源目录中的 META-INF 文件夹下；对于 main 源集，路径为 src/main/resources/META-INF/mods.toml。例如：

modLoader = "javafml"
loaderVersion = "[52,)"
license = "All Rights Reserved"
issueTrackerURL = "https://github.com/MinecraftForge/MinecraftForge/issues"
showAsResourcePack = false
clientSideOnly = false

[[mods]]
  modId="examplemod"
  version="1.0.0.0"
  displayName="Example Mod"
  updateJSONURL="https://files.minecraftforge.net/net/minecraftforge/forge/promotions_slim.json"
  displayURL="https://minecraftforge.net"
  logoFile="logo.png"
  credits="I'd like to thank my mother and father."
  authors="Author"
  description='''
  Lets you craft dirt into diamonds. This is a traditional mod that has existed for eons. It is ancient. The holy Notch created it. Jeb rainbowfied it. Dinnerbone made it upside down. Etc.
  '''
  displayTest="MATCH_VERSION"

[[dependencies.examplemod]]
  modId="forge"
  mandatory=true
  versionRange=" [52,)"
  ordering="NONE"
  side="BOTH"

[[dependencies.examplemod]]
  modId="minecraft"
  mandatory=true
  versionRange=" [1.21.1,)"
  ordering="NONE"
  side="BOTH"

文件分为三部分：关联 Mod 文件的非 Mod 专属属性；每个 Mod 各有一节的 Mod 属性；以及每个 Mod 的依赖配置。下文中“必填”表示必须提供值，否则会抛出异常。

非 Mod 专属属性

这些属性与 JAR 本身关联，指定 Mod 的加载方式及其他全局元数据。

services 在功能上等同于模块中的 uses 指令，允许加载指定类型的服务。

Mod 专属属性

使用 [[mods]] 标题将属性关联到特定 Mod。这是一个表数组，下一个标题之前的键值均属于该 Mod。

# examplemod1 的属性
[[mods]]
modId = "examplemod1"
# examplemod2 的属性
[[mods]]
modId = "examplemod2"

特性

特性系统允许 Mod 要求加载时具备特定设置、软件或硬件。未满足要求时加载会失败并告知用户。目前 Forge 提供 java_version：用 Maven 版本范围表示可接受的 Java 版本范围，应该与 Minecraft 所支持的版本一致，例如 "[17,)"。译注：此处保留原文示例；Forge 1.21.x 入门页要求 Java 21，实际配置应与所支持的 Minecraft 和 Java 版本一致。

依赖配置

Forge 在加载 Mod 前检查声明的依赖。使用表数组 [[dependencies.<modid>]] 创建配置，其中 modid 是声明依赖的 Mod ID。

警告：两个 Mod 的 ordering 可能形成循环依赖并导致崩溃，例如 A 必须在 B 之前加载，而 B 又必须在 A 之前加载。

Mod 入口点

填写 mods.toml 后，需要提供入口点以开始编写 Mod。入口点是执行 Mod 的起点，由 mods.toml 中的语言加载器决定。

javafml 和 @Mod

javafml 是 Forge 提供的 Java 语言加载器。入口点是带 @Mod 注解的公共类，注解的值必须是 mods.toml 中声明的 Mod ID 之一。初始化逻辑（例如注册事件或添加 DeferredRegister）可以写在构造函数中。通过作为构造函数参数传入的 FMLJavaModLoadingContext 获取 Mod 总线：

@Mod("examplemod") // 必须与 mods.toml 匹配
public class Example {
  public Example(FMLJavaModLoadingContext context) {
    // 在此初始化
    var modBus = context.getModEventBus();
    // ...
  }
}

lowcodefml

lowcodefml 是一种语言加载器，可将数据包和资源包作为 Mod 分发，无需代码入口点。它被称为 lowcodefml 而非 nocodefml，是为了给将来可能需要少量代码的小幅扩展留有余地。

原文：Mod Files。