BepInEx 是 unity mod 的一个框架,可以很方便地给 unity 游戏打 mod,也可以基于这个框架给游戏写 mod。这里默认读者已经入门了 BepInEx mod 开发,讲一讲 ab 包导入踩的一些坑。如果不了解的话,建议先去看宵夜大佬的入门教程。本文中,创建 ab 包过程和宵夜的视频过程基本一致,建议读者跟着视频来,更直观。
新建项目
首先是新建 BepInEx 项目。除了官方提供的方法,也可以手动创建(其实是因为基于模板创建项目,在我电脑无效)。
- 新建项目->类库,目标框架选择游戏的.net 平台版本,后续 unity 和 BepInEx 的引用都在 nuget 里面进行就好。
- 项目创建完成后,打开 nuget 管理器,在设置中添加程序包源:BepInEx(https://nuget.bepinex.dev/v3/index.json)。
- 回到 nuget 管理器,搜索 BepInEx,可以看到 BepInEx.Core,安装。
- 搜索 UnityEngine,可以看到 UnityEngine.Modules,安装的时候选择对应的版本,如 2021.3.30。
- 将
Assembly-CSharp.dll
复制到项目文件夹下并引用。如果要用 ui 库,也需要复制UnityEngine.UI.dll
。注意,如果引用了UnityEngine.UI.dll
,那么项目的.net 平台版本必须和游戏一致,否则会提示netstandard.dll
版本不对。 - 至此,项目初始化完成。
创建 ab 包
新建 unity 项目,unity 版本必须和游戏一致。由于是创建 ab 包,不是打包游戏,所以只能用脚本打包。脚本如下:
using System.IO;
using UnityEditor;
using UnityEngine;
public class BuildCmd : MonoBehaviour
{
[MenuItem("tools/build")]
public static void Build()
{
var outputPath = "AB";
if (!Directory.Exists(outputPath))
{
Directory.CreateDirectory(outputPath);
}
BuildPipeline.BuildAssetBundles(outputPath, BuildAssetBundleOptions.None, BuildTarget.StandaloneWindows64);
}
}
这个文件必须放在Assets/Scripts/Editor
文件夹下,否则 unity 会识别成游戏脚本,不会在编辑器中执行。
放好文件后,在 unity 菜单中就会出现一个 tools,点击有个 build 命令。此时直接执行会报错,因为我们还没有创建我们需要的 ab 包。
在场景中添加一个图片和一个文本框,做成 prefabs,命名为first
。在first
的属性里面找到Asset Labels
,添加AssetBundle
,命名为hello
。
此时,再执行 build 命令时就不会报错了,会在项目根目录下生成AB/hello
文件。这就是我们需要的 ab 包了。如果在这个过程中有不明白的,建议看文章开头的视频,更直观。
BepInEx 项目导入 ab 包
- 将前面生成的 ab 包复制到 BepInEx 项目中来,在文件的属性中,设置生成操作为“嵌入的资源”。
- 记录文件路径,如我的项目名称是
abtest
,ab 包路径在lib/hello
,那么 ab 包完整路径就是abtest.lib.hello
,我们可以在框架中使用了。
关键代码如下:
var canvas = GameObject.FindFirstObjectByType<Canvas>().transform;
Assembly assembly = Assembly.GetExecutingAssembly();
var steam = assembly.GetManifestResourceStream("abtest.lib.hello");
var ab = AssetBundle.LoadFromStream(steam);
if (ab != null)
{
var go = ab.LoadAsset<GameObject>("first");
if (go != null)
{
var n = GameObject.Instantiate(go);//必须要重新创建才能正常使用,原始的 go 对象不能直接使用
n.transform.SetParent(canvas);
}
}
这样,first
这个 prefabs 就会出现在游戏中了。
注意:prefabs 里面依赖的资源会自动打包在一起,如图片和字体,但是脚本是独立的,不会一起打包进去。所以建议 ab 包中只处理布局和资源文件,所有脚本在 BepInEx 项目中添加。另外,prefabs 根节点自适应是无效的。如果设置的 prefabs 是一张全屏的图片,那么 mod 加载进去后什么都看不到。推测是在LoadFromStream
环节,节点就会加载在场景中,但是没有大小信息,导致自适应失效。在Instantiate
后大小信息也无法恢复了。