模组文件

模组文件负责确定哪些文件会被打包到你模组的JAR文件中，在“Mods”菜单中显示哪些信息，以及你的模组如何被加载到游戏中。

mods.toml

mods.toml定义你的一个或多个模组的元数据。它也包含一些附加信息，这些信息将在Mods菜单中被展示，并决定你的模组如何被加载进游戏。

该文件采用Tom’s Obvious Minimal Language（简称TOML）格式。这个文件必须保存在你所使用的源码集的resource目录中的META-INF文件夹下（例如对于main源码集，其路径为src/main/resources/META-INF/mods.toml）。mods.toml文件看起来长这样：

modLoader="javafml"
loaderVersion="[46,)"

license="All Rights Reserved"
issueTrackerURL="https://github.com/MinecraftForge/MinecraftForge/issues"
showAsResourcePack=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="[46,)"
  ordering="NONE"
  side="BOTH"

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

mods.toml被分为三个部分：非模组特定属性，与模组文件相关联；模组特定属性，对每个模组都有单独的小节；以及依赖配置，对每个模组依赖都有单独的小节。下面将解释与mods.toml文件相关的各个属性，其中required表示必须指定一个值，否则将引发异常。

非模组特定属性

非模组特定属性是与JAR文件本身相关的属性，指明如何加载模组和任何附加的全局元数据。

模组特定属性

模组特定属性通过[[mods]]头与指定的模组绑定。其本质是一个表格数组（Array of Tables）；直到下一个头之前的所有键/值对都会被关联到那个模组。

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

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

功能

功能系统允许模组在加载系统时要求某些设置、软件或硬件可用。当某个功能不满足时，模组加载将失败，并将要求通知给用户。目前，Forge提供以下功能：

依赖配置

模组可以指定它们的依赖项，这些依赖项在加载模组之前由Forge检查。这些配置是使用表格数组（Array of Tables）[[dependencies.<modid>]]创建的，其中modid是所依赖的模组的标识符。

模组入口点

现在我们已经填写了mods.toml，我们需要提供一个对模组进行编程的入口点。入口点本质上是执行模组的起点。入口点本身由mods.toml中使用的语言加载器决定。

javafml和@Mod

javafml是Forge为Java编程语言提供的语言加载器。入口点是通过使用带有@Mod注释的公共类来定义的。@Mod的值必须包含mods.toml中指定的一个Mod id。从那里，所有初始化逻辑（例如注册事件、添加DeferredRegister）都可以在类的构造函数中写明。模组总线可以从FMLJavaModLoadingContext获得。

@Mod("examplemod") // 必须匹配mods.toml
public class Example {

  public Example() {
    // 此处初始化逻辑
    var modBus = FMLJavaModLoadingContext.get().getModEventBus();

    // ...
  }
}

lowcodefml

lowcodefml是一种语言加载器，用于将数据包和资源包作为模组形式分发，而无需代码形式的入口点。它被指定为lowcodefml而不是nocodefml，用于将来可能需要的最少量代码的小添加。