基于FML的MinecraftMod制作教程(2) - 建立一个基于Forge的Mod

我决定以一个开发实例作为教程,我们要使用Forge来创建一个叫做Diracon的mod,它将具有如下功能.
(1)一个新的矿物(砖块):Diracium
(2)一个新的矿锭(物品):Diracium Ingot
(3)一个新的物品:Dirac Wand
(4)一种新的Mob:Dirac Pig
(5)添加新的功能,使Dirac Wand具有瞬间转移箱子内的物品的能力
(6)修改地形生成器,使新矿物可以生成
(7)一个以土块为燃料的新炉子Unthinkable Furnace
(8)支持多人游戏!

这8个功能基本涵盖了基础mod开发的全部,我计划分为三个部分,(1)(2)(3)作为第一部分,(4)(5)作为第二部分,(6)(7)和mod的编译发布作为第三部分.而(8)会作为贯穿全篇的一个目标,自始至终都在进行.

这里说明一下本教程中不同颜色的字体所代表的含义.
蓝色:一个章节
红色:知识点,相当于一个章节所讲内容的概括
灰色:原理,想深入学习MCP和Forge的人可以读读,普通MODer可以无视了.

再统一一下今后教程中将使用的术语.

从上往下看.
红1:这个类所处的包(Package).
蓝1:导入的包.
绿1:类,类的概念我实在难以解释,熟悉Java的人应该都知道吧...
紫1:继承,派生.正规的说法是一个基类派生出子类,子类继承自基类.然后我们并不在乎这上面的文字游戏,汉语本来就是个不规范的语言呢...我们说子类从基类派生而来,或子类继承自基类不也一样吗...所以本文不会太注重派生/继承的用词.但我保证会留下足够的逻辑线索让你一眼看出我所表达的意思.
青1:基于XXX接口创建类.
红2:类的空位,即方法与方法间的空位,如果我说"在XX类中添加这些代码"就是指在这些位置添加代码.
蓝2:构造函数.如果一个方法的名字和类相同,那么它就是构造函数.它会在类实例化时执行.
绿2:方法/函数,我习惯叫它方法.这个是最准确最规范的叫法.
紫2:返回值.
青2:参数.

最后再向新手程序员解释一下何为重写,重写(Override)是让子类的方法覆盖父类的方法,重写的办法是让子类方法的名字和父类方法一致.唯一特例是构造函数,它的名字依然和子类名字保持一致,但必须调用父类的构造函数(使用super).

创建一个Package(包)
Java以Package的形式来管理代码,它的作用类似于C++和C#的命名空间,优点是便于将代码分类管理,使程序更加直观;方便控制代码的作用范围;解决类的重名现象(比如下一章要用到的Block类,有6个类都叫Block,但只有net.minecraft.block包中的Block才是真正需要的).MDK自带的范例里已经自带了一个包和一段程序,不过这里我们还是新建一个.
Package的命名很随意,Forge建议的命名规范是"作者名.mod名",Java建议的Package命名规范是Package的制作公司的网站的域名的倒写,例如"com.sun","com.google"等...
比如:
fanhua.minelogin
szszss.eracraft
net.mcbbs.multicraft
net.areazero.tohoskyarena
总之不必在这个的命名上费太多脑筋,但是不要有太奇怪的命名,比如:
pan.1c0xr8Hy.h0yx.SSTM
就是不行的,首先包中的每一段必须是字母或下划线开头,不能是数字,其次不建议包名使用大写.

首先你要为服务器端与客户端的公用代码创建一个package,右键项目中的src/main/java,选择New->Package

(关于目录结构,这个跟Gradle的设计有关,Gradle将目录分为两个部分:源代码(我们使用Java来编程,因此自然叫java)和资源文件(resource),因此我们以后将程序放在src/main/java里,资源文件放在src/main/resource里)

然后输入Package的名字.

创建完毕后,这个Package今后将用于放置你的代码.

创建一个Mod主类
Mod主类是负责进行Mod的初始化,并且可以被Forge所识别的一个类(Class).
关于Mod主类的命名,在ModLoader时代,它的名字必须以"mod_"开头,但在Forge中它叫什么都可以.所以我将其命名为Diracon.
在你的package中创建一个类.(右键你的package,选择New->Class)

点击Finish开始创建,创建完后我们便有了一个空荡荡的文件,我们要让它能被Forge找到,方法是为类添加一段Annotation.

Annotation是Java的一种增强型注释,它和普通注释(双斜杠)的区别是,普通注释在编译阶段就会被删除,而Annotation会保留下,Annotation能储存数据,能在程序运行阶段通过某些方法(如反射)被读取.

在public class Diracon的上一行添加:

@Mod(modid="diracon", name="Diracon", version="1.0.0")

知识点:@Mod
///////////////////////////////////////////////////////////////////////////////////////////////////////////
@Mod必须标注在类的上方,它的含义是告诉Forge"这是一个Mod主类".
它有1个必要参数是字符串类型的modid,代表Mod的id号,它将用于内部识别,请确保它不包含特殊字符,并且不会经常变动,还有一个忠告,确保它是全小写.此外还有一系列可选参数,比如name是显示给玩家看的Mod名;version是版本号,对于联机Mod来说不要乱填,保守的话A.B.C这样的格式肯定是没问题的,其中ABC均为数字,A代表主版本号,B代表次版本号,C是没有功能性更新,纯粹是Bug紧急修复时递增的版本号.如果想更简单的话可以只留A.B两位,再懒一些的话哪怕单独一个数也行,主要能用于区分开新旧版本就行.关于version格式的具体要求可以见扩展阅读"@Mod的各个参数".
在过去,还有一个叫@NetworkMod的注解,但它在1.7中被去除了.想了解它的替代品可以看这里.
关于@Mod的其他参数,可以见本篇的扩展阅读.
///////////////////////////////////////////////////////////////////////////////////////////////////////////

之后静等两秒,你的Eclipse就开始报错了...因为你没有导入相关的package,将鼠标移到红波浪线上,等提示框出来后选择"Import ..."来自动导入相关package.

此时你的mod大概是这样子.

之后我们要添加用于初始化Mod的方法(Method,不理解的自行补Java...)在ModLoader时代,我们通过重写(Override)基类的方法来实现,现在没有基类了,所以我们使用Annotation来实现.

在你的类中添加这些代码.

@EventHandler
public void preLoad(FMLPreInitializationEvent event)
{
}

@EventHandler
public void load(FMLInitializationEvent event)
{
}

@EventHandler
public void postLoad(FMLPostInitializationEvent event)
{
}

知识点:@EventHandler与历史的伤痕
///////////////////////////////////////////////////////////////////////////////////////////////////////////
看上去这个标题很严肃...事实上是我为了搞笑故意起的...
如果你是个老Modder(MC1.6版以前就开始做Mod)那么你应该记得那时Forge没有@EventHandler这个注解,取而代之的是@Init,@PreInit和@PostInit这三个分工详细的注解.
在最初的ModLoader时代,所有的Mod主类都通过重写load方法来实现初始化,到了ForgeModLoader后,Forge(最初)通过带有@Init的方法来实现初始化,同时它还提供了@PreInit(初始化前)和@PostInit(初始化后)两个方法来为初始化扫清障碍或收尾.
然而现在FML使用@EventHandler来泛指所有参与Mod初始化工作的方法,区分这些方法的唯一方式是它们的参数,根据他们的参数的类型,FML会利用事件系统在不同的时段调用他们.

FMLPreInitializationEvent 预初始化
CPW建议开发者在预初始化时进行读取配置,创建物品砖块,以及注册相关信息等操作,另外你还能在这时候获得FML给你传来的配置文件.(Configuration,但是我并不太愿意在基础篇讲这个东西...)
从1.7开始,砖块和物品的初始化必须在这个阶段进行!
FMLInitializationEvent 初始化
配置Mod设置,添加合成表...另外CPW建议Mod间通讯(通过FMLInterModComms类完成)应当在此时进行.
FMLPostInitializationEvent 初始化后
CPW认为初始化后是供Mod间相互交互的时候,此时该载入的Mod都已经载入了,因此开发者们可以在此时为实现Mod间联动的操作做准备.顺便一提,FMLPostInitializationEvent事件的buildSoftDependProxy方法可以获取一个类的实例,它会先判断你要求的mod是否存在,如果存在则返还给你你要求的类的实例.
IMCEvent 接收Mod间通讯
这个事件会排在FMLInitializationEvent之后,它会附带一个保存着其他Mod发来的信息的列表.

此外,还有几个服务器事件,但这个就不在基础篇的范围内了...(其实是我急着去玩Civ5懒得继续码字了)以后我会单开一个篇幅讲.
///////////////////////////////////////////////////////////////////////////////////////////////////////////

然后导入相关的包,你的第一个Mod就已经能运行了...保存,选择Run - Client开始运行吧!

于是就是这样...你的第一个Mod已经能被载入了,虽然它还什么都没有,但千里之行始于足下,你已经走出了第一步,不是吗?
(好奇为什么我的Minecraft Forge旁边有个绿点?因为我现在用的是测试版的Forge...当你开发Mod时应该已经有稳定版了)

扩展阅读

最初我计划将一些更深入的东西写在单独的章节里,但总是感觉有些突兀,而且有些东西往往不足以写成一篇单独的文章,再考虑到很多好♂学的人希望能立刻读到这些内容,因此便有了扩展阅读,扩展阅读的内容往往高于甚至远高于基础篇的内容,属于选读部分.