一. HelloWorld
打开VS,我们新建一个.Net Framework类库项目,框架版本选择4.5,这是一个非常通用的版本。项目名称命名为HelloUMM。
建好项目之后,我们先给默认的类Class1改个名字,我一般习惯用Main作为主体,你也可以选择使用别的名字。
然后我们要为Mod项目添加引用,主要是引用一些常用的东西,在解决方案资源管理器,右键引用->添加引用,选择浏览->浏览,然后找到游戏文件夹下存放AC的位置,我们主要引用以下库。
- Assembly-CSharp.dll
- UnityEngine.dll
- UnityEngine.CoreModule.dll
- UnityEngine.IMGUIModule.dll
- UnityEngine.UI.dll
- UnityEngine.UIElementsModule.dll
- UnityEngine.UIModule.dll
还有UnityModManager文件夹下的: - 0Harmony12.dll
- UnityModManager.dll
这些是比较常用的dll,如果你还想做其他的,比如物理,就可以引用UnityEngine.PhysicsModule.dll,做AB包加载就引用UnityEngine.AssetBundleModule.dll,按需添加。
然后我们全选所有引用,把属性里的复制本地改为False,这样在编译的时候不会把引用的dll都复制到输出目录。
添加之后,我们来写第一个函数,为了加载我们的mod,我们需要一个入口函数,这里我写作Load。using一下UMM的命名空间UnityModManagerNet,然后创建如下函数:
using UnityModManagerNet;
namespace HelloUMM
{
public static class Main
{
public static bool Load(UnityModManager.ModEntry modEntry)
{
return true;
}
}
}
Load函数有一个参数modEntry,这是mod的入口,我们返回true通知管理器加载成功了。接下来,我们添加一个日志。
using UnityModManagerNet;
namespace HelloUMM
{
public static class Main
{
public static bool Load(UnityModManager.ModEntry modEntry)
{
modEntry.Logger.Log("Hello MyMod");
return true;
}
}
}
这样我们第一个Mod的逻辑就写完了,但是现在编译我们的mod的话,游戏并不能加载,记不记得上一节我们添加的配置中,有一个标签叫ModInfo<ModInfo>Info.json</ModInfo>
?是的,我们需要给Mod准备一个说明文件来让UMM知道如何加载我们的Mod。
我们为当前项目添加一个新建项,在Web分类下找到JSON文件,修改名字为info.json,添加然后写下如下配置。
{
"Id": "HelloUMM",
"DisplayName": "我的第一个Mod",
"Author": "xiaoye97",
"Version": "1.0.0",
"AssemblyName": "HelloUMM.dll",
"EntryMethod": "HelloUMM.Main.Load"
}
Id就是Mod的唯一ID,不应该与其他mod相重复。DisplayName就是在游戏中显示的Mod名字,作者和版本号顾名思义,就不在介绍,AssemblyName是我们程序集的名称,如果我们没有多做修改的话,程序集的名称就是我们项目的名称,所以我们写HelloUMM.dll,EntryMethod就是我们重要的入口函数,我们写上我们刚才创建的Load函数即可。
在解决方案管理器中选中我们的info.json,在下面的属性栏找到"复制到输出目录",改成"如果较新则复制",这样info文件就会在我们编译的时候一起输出。
到此为止,我们的工作就完成了,现在选择生成->生成HelloUMM来编译我们的Mod,然后打开输出的文件夹,找到我们的HelloUMM.dll和info.json,复制,然后在游戏文件夹里的Mods文件夹下,新建一个文件夹叫做HelloUMM,然后把我们的两个文件粘贴到里面。
打开游戏,如果没有意外,UnityMod管理面板上已经显示了我们的Mod,打开Logs查看日志,也能够找到我们输出的Hello MyMod。