黑神话悟空CSharp加载器

English

关于

黑神话悟空使用USharp作为脚本引擎，很多逻辑使用charp实现，提供接口给UE使用(见GameDll)，而一些内部接口不能通过UE c++/lua访问。
这个mod加载器可以加载c#写的mod。C# mod可以调用USharp端提供的api，包括游戏内部的和USharp包装的UE引擎的api，也可以往游戏内部的事件和委托增加回调。

使用说明

安装路径

BlackMythWukong/b1/Binaries/Win64/
  CSharpLoader/
    Data/
    Mods/
    0Harmony.dll
    CSharpManager.bin
    CSharpModBase.dll
    Mono.Cecil.dll
    Mono.Cecil.Pdb.dll
    Mono.Cecil.Rocks.dll
    b1cs.ini
  hid.dll

如果安装后游戏闪退，尝试把hid.dll改名成version.dll

mod的dll需要放在CSharpLoader/Mods/<ModName>/<ModName>.dll里面，例如CSharpLoader/Mods/CSharpExample/CSharpExample.dll

配置

配置文件CSharpLoader/b1cs.ini Develop: 开启开发模式，可以按ctrl+f5重新加载C# mods Console: 显示控制台窗口，打印log

模块介绍

• CSharpLoaderDll
  • 加载器，用于调用mono api执行C#代码，加载器会在游戏启动后调用CSharpManager
• CSharpManager
  • C# mod管理器，加载和管理C# mod
• CSharpModBase
  • 提供给mod使用的接口
• CSharpModExample
  • mod示例
• GameDll
  • 游戏内的C# dll，写mod代码需要引用这些dll

mod编写教程

建议安装.net 8 sdk，方便使用最新的语法。 开发工具可以使用vscode, visual studio 或者 rider。 示例工程可以参考CSharpModExample

mod入口

mod的类需要实现ICSharpMod接口

public class MyMod : ICSharpMod
{
    public string Name => "ModExample";
    public string Version => "0.0.1";

    public void Init()
    {
        Console.WriteLine("Init");
    }

    public void DeInit()
    {
        Console.WriteLine("DeInit");
    }
}

Mod加载时会创建该类的实例，调用Init。Manager重新加载mod时会调用每个mod的DeInit()，再执行加载mod的流程。
Ctrl+F5重新加载Mod，Develop模式下，每次都会加载成新的Assembly，旧Asembly还会保留在进程中，所以请确保DeInit函数里结束mod的后台线程（如有）和事件监听，mod本身不用清理按键监听，Manager处理好。

按键监听

Utils.RegisterKeyBind(ModifierKeys.Alt, Key.X, () =>
{

});

C# hook (Patch)

还未实现

mod的其他依赖

mod dll的依赖可以放在CSharpLoader/Mods/<ModName>/或者CSharpLoader/Mods/Common/中，这样其他Mod也能用里面的依赖