ModConfigManager

YAPYAP MOD universal configuration framework (ModConfigManager)

Produced by: Bilibili-Gorgeous Little Lemon

This is a universal configuration management framework developed for YAPYAP. It aims to provide MOD developers with a unified, beautiful and easy-to-use UI interface, allowing players to modify the BepInEx configuration items of each MOD directly in the game without manually editing the .cfg file.

Features

• Effective immediately: After modifying the value in the UI, click "Save" to apply the configuration in real time (requires MOD support).
• Multi-language support: The interface supports Chinese and English bilingual, and can automatically switch according to the game language.
• Numeric customization: supports Boolean values, numbers (slider/input box), enumerations (drop-down menus) and other types.
• Reset function: Supports independent reset of individual configuration items to default values.

-Hover prompt: Hover the mouse over the configuration item to read and display the description information in the configuration file in real time.

• Debug mode: Built-in bilingual debugging log system to facilitate developer debugging.

Developer API

If you want your MOD to better adapt to this framework, or you need to adjust the MOD logic according to the display status of the configuration interface:

• Add references and dependencies
• Add ModConfigManager.dll to your C# project Reference.
• Declare hard dependencies on your plugin class (inherited from BaseUnityPlugin):

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

• Automatic scanning mechanism
• This framework will automatically scan all MODs inherited from BaseUnityPlugin and extract all configuration items registered through Config.Bind().
• It is recommended to provide a clear Description for your configuration items (supports Chinese and English bilingual, recommended format: "Chinese Description | English Description"), the framework will automatically parse it and display it as a floating prompt.

• Monitor configuration changes
• In order to achieve "immediate effect" without restarting the game, it is recommended to monitor the change event of configuration items:

var myConfig = Config.Bind("General", "Speed", 1.0f, "Moving Speed");

myConfig.SettingChanged += (sender, args) => {

//Write the logic after configuration changes here

Debug.Log("Configuration has been updated!");

};

• Determine whether the UI is displayed
• If your MOD needs to suspend certain logic during configuration (such as blocking game input), you can judge by the following properties:

if (ModConfigManager.ModConfigManager.IsUIShown) {

// The UI is being displayed and relevant logic is executed.

}

• Manually refresh the MOD list
• Under normal circumstances the framework will handle it automatically. If you need to dynamically load MOD, you can manually trigger UI refresh through ModConfigUI.Instance.RefreshModList().

Installation method (player)

• Install BepInEx.
• Place ModConfigManager.dll into the BepInEx/plugins folder.
• Enter the main menu of the game and click the MOD Configuration button in the lower left corner to open the interface.

YAPYAP Universal Mod Config Framework (ModConfigManager)

Created by: Bilibili - Gorgeous little lemon

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 bi …