shudnal-ConfigurationManager icon

ConfigurationManager

Localized, recolored, refined. Split view mode. Config files editor. Setting edit window. Changed values are highlighted. Prevent user input or pause the game while window is open. Window scale depends on game scale.

Last updated a week ago
Total downloads 313160
Total rating 87 
Categories Tools Server-side Client-side Utility Bog Witch Update
Dependency string shudnal-ConfigurationManager-1.1.16
Dependants 411 other packages depend on this package

This mod requires the following mods to function

denikson-BepInExPack_Valheim-5.4.2333 icon
denikson-BepInExPack_Valheim

BepInEx pack for Valheim. Preconfigured with the correct entry point for mods and preferred defaults for the community.

Preferred version: 5.4.2333
ValheimModding-YamlDotNet-16.3.0 icon
ValheimModding-YamlDotNet

Shared version 16.3.0 of YamlDotNet from Antoine Aubry and contributors, net47 package for use in Valheim mods. Maintained by the ValheimModding team.

Preferred version: 16.3.0
ValheimModding-JsonDotNET-13.0.3 icon
ValheimModding-JsonDotNET

Shared version 13.0.3 of Json.NET from Newtonsoft, net45 package for use in Valheim mods. Maintained by the ValheimModding team.

Preferred version: 13.0.3
shudnal-ConditionalConfigSync-1.0.4 icon
shudnal-ConditionalConfigSync

Shared config synchronization and server policy library for Valheim mods. Installed as a dependency and compatible with Jotunn and ServerSync.

Preferred version: 1.0.4

README

The mod was originally created and hosted by the BepInEx team https://github.com/BepInEx/BepInEx.ConfigurationManager

It is distributed under the GPLv3 and this version maintains that license.

That fork have additions from other similar mods

How to use

Press hotkey button in game (default F1) to open mod window and change configuration of mods.

Features improved

  • Localization - every button and label can be localized
  • Elements recolored - you can set color of background, widget and enabled toggle
  • Fonts colored - set distinct colors for default and changed values
  • Color drawer extended further
  • Window is draggable, resizable and remembers its size and position
  • Open and close window by hitting one hotkey. Close window with Escape.
  • Dropdown menu style refined
  • Lots of minor refinements and improvements
  • Readonly entries (locked from server) could be colored, disabled or completely hidden
  • Dynamic ReadOnly and Browsable attributes are refreshed while the window remains open and rechecked immediately before a setting write
  • Synchronization state buttons with hover details for Jotunn, ServerSync and Conditional Config Sync settings; S means server-controlled and C means client-controlled. Conditional settings use the normal font color while their mod default is active and blue after server policy changes the ownership. Authorized administrators can toggle CCS Conditional ownership directly.
  • Optional compact config list layout applies uniform reduced vertical spacing to every setting row, is enabled by default and is switchable from the window header
  • default view is Split View where plugins and categories are showed as a tree in left column
  • File Editor for configuration files
  • Setting Edit Window for more detailed setting configuration

Valheim specific

The game does not take input while the window is open (only player input by default).

The game will be paused (if it can be paused) while the window is open (disabled by default).

Configuration Manager settings and server policy

All settings belonging to Configuration Manager itself are registered with Conditional Config Sync as policy-controlled settings. They remain client-controlled by default, preserving each player's local UI, input, window, text, color, and file-editor preferences.

When Configuration Manager is also installed on the server, administrators can use the CCS synchronization policy to force individual settings or complete sections to server-controlled ownership. Lock Configuration is always server-controlled. Configuration Manager remains optional on remote peers (ModRequired = false), so clients without the mod can still connect.

Hidden settings

Create file shudnal.ConfigurationManager.hiddensettings.json and place next to plugin dll or in \BepInEx\config folder.

The file could contain array of strings with special format. pluginGUID=Section name=Settings name equal sign separated strings containing mod GUID, section name and config name.

If such settings is found in settings list it will be hidden completely.

In given file entries 1 and 2 are here for format example. 3rd string will hide setting "Pause game" in section "Valheim" of that Configuration manager mod.

[
	"pluginGUID=Section name=Settings name",
	"authorname.exampleGUID=Section name=Settings name 2",
	"shudnal.ConfigurationManager=Valheim=Pause game"
]

To get mod GUID ingame you can enable "Debug mode" toggle in mods header. Now mod GUID will be presented in mod tooltip on hover.

Said file could also be placed on server to push that hidden settings to clients. Combined with preconfigured modpack configs you can prevent users from changing values of client-sided mods easily. Yet they can still edit files manually. Server administrators are identified through Conditional Config Sync's effective administrator state, so hidden settings are not applied to an authorized administrator because of delayed or stale vanilla AdminList data.

Compatibility

The mod is incompatible with original configuration manager and will not be loaded in that case.

Conditional Config Sync 1.0.4 or newer is required.

Installation (manual)

Install Conditional Config Sync 1.0.4 or newer, then place ConfigurationManager.dll in your BepInEx\Plugins\ folder.

Mirrors

Nexus

Thunderstore