Minecraft Java 版 (1.16.4, jdk 1.8) 自製 Mod - 使用 Forge - 以 Subscribe Event 為例子

 如果只是要在 Minecraft 中玩 Forge 的 Mod (自己做好的或別人做好的)，

只需要以下步驟：

1. 去 Forge 官網下載對應 Minecraft 版本的 Installer。
2. 執行下載下來的 Installer 並安裝 Client 端。
3. 把要玩的 Mod (為 jar 檔) 放到 Minecraft 的 mods 資料夾中。
   預設 Minecraft 的根目錄會裝在這：
   C:\Users\XXX\AppData\Roaming\.minecraft
4. 執行 Minecraft 的 Launcher 啟動 Minecraft，
   點開 "安裝檔" 分頁，可以看到 Forge 的開始遊戲方式，用 Forge 開始遊戲，
   即可開始使用 Mod 玩遊戲了 (在選單介面可以看到點)，如下圖所示。
   
   
   
   
   
   

以下開始介紹使用 Forge 製作自己 Mod 的方法：

我的環境為 Win10

使用的 IDE 為 Eclipse

Note:

如果 Eclipse 所使用的 jdk 不是 jdk 1.8，

此時記得要把 Forge 的 Mod 專案的 compile Java 設定成 jdk1.8，

還有在執行 Forge Mod 專案中的 gradle task 時，要指定 jdk1.8，

例如：

gradlew build -Dorg.gradle.java.home={JDK_PATH}

或是在 Eclipse 裡的 gradle plugin run configuration 裡對 gradle task 設定 java_home 的位置

1. 去 Forge 官網下載對應 Minecraft 版本的 Mdk。
   
   
   
2. 解壓縮下載下來的檔案後，裡面的東西就是一個完整所需的 Minecraft Forge Mod Java 專案 (以下暫稱 Minecraft Forge Mod 專案)，不過還要執行一些 forge 已經幫我們寫好的 gradle task 來設定一些東西。
3. 以 Windows 環境為例，打開命令列模式視窗執行
   gradlew genEclipseRuns
4. 執行完 genEclipseRuns 的 gradle task後，再使用 Eclipse 的 Import project - Exsiting Gradle Project 功能把 Minecraft Forge Mod 專案給 Import 進來，就可以開始撰寫程式了。
   
5. 要測試自己寫的 Mod 的時候，可以執行 runClient 這個 gradle task，
   此時會有一個 Minecraft 遊戲視窗被打開，進去後應可以看到自己的 Mod 已被載入，開始遊戲後就可以在遊戲中使用自制的 Mod 了。
6. 寫好 Mod 想要輸出時，可以執行 build 這個 grade task，就會在專案的
   /build/libs 看到輸出的 Mod 的 jar 檔，把此 jar 檔放到遊戲的 mods 資料夾就可以在遊戲中使用了。

我有找到幾個不錯的參考資料，裡面的教學對我幫助很大，

雖然可能 Forge 版本不同有些微差異，但還是能幫助理解使用 Forge 自制 Minecraft Mod 的許多相關知識。

請參考本篇文章下方的 "參考資料"。

接下來我會以 Minecraft Mod 中註冊事件 (Subscribe Event) 為例子，

來實作一個在 Minecraft 中， "丟棄物品時，會在其位置產生一個XXX" 的功能

Note:

在 Minecraft 中，"丟棄" 和 "丟擲" 不同 ，其事件對應到 Forge 的 ItemTossEvent 和 ProjectileImpactEvent.Throwable

以下是專案的檔案結構：

可以看到裡面已經有一個範例 Mod, ExampleMod.java，

之後會建立自己的 Mod java class，所以可以 ExampleMod.java 刪掉或是把其中的
@Mod 那行刪掉，

被紅框框起來的部份是我自己建立的 Mod Class 檔： com.my.mode.MyMod.java，

接著要為此 Mod 決定一個 Mod 的名稱，也可以說是 Mod Id，只能英文小寫，

此例我們決定叫做 mymod，

決定好 Mod Id 後，要在 

main/resources/META-INF/mods.toml

裡設定 Mod Id，在 mods.toml 中，紀錄著 Mod 的相關資訊，例如 Mod Id, Mod 的名稱、敘述、作者資料等資訊，在 Minecraft 的 Mod 資訊頁面上也會顯示這些東西。

為了簡單，我們不修改其他東西，因為並不影響自制 Mod 的功能，

只要把下列這行修改成自己的 Mod Id 即可：

# The modid of the mod

modId="mymod" #mandatory

以下直接看程式碼：

mods.toml

# This is an example mods.toml file. It contains the data relating to the loading mods.
# There are several mandatory fields (#mandatory), and many more that are optional (#optional).
# The overall format is standard TOML format, v0.5.0.
# Note that there are a couple of TOML lists in this file.
# Find more information on toml format here:  https://github.com/toml-lang/toml
# The name of the mod loader type to load - for regular FML @Mod mods it should be javafml
modLoader="javafml" #mandatory
# A version range to match for said mod loader - for regular FML @Mod it will be the forge version
loaderVersion="[35,)" #mandatory This is typically bumped every Minecraft version by Forge. See our download page for lists of versions.
# The license for you mod. This is mandatory metadata and allows for easier comprehension of your redistributive properties.
# Review your options at https://choosealicense.com/. All rights reserved is the default copyright stance, and is thus the default here.
license="All rights reserved"
# A URL to refer people to when problems occur with this mod
issueTrackerURL="http://my.issue.tracker/" #optional
# A list of mods - how many allowed here is determined by the individual mod loader
[[mods]] #mandatory
# The modid of the mod
modId="mymod" #mandatory
# The version number of the mod - there's a few well known ${} variables useable here or just hardcode it
# ${file.jarVersion} will substitute the value of the Implementation-Version as read from the mod's JAR file metadata
# see the associated build.gradle script for how to populate this completely automatically during a build
version="${file.jarVersion}" #mandatory
 # A display name for the mod
displayName="My Mod" #mandatory
# A URL to query for updates for this mod. See the JSON update specification <here>
updateJSONURL="http://myurl.me/" #optional
# A URL for the "homepage" for this mod, displayed in the mod UI
displayURL="http://example.com/" #optional
# A file name (in the root of the mod JAR) containing a logo for display
logoFile="mymod.png" #optional
# A text field displayed in the mod UI
credits="Thanks for this example mod goes to Java" #optional
# A text field displayed in the mod UI
authors="Love, Cheese and small house plants" #optional
# The description text for the mod (multi line!) (#mandatory)
description='''
This is a long form description of the mod. You can write whatever you want here

Have some lorem ipsum.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed mollis lacinia magna. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed sagittis luctus odio eu tempus. Interdum et malesuada fames ac ante ipsum primis in faucibus. Pellentesque volutpat ligula eget lacus auctor sagittis. In hac habitasse platea dictumst. Nunc gravida elit vitae sem vehicula efficitur. Donec mattis ipsum et arcu lobortis, eleifend sagittis sem rutrum. Cras pharetra quam eget posuere fermentum. Sed id tincidunt justo. Lorem ipsum dolor sit amet, consectetur adipiscing elit.
'''
# A dependency - use the . to indicate dependency for a specific modid. Dependencies are optional.
[[dependencies.examplemod]] #optional
    # the modid of the dependency
    modId="forge" #mandatory
    # Does this dependency have to exist - if not, ordering below must be specified
    mandatory=true #mandatory
    # The version range of the dependency
    versionRange="[35,)" #mandatory
    # An ordering relationship for the dependency - BEFORE or AFTER required if the relationship is not mandatory
    ordering="NONE"
    # Side this dependency is applied on - BOTH, CLIENT or SERVER
    side="BOTH"
# Here's another dependency
[[dependencies.examplemod]]
    modId="minecraft"
    mandatory=true
# This version range declares a minimum of the current minecraft version up to but not including the next major version
    versionRange="[1.16.4,1.17)"
    ordering="NONE"
    side="BOTH"

com.my.mod.MyMod.java :

package com.my.mode;

import net.minecraftforge.fml.common.Mod;

@Mod("mymod") // 設定 Mod Id, 請先把 ExampleMod.java 拿掉或把其 @Mod 的那行註解掉
public class MyMod {
	
	public MyMod() {
		// 註冊 EventBus,
		// 先註冊 ModEventBus, 之後 onCommonSetupEvent 會被觸發執行,
		// 接著屬於 ModEventBus 的 Event 都會被觸發執行。
		// 再註冊 ForgeEventBus,
		// 之後屬於 ForgeEventBus 的 Event (例如 ItemTossEvent, ProjectileImpactEvent.Throwable 等) 都會被觸發執行。
		ModEventBusHandler.register();
	}
}

com.my.mod.ModEventBusHandler.java :

package com.my.mode;

import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.eventbus.api.IEventBus;
import net.minecraftforge.eventbus.api.SubscribeEvent;
import net.minecraftforge.fml.event.lifecycle.FMLCommonSetupEvent;
import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;

public class ModEventBusHandler {
	public static void register() {
		IEventBus modEventBus = FMLJavaModLoadingContext.get().getModEventBus();
		modEventBus.register(ModEventBusHandler.class);
		modEventBus.register(new ModEventBusHandler());
	}
	
	@SubscribeEvent
	public void onCommonSetupEvent(FMLCommonSetupEvent event) {
		ForgeEventBusHandler.register();
	}
}

com.my.mod.ForgeEventBusHandler.java :

package com.my.mode;

import net.minecraft.entity.EntityType;
import net.minecraft.entity.item.ItemEntity;
import net.minecraft.entity.passive.FoxEntity;
import net.minecraft.world.World;
import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.event.entity.item.ItemTossEvent;
import net.minecraftforge.eventbus.api.IEventBus;
import net.minecraftforge.eventbus.api.SubscribeEvent;

public class ForgeEventBusHandler {
	public static void register() {
		IEventBus forgeEventBus = MinecraftForge.EVENT_BUS;
		forgeEventBus.register(ForgeEventBusHandler.class);
		forgeEventBus.register(new ForgeEventBusHandler());
	}
	
	// Event 有分成在 ModEventUs 上的，或在 ForgeEventBus 上的，
	// 此例的 ItemTossEvent 為在 ForgeEventBus 上的 Event
	@SubscribeEvent
	public void onItemTossEvent(ItemTossEvent event) {
		//ItemTossEvent: 物品丟棄時觸發的 Event, 
		//在遊戲中可用按鍵 q 來丟棄物品
		ItemEntity item = event.getEntityItem();
		World world = item.getEntityWorld();
		
		if (!world.isRemote) { // 判斷是否為 logical server 端，即處理邏輯的那端
							   // 如果此例的 isRemote 為 true，即為 logical client 端
							   // 可參考
							   // https://hackmd.io/@immortalmice/Hkj9s-CvU/https%3A%2F%2Fhackmd.io%2F%40immortalmice%2FrJKayrf9U
			
			//建立一個狐狸物件
			FoxEntity fox = new FoxEntity(EntityType.FOX, world);
			fox.setPosition(item.getPosX(), item.getPosY(), item.getPosZ());
			//將物件放到世界中
			world.addEntity(fox);
		}
	}
}

資源分享：

1. Forge Installer (版本 1.16.4 - 35.1.4)
2. Forge Mdk (版本 1.16.4 - 35.1.4)
3. jdk1.8.0_161

專案原始碼分享 ：

MinecraftModTest.7z

參考資料:

1. Forge Docs
2. Minecraft Forge 1.15.2 模組開發教學
3. [Minecraft - 當個創世神] 從玩遊戲到設計遊戲 系列