如何在 BepInEx 插件中向使用 FMOD 的 Unity 游戏中导入新的音频

目标游戏：https://store.steampowered.com/app/416680/Zombie_Night_Terror/

Bank 文件

Bank 文件是 FMOD 的音频打包文件。
大多数游戏 MOD 是通过直接替换其内容来实现效果的，但这会丢失原版的音频。
本文研究的是通过 FMOD 的 API 加载额外的 Bank 文件。

首先，大多数游戏会将音频打包为

Master Bank.bank
Master Bank.strings.bank
XXX.bank
...

这样的形式，其中：

• Master Bank 是主包，会打包 Event Bus 等内容
• Master Bank.strings 是索引包，将 guid 和 path 关联起来
• XXX.bak 是从包，只会打包 Event 内容

PS: 实际上 Master Bank 可以改成其他名字，但主包一定会有 对应的 strings.bank 索引

对于一个游戏而言，FMOD 模块只能有一个主包，因为主包里必然有 bus:/ 这个 Root Bus 。
而所有 FMOD 资源对象的 path 和 guid 都是唯一的。
再加载一个主包会因为 bus:/ 报错，所以新的音频只能在新从包中加载。
对于 Root Bus , 你可以通过以下代码获取 GUID，之后会用到

FMODUnity.RuntimeManager.StudioSystem.getBus("bus:/", out var root);
root.getID(out var id);
Logger.LogWarning(id);

确定 FMOD 版本

在 znt_Data\Plugins\ 下找到 fmodstudio.dll。
右键属性详 -> 详细信息 -> 产品版本
可知版本为 1.10.13
到 https://www.fmod.com/download 下载对应版本 FMOD Studio

制作 Bank 文件

1. FMOD Studio 新建项目
2. 修改主包 Master Bank 的名字，要和游戏自带的包不一样
3. 新建从包，名字也要要和游戏自带的包不一样
4. 将音频导入项目，制作 Event, 放入从包, 注意只能放入从包, 原因上文说过
5. 保存关闭项目
6. 打开项目下的 Metadata/Master.xml 文件，获取 Master Bus 的 GUID, <object class="MixerMaster" id="{...}">
7. 用上文中提到的 Root Bus 的 GUID 将项目中所有 xml 文件中的 Master Bus 的 GUID 替换掉
8. F7 打包文件

PS: 第 6 步 和 第 7 步 一定要完成，不然项目打包出来的 Bank 文件 的 Root Bus 的 GUID 对不上，会导致加载后新音频没有输出

加载 Bank 文件

有两种方式：

• 从 znt_Data/StreamingAssets 下文件中加载 FMODUnity.RuntimeManager.LoadBank(bankName: ..., loadSamples: true)
• 从 TextAsset 中加载 FMODUnity.RuntimeManager.LoadBank(asset: ..., loadSamples: true)

将制作好的 索引包 和 从包 加载，注意不要加载主包。
加载之后如果游戏有资源索引，还需要手动添加索引。

以下是 ZNT 添加索引的代码示例，仅供参考，path 的内容是 bank:/{bank_name}

public static Dictionary<string, FMODAsset> FetchFMODAsset(string path)
{
    var result = RuntimeManager.StudioSystem.getBank(path, out var bank);
    if (!bank.isValid()) throw new BankLoadException(path, result);
    result = bank.getEventList(out var events);
    if (events == null) throw new BankLoadException(path, result);
    var dictionary = new Dictionary<string, FMODAsset>(events.Length);
    foreach (var description in events)
    {
        var asset = ScriptableObject.CreateInstance<FMODAsset>();

        description.getID(out var guid);
        asset.id = "{" + guid + "}";
        description.getPath(out asset.path);
        Traverse.Create(asset).Field("assetId").SetValue(guid.ToString());

        lock (typeof(FmodAssetIndex))
        {
            FmodAssetIndex.Index.AddAssetElement(asset);
            Traverse.Create(typeof(FmodAssetIndex)).Field("pathIndex").SetValue(null);
        }

        dictionary.TryAdd(asset.path, asset);
    }

    return dictionary;
}