Show / Hide Table of Contents

Method RegisterCustomConfig

| Edit this page View Source

RegisterCustomConfig(ConfigFile)

Registers a non default config file for possible synchronisation with all clients. Entries still need the IsAdminOnly attribute in order to be synchronized.
The file path must be saved under the executing BepInEx config folder, see BepInEx.Paths.ConfigPath. This guarantees the same relative path for all clients.
Declaration
public void RegisterCustomConfig(ConfigFile customFile)
Parameters
Type Name Description
ConfigFile customFile the file to synchronize
Exceptions
Type Condition
ArgumentException The config file is not saved under the BepInEx config folder
ArgumentException The config file is already registered
ArgumentException The config file is a default mod config and is already implicitly synchronized
  • Edit this page
  • View Source
☀
☾
In this article
Back to top
Generated by DocFX
☀
☾