Unity游戏Mod制作教程：配置文件热加载实战指南

蝼蚁梦

9个月前发布

160

导言： 在Unity游戏Mod制作过程中，实现配置文件的热加载是一个关键的技巧，它使得我们在调试和优化过程中能够实时更新配置，提高开发效率。本教程将介绍如何使用C#和BepInEx框架在Unity游戏中实现配置文件的热加载。

目标读者：

已有基础的C#编程知识。
对Unity游戏Mod制作有一定了解。

步骤一：项目准备 首先，确保你已经创建了一个基于BepInEx框架的Unity Mod项目。如果还没有，可以参考相关教程搭建环境。

步骤二：配置文件热加载的重要性 在游戏开发中，调试过程中配置的频繁修改是常见的需求。而配置文件热加载能够让我们在游戏运行时实时更新配置，避免了频繁重启游戏的繁琐过程。

步骤三：代码实现

using BepInEx;
using HarmonyLib;
using System;
using UnityEngine;
using BepInEx.Configuration;
using System.IO;
using System.Threading;
using System.Security.Cryptography;
using System.Collections.Generic;
using System.Linq;

namespace YourNamespace
{
    [BepInPlugin(GUID, NAME, VERSION)]
    public class YourPluginClass : BaseUnityPlugin
    {
        internal const string GUID = "your.unique.GUID";
        internal const string NAME = "你的插件名称";
        internal const string VERSION = "1.0";
        internal readonly static string configFile = GUID + ".cfg";
        internal static ConfigEntry<bool> debuglog;

        public void Awake()
        {
            debuglog = Config.Bind("全局", "调试模式", false, "开启将显示调试日志");
            SetupWatcher();//配置文件热加载
        }

        private void SetupWatcher()
        {
            FileSystemWatcher watcher = new FileSystemWatcher(Paths.ConfigPath, configFile);
            watcher.Changed += ReadConfigValues;
            watcher.Created += ReadConfigValues;
            watcher.Renamed += ReadConfigValues;
            watcher.IncludeSubdirectories = true;
            watcher.SynchronizingObject = ThreadingHelper.SynchronizingObject;
            watcher.EnableRaisingEvents = true;
        }

        private void ReadConfigValues(object sender, FileSystemEventArgs e)
        {
            if (!File.Exists(Paths.ConfigPath + Path.DirectorySeparatorChar + configFile)) return;
            try
            {
                Config.Reload(); // 重新加载配置
            }
            catch
            {
                Debug.LogError($"加载 {configFile} 文件时出现问题");
                Debug.LogError("请检查配置项的拼写和格式！");
            }
        }
    }
}

步骤四：教程解读

导入必要的命名空间： 使用using语句导入所需的命名空间，确保能够正常使用相关类和方法。
配置文件路径设置： 使用internal readonly static string configFile定义配置文件的路径，确保路径正确。
配置项设置： 在Awake方法中使用Config.Bind创建配置项，这里我们创建了一个布尔类型的配置项用于控制调试模式。
文件监视器设置： SetupWatcher方法中创建了一个FileSystemWatcher，监听配置文件所在目录的变化。当配置文件发生变化时，调用ReadConfigValues方法。
热加载方法： ReadConfigValues方法中通过Config.Reload()重新加载配置，实现热加载的效果。