CSync
Configuration file syncing library for BepInEx.
About this mod Author’s original text
CSync
An easy-to-implement configuration syncing library for BepInEx files.
This library will help devs share settings from the host to all other clients.
To setup and use CSync, pleaser refer to the wiki.
Join my discord to contact me.
Features
- Can serialize a ConfigEntry with a drop-in replacement. (SyncedEntry)
- No seperate config file system, retains BepInEx support.
- Uses DataContractSerializer, a fast and safer alternative to BinaryFormatter.
- Provides helpful extension methods.
Important Notes
- This is NOT a standalone mod, it is intended for mod developers and does nothing on its own!
- This does NOT edit or replace config files directly, everything is done in-memory.
- It will NOT sync configs from mods that aren't dependent upon it.
- CSync uses Unity's Named Messages to avoid Netcode Patcher and NetworkBehaviour.
License
This project has the CC BY-NC-SA 4.0 license.
This means the following terms apply:
Attribution
If you remix or adapt this project, appropriate credit must be given.
Cloning the repo with intent to contribute is not subject to this.
NonCommercial
You may not use this material for commercial purposes.
ShareAlike
When remixing, adapting or building upon this material, you must
distribute the new material under the same license as the original.
Install & use Install: BepInEx plugin
- The archive from playbuff is the mod itself — usually a BepInEx plugin (a .dll or a plugin folder once unzipped).
- Recommended: use a community mod manager (such as r2modman) — pick this game, import the mod, and the manager sets up BepInEx and its dependencies for you.
- Manual route: install the BepInEx loader in the game folder, then drop the unzipped .dll or plugin folder into BepInEx/plugins/.
- Launch the game — the BepInEx console logs every plugin it loads; seeing this mod in the log means it is installed.
Mods with listed dependencies need those installed too, or they will not load. Options are usually changed in-game or in the plugin's config file.
Install these first, or the mod will not work: