YAPYAP MOD 通用配置框架 (ModConfigManager)

制作：哔哩哔哩-华丽的小柠檬

这是一个为 YAPYAP 开发的通用配置管理框架，旨在为 MOD 开发者提供一个统一、美观且易用的 UI 界面，让玩家可以直接在游戏中修改各个 MOD 的 BepInEx 配置项，而无需手动编辑 .cfg 文件。

功能特性

• 即时生效：在 UI 中修改数值后点击“保存”即可实时应用配置（需 MOD 支持）。
• 多语言支持：界面支持中英双语，并可根据游戏语言自动切换。
• 数值自定义：支持布尔值、数字（滑块/输入框）、枚举（下拉菜单）等多种类型。
• 重置功能：支持单个配置项独立重置为默认值。
• 悬浮提示：鼠标悬停在配置项上可实时读取并显示配置文件中的描述信息。
• 调试模式：内置双语调试日志系统，方便开发者调试。

开发者使用指南 (Developer API)

如果你希望你的 MOD 能更好地适配本框架，或者需要根据配置界面的显示状态调整 MOD 逻辑：

1. 添加引用与依赖

   • 将 ModConfigManager.dll 添加到你的 C# 项目引用（Reference）中。
   • 在你的插件类（继承自 BaseUnityPlugin）上声明硬依赖：

     [BepInDependency("com.hali.yapyap.modconfigmanager")]
     

2. 自动扫描机制

   • 本框架会自动扫描所有继承自 BaseUnityPlugin 的 MOD，并提取其通过 Config.Bind() 注册的所有配置项。
   • 建议为你的配置项提供清晰的 Description（支持中英双语，建议格式："中文描述 | English Description"），框架会自动解析并作为悬浮提示显示。

3. 监听配置变更

   • 为了实现“即时生效”而不必重启游戏，建议监听配置项的变更事件：

     var myConfig = Config.Bind("General", "Speed", 1.0f, "移动速度");
     myConfig.SettingChanged += (sender, args) => {
         // 在这里编写配置变更后的逻辑
         Debug.Log("配置已更新！");
     };
     

4. 判断 UI 是否显示

   • 如果你的 MOD 在配置时需要暂停某些逻辑（如屏蔽游戏输入），可以通过以下属性判断：

     if (ModConfigManager.ModConfigManager.IsUIShown) {
         // UI 正在显示，执行相关逻辑
     }
     

5. 手动刷新 MOD 列表

   • 正常情况下框架会自动处理。如果你有动态加载 MOD 的需求，可以通过 ModConfigUI.Instance.RefreshModList() 手动触发 UI 刷新。

安装方法 (玩家)

1. 安装 BepInEx。
2. 将 ModConfigManager.dll 放入 BepInEx/plugins 文件夹。
3. 进入游戏主菜单，点击左下角的 MOD 配置 按钮即可打开界面。

YAPYAP Universal Mod Config Framework (ModConfigManager)

Created by: Bilibili - 华丽的小柠檬

A universal configuration management framework for YAPYAP mods. It provides a unified, clean, and user-friendly UI for mod developers, allowing players to modify BepInEx configurations directly in-game without manual .cfg file editing.

Features

• Instant Apply: Real-time configuration updates after clicking "Save" (requires mod support).
• Multilingual Support: Supports Chinese and English, automatically switching based on game language.
• Customizable Values: Supports booleans, numbers (sliders/input fields), enums (dropdowns), and more.
• Reset Function: Independent reset buttons for individual configuration entries.
• Tooltips: Real-time display of descriptions from the config file on mouse hover.
• Debug Mode: Built-in bilingual debug logging system for developers.

Developer API Guide

To better integrate your mod with this framework or adjust logic based on the UI state:

1. Add Reference & Dependency

   • Add ModConfigManager.dll to your C# project references.
   • Declare a hard dependency in your BaseUnityPlugin class:

     [BepInDependency("com.hali.yapyap.modconfigmanager")]
     

2. Automatic Scanning

   • The framework automatically scans all BaseUnityPlugin mods and extracts all entries registered via Config.Bind().
   • Provide clear Description for your entries (supports bilingual format: "Chinese Description | English Description").

3. Listen for Changes

   • For instant application without restarts, listen to the SettingChanged event:

     var myConfig = Config.Bind("General", "Speed", 1.0f, "Move Speed");
     myConfig.SettingChanged += (sender, args) => {
         // Your logic here
     };
     

4. Check UI Visibility

   • To pause logic or block inputs when the config UI is open:

     if (ModConfigManager.ModConfigManager.IsUIShown) {
         // UI is open
     }
     

Installation (Players)

1. Install BepInEx.
2. Place ModConfigManager.dll into the BepInEx/plugins folder.
3. In the main menu, click the MOD CONFIG button at the bottom left to open the UI.

Powered by ModConfigManager Framework | 制作：哔哩哔哩-华丽的小柠檬