Minecraft Fabric模組開發教學 #1 開發環境設定

Fabric是Java版Minecraft的模組載入器，近年來發展快速、相容性佳的特性，使其成為Forge的強勁對手，很多人開始用這個製作模組。

開發模組，你需要具備以下知識:

熟悉Java語法
電腦能正常執行Minecraft 1.17.1
會安裝fabric模組
有用英語google錯誤訊息的能力

第一篇教學是設定開發環境，和製作一個只有圖示的空白模組，放到遊戲中測試。

一、開發環境設定
#

1.安裝AdoptOpenJDK 16。 1.17開發模組必備，如果有裝其他版本的Java，請自行調整環境變數"JAVA_HOME"，確保目前作業系統都是使用Java 16。(參考: java 環境變數)

這裡使用AdoptOpenJDK而非Oracle公司發行的JDK，功能一樣，只是授權條款不同。

2.選擇一款IDE

IDE是開發程式碼的環境，好的IDE會在你打錯字告訴你，並提供很多方便的功能。在此我們選擇JetBrains發行的IntelliJ IDEA。

到官網的下載頁面，下載安裝右邊黑色的Community免費版。

二、設定專案
#

1.從 Github將官方的"fabric mod"範本複製到電腦 (按Code→Download ZIP)，解壓縮，將"fabric-example-mod-1.17"放到桌面。

2.開啟IDEA，點選右上角的"Open Project"，選擇fabric範本的資料夾。

3.開啟之後，下面的Gradle會開始工作，等待訊息出現"BUILD SUCCESS"，就表示完成了。 Gradle是一個自動化工具，能夠自動處理一些開發上的繁瑣操作。

4.從左邊的面板開啟"gradle.properties"，設定模組名稱與JDK路徑。注意目前Minecraft版本的部分是1.17.1，其他版本請到fabric 網站查詢。原本長這樣:

# Done to increase the memory available to gradle.
org.gradle.jvmargs=-Xmx1G

# Fabric Properties
	# check these on https://fabricmc.net/versions.html
	minecraft_version=1.17.1
	yarn_mappings=1.17.1+build.39
	loader_version=0.11.6

# Mod Properties
	mod_version = 1.0.0
	maven_group = com.example
	archives_base_name = fabric-example-mod

# Dependencies
	fabric_version=0.39.2+1.17

修改之後 ("#“開頭的是註解，自行刪除):

# Done to increase the memory available to gradle.
org.gradle.jvmargs=-Xmx1G
# 指定JDK路徑
org.gradle.java.home=C:/Program Files/Eclipse Foundation/jdk-16.0.2.7-hotspot

# Fabric Properties
	# check these on https://fabricmc.net/versions.html
	minecraft_version=1.17.1
	yarn_mappings=1.17.1+build.39
	loader_version=0.11.6

# Mod Properties
# 模組版本號取名:遊戲版本+模組版本
	mod_version = 1.17.1-0.0.1
# 以網站名稱命名，如果沒有就電子郵件倒著寫。例如"com.gmail.ivon"
	maven_group = net.mcbedev
# 模組ID。
	archives_base_name = mymod

# Dependencies
	fabric_version=0.39.2+1.17

5.調整完之後，按File -> Close Project，關閉這個專案，接著重新開啟專案。

6.展開src/main/java資料夾，會發現範本已經提供了一個範例"net.fabricmc.example”。這就是Java中所謂的"package"，你可以保留參考用，因為我們要用的專案應該跟上面gradle.properties檔案裡寫的一致。

7.對"java"資料夾按右鍵，New -> Package，輸入package的名稱，例如"net.mcbedev.mymod"

8.展開"resources"資料夾，開啟"fabric.mod.json"，這個檔案是我們模組檔案的資料。修改內容如下 (//是註解，一定要刪除):

{
  "schemaVersion": 1,
  //模組ID，必須獨一無二
  "id": "mymod",
  "version": "${version}",
  //模組名稱
  "name": "My Mod",
  //模組簡介
  "description": "My Fabric Mod.",
  //作者
  "authors": [
    "Ivon852"
  ],
  //聯絡資訊
  "contact": {
    "homepage": "https://twitter.com/ivon852",
    "sources": "https://github.com/FabricMC/fabric-example-mod"
  },
  //授權條款
  "license": "MIT",
  //模組圖示路徑
  "icon": "assets/mymod/icon.png",
  "environment": "*",
  //主程式路徑
  "entrypoints": {
    "main": [
      "net.mcbedev.mymod.Main"
    ]
  },
  //Mixin路徑
  "mixins": [
    "mymod.mixins.json"
  ],
  "depends": {
    "fabricloader": ">=0.11.3",
    "fabric": "*",
    "minecraft": "1.17.x",
    "java": ">=16"
  },
  "suggests": {
    "another-mod": "*"
  }
}

9.對"mixin.modid.json"按下右鍵，Refactor -> Rename，改名成"模組ID+mixins.json"，在跳出的視窗按下Refactor。

10.開啟該檔案，輸入以下內容:

{
  "required": true,
  "minVersion": "0.8",
  "package": "net.mcbedev.mymod.mixin",
  "compatibilityLevel": "JAVA_16",
  "mixins": [
  ],
  "client": [
    "MymodMixin"
  ],
  "injectors": {
    "defaultRequire": 1
  }
}

11.對"net.mcebedev.mymod"右鍵 -> New -> New Java Class，取名為"Main"，這就是主程式的類別。

12.在Main裡面輸入以下內容。整個模組的程式會從這裡開始，也就是onInitialize()方法來初始化模組的東西。System.out.println則是會在模組啟動時，於終端機顯示該行文字。

package net.mcbedev.mymod;

import net.fabricmc.api.ModInitializer;

public class Main implements ModInitializer {
    @Override
    public void onInitialize() {
        System.out.println("Hello Fabric world!");
    }
}