ConfigurationManager

Configuration Manager

A forked version of BepInEx's in-game configuration manager, allowing you to easily change mod configurations directly within the game.

The default hotkey to open or close the menu is Ctrl+F1. This can be changed in the config manager itself.

Note: Some mods still require restarting the game to apply the changes.

This is a forked version of the BepInEx in-game configuration manager that allows you to easily change mod configurations directly within the game.

The default hotkey for opening or closing menus is Ctrl+F1. This can be changed in Configuration Manager itself.

Note: Some modules still require restarting the game for the changed configuration to take effect.

Changes from the original

This fork version of BepInEx.ConfigurationManager is for use with Dyson Sphere Program. It was forked from version 17.0 to make it works with BepInEx v5.4.17.

The changes from the original version are as follows:

• Window is draggable and resizable
• Background colors are customizable
• Text size and color are customizable
• Change the close behavior from clicking outside of window to top-left close button and hotkey
• Configuration Manager settings are changeable within the manager itself

UI layout changes:

• English and Chinese localization switch
• Button to open BepInEx log and Unity log in Debug mode
• Left and right buttons beside plugin name to reload the config and open the config file

Differences from the original version

This forked version of BepInEx.ConfigurationManager is used by the Dyson Sphere Project. It was forked from version 17.0 to make it work with BepInEx v5.4.17.

Compared with the original version, the changes are as follows:

• Window can be dragged and resized
• Background color can be customized
• Customizable text size and color
• Close behavior changed from clicking outside the window to the close button and hotkey in the upper left corner
• Configuration manager settings can be changed inside the manager

UI layout changes:

• English-Chinese localization switching
• Button: In debug mode, you can open BepInEx log and Unity log
• Left and right buttons next to the plugin name: for reloading configuration and opening configuration files

Original README

Plugin / mod configuration manager for BepInEx 5

An easy way to let user configure how a plugin behaves without the need to make your own GUI. The user can change any of the settings you expose, even keyboard shortcuts.

The configuration manager can be accessed in-game by pressing the hotkey. Hover over the setting names to see their descriptions, if any.

Note: The.xml file is useful for plugin developers when referencing ConfigurationManager.dll in your plugin, it will provide descriptions for types and methods to your IDE. Users can ignore it.

How to make my mod compatible?

ConfigurationManager will automatically display all settings from your plugin's Config. All metadata (e.g. description, value range) will be used by ConfigurationManager to display the settings to the user.

In most cases you don't have to reference ConfigurationManager.dll or do anything special with your settings. Simply make sure to add as much metadata as possible (doing so will help all users, even if they use the config files directly). Always add descriptive section and key names, descriptions, and acceptable value lists or ranges (wherever applicable).

How to make my setting into a slider?

Specify AcceptableValueRange when creating your setting. If the range is 0f - 1f or 0 - 100 the slider will be shown as % (this can be overridden below).

CaptureWidth = Config.AddSetting("Section", "Key", 1, new ConfigDescription("Description", new AcceptableValueRange(0, 100)));

How to make my setting into a drop-down list?

Specify AcceptableValueList when creating your setting. If you use an enum you don't need to specify AcceptableValueList, all of the enum values will be shown. If you want to hide some values, you will have to use the attribute.

Note: You can add Sy …