BepInEx ab 包导入

BepInEx 是 unity mod 的一个框架,可以很方便地给 unity 游戏打 mod,也可以基于这个框架给游戏写 mod。这里默认读者已经入门了 BepInEx mod 开发,讲一讲 ab 包导入踩的一些坑。如果不了解的话,建议先去看宵夜大佬的入门教程。本文中,创建 ab 包过程和宵夜的视频过程基本一致,建议读者跟着视频来,更直观。

新建项目

首先是新建 BepInEx 项目。除了官方提供的方法,也可以手动创建(其实是因为基于模板创建项目,在我电脑无效)。

  1. 新建项目->类库,目标框架选择游戏的.net 平台版本,后续 unity 和 BepInEx 的引用都在 nuget 里面进行就好。
  2. 项目创建完成后,打开 nuget 管理器,在设置中添加程序包源:BepInEx(https://nuget.bepinex.dev/v3/index.json)。
  3. 回到 nuget 管理器,搜索 BepInEx,可以看到 BepInEx.Core,安装。
  4. 搜索 UnityEngine,可以看到 UnityEngine.Modules,安装的时候选择对应的版本,如 2021.3.30。
  5. Assembly-CSharp.dll复制到项目文件夹下并引用。如果要用 ui 库,也需要复制UnityEngine.UI.dll。注意,如果引用了UnityEngine.UI.dll,那么项目的.net 平台版本必须和游戏一致,否则会提示netstandard.dll版本不对。
  6. 至此,项目初始化完成。

创建 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 包

  1. 将前面生成的 ab 包复制到 BepInEx 项目中来,在文件的属性中,设置生成操作为“嵌入的资源”。
  2. 记录文件路径,如我的项目名称是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后大小信息也无法恢复了。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,372评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,368评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,415评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,157评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,171评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,125评论 1 297
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,028评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,887评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,310评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,533评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,690评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,411评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,004评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,659评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,812评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,693评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,577评论 2 353

推荐阅读更多精彩内容