StarForce_HybridCLR 使用教程

1. 项目介绍

StarForce_HybridCLR 是一个基于 HybridCLR 的开源项目，旨在为 StarForce 游戏框架实现游戏逻辑的热更新。HybridCLR 是一个特性完整、零成本、高性能、低内存的近乎完美的 C# 热更新方案。通过 StarForce_HybridCLR，开发者可以将热更新的 DLL 文件拷贝至 Assets 目录下，用于 Resource 模块资源编辑与打包，从而实现游戏逻辑的热更新。

2. 项目快速启动

2.1 环境准备

• Unity 版本：建议使用 Unity 2019.4 及以上版本。
• HybridCLR 工具：确保已安装 HybridCLR 工具。

2.2 项目导入

1. 克隆或下载 StarForce_HybridCLR 项目到本地：

   git clone https://github.com/GREAT1217/StarForce_HybridCLR.git
   

2. 打开 Unity，导入 StarForce_HybridCLR 项目。

2.3 配置热更新

1. 在 Unity 项目中，创建一个新的 C# 脚本 HotfixManager.cs，并添加以下代码：

   using HybridCLR.Runtime.Enviorment;
   using System.IO;
   using UnityEngine;
   
   public class HotfixManager : MonoSingleton<HotfixManager>
   {
       private AppDomain m_AppDomain = null;
   
       public void LoadHotfixAssembly(byte[] assBytes, byte[] pdbBytes)
       {
           if (m_AppDomain == null)
           {
               m_AppDomain = new AppDomain();
           }
           using (MemoryStream ms = new MemoryStream(assBytes))
           {
               using (MemoryStream pdb = new MemoryStream(pdbBytes))
               {
                   m_AppDomain.LoadAssembly(ms, pdb, new Mono.Cecil.Pdb.PdbReaderProvider());
               }
           }
           m_AppDomain.Invoke("Hotfix", "Init", null, null);
       }
   
       public T Invoke<T>(string typeName, string methodName, object instance, params object[] args)
       {
           var type = m_AppDomain.LoadedTypes[typeName];
           var method = type.GetMethod(methodName);
           if (method == null)
           {
               Debug.LogError($"Can't find method: {methodName} in type: {typeName}");
               return default(T);
           }
           return (T)method.Invoke(instance, args);
       }
   }
   

2. 创建一个新的 C# 脚本 Hotfix.cs，并添加以下代码：

   public static class Hotfix
   {
       public static void Init()
       {
           Debug.Log("Hotfix Init");
       }
   
       public static int Add(int a, int b)
       {
           return a + b;
       }
   }
   

3. 在 Unity 中打包项目，生成 DLL 文件。

4. 使用 HybridCLR 工具将 DLL 文件转换成 bytes 和 pdb 文件。

5. 加载 bytes 和 pdb 文件到热更新管理器中：

   var hotfixManager = HotfixManager.Instance;
   hotfixManager.LoadHotfixAssembly(assBytes, pdbBytes);
   

6. 调用热更新代码：

   var hotfixManager = HotfixManager.Instance;
   int result = hotfixManager.Invoke<int>("Hotfix", "Add", null, 1, 2);
   Debug.Log(result);
   

3. 应用案例和最佳实践

3.1 应用案例

• 游戏逻辑热更新：通过 StarForce_HybridCLR，开发者可以在不重新发布游戏的情况下，更新游戏逻辑，修复 bug 或添加新功能。
• 资源热更新：结合 GameFramework 的 Resource 模块，实现资源的热更新，提升用户体验。

3.2 最佳实践

• 模块化开发：将游戏逻辑拆分为多个模块，每个模块独立开发和热更新，降低耦合度。
• 版本管理：使用版本控制系统（如 Git）管理热更新代码，确保代码的可追溯性和稳定性。

4. 典型生态项目

• GameFramework：一个基于 Unity 的通用游戏框架，提供了游戏开发中常用的框架基础模块。
• HybridCLR：一个特性完整、零成本、高性能、低内存的近乎完美的 C# 热更新方案。

通过结合 StarForce_HybridCLR 和这些生态项目，开发者可以快速构建和维护高质量的游戏项目。