阿超 > Fabric

Fabric

2025-04-17

java

如果不忘记许多，人生无法再继续。——巴尔扎克

我的世界 Fabric 模组开发入门指南

Fabric 是 Minecraft 的一个轻量级模组加载器和 API，它为开发者提供了一个灵活的开发环境，同时对游戏性能的影响较小。在这篇博客中，我们将介绍 Fabric 的基本概念、如何搭建开发环境，以及创建一个简单的自定义模组。

什么是 Fabric？

Fabric 是一个专为 Minecraft 设计的模组加载器，与 Forge 相比，它更加轻量、快速，并且支持快速的更新和版本迭代。对于想要为 Minecraft 添加自定义功能的玩家和开发者，Fabric 是一个非常不错的选择。

Fabric 的特点包括：

  • 轻量化：对游戏性能的影响较小。
  • 快速更新：通常会在 Minecraft 的新版本发布后迅速支持。
  • 模块化 API：开发者可以选择性地加载所需的功能模块。
  • 强大的社区支持：拥有丰富的文档与教程。

开发环境搭建

在开始开发之前，你需要先搭建一个基础的开发环境。以下是搭建 Fabric 开发环境的步骤：

1. 安装必要的软件

  • Java 开发工具包（JDK）：推荐使用 JDK 17。
  • Gradle：Fabric 项目通常使用 Gradle 作为构建工具。
  • IDE（集成开发环境）：推荐使用 IntelliJ IDEA 或 Eclipse。

2. 下载 Fabric 模板项目

Fabric 官方提供了一个 模板项目，你可以通过以下命令克隆它：

1
git clone https://github.com/FabricMC/fabric-example-mod.git

3. 导入项目到 IDE

  1. 打开你的 IDE，选择“导入项目”。
  2. 选择刚刚克隆的项目路径。
  3. 确保选择 Gradle 作为项目构建工具。

4. 配置开发环境

修改 gradle.properties 文件，确保 Minecraft 和 Fabric 的版本与你的目标一致。例如：

1
2
3
minecraft_version=1.20.1
yarn_mappings=1.20.1+build.12
loader_version=0.14.21

然后在终端运行以下命令以下载依赖：

1
./gradlew genSources

创建你的第一个模组

接下来，我们将通过一个简单的示例来创建一个自定义模组。

1. 编辑 fabric.mod.json

fabric.mod.json 是模组的配置文件，用于定义模组的基本信息和依赖。以下是一个示例：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
  "schemaVersion": 1,
  "id": "mymod",
  "version": "1.0.0",
  "name": "My First Mod",
  "description": "This is my first Fabric mod!",
  "authors": ["VampireAchao"],
  "entrypoints": {
    "main": [
      "com.example.mymod.MyMod"
    ]
  },
  "depends": {
    "fabricloader": ">=0.14.21",
    "minecraft": "1.20.1"
  }
}

2. 编写模组主类

在 src/main/java 下创建一个包，例如 com.example.mymod，并添加一个主类 MyMod：

1
2
3
4
5
6
7
8
9
10
package com.example.mymod;

import net.fabricmc.api.ModInitializer;

public class MyMod implements ModInitializer {
    @Override
    public void onInitialize() {
        System.out.println("Hello, Fabric world! This is my first mod.");
    }
}

3. 添加自定义内容

例如，我们可以添加一个自定义物品：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
package com.example.mymod;

import net.fabricmc.fabric.api.item.v1.FabricItemSettings;
import net.minecraft.item.Item;
import net.minecraft.util.Identifier;
import net.minecraft.util.registry.Registry;

public class ModItems {
    public static final Item CUSTOM_ITEM = new Item(new FabricItemSettings());

    public static void registerItems() {
        Registry.register(Registry.ITEM, new Identifier("mymod", "custom_item"), CUSTOM_ITEM);
    }
}

在 MyMod 类的 onInitialize 方法中注册它：

1
2
3
4
5
@Override
public void onInitialize() {
    ModItems.registerItems();
    System.out.println("Mod initialized!");
}

调试和测试

完成代码后，你可以使用以下命令启动 Minecraft 客户端并测试你的模组：

1
./gradlew runClient

如果一切正常，你应该能在游戏中看到你的自定义物品！

发布模组

当你的模组开发完成后，可以通过以下步骤发布它：

  1. 在 build.gradle 中配置版本号和其他相关信息。

  2. 使用 Gradle 构建项目：

    1
    ./gradlew build

  3. 生成的模组文件会位于 build/libs 目录下。

你可以将模组上传到 CurseForge 或 Modrinth 等平台，与其他玩家分享。

总结

通过 Fabric，你可以轻松地为 Minecraft 开发自己的模组。这篇博客介绍了从搭建开发环境到创建一个简单模组的全过程，希望对你有所帮助。记住，多尝试、多实践，享受开发的乐趣吧！

如果你有任何问题或建议，欢迎在评论区留言。

Happy Modding!