CSync
Configuration file syncing library for BepInEx.
Last updated | 8 months ago |
Total downloads | 1374232 |
Total rating | 25 |
Categories | Tools Libraries BepInEx |
Dependency string | Owen3H-CSync-3.0.1 |
Dependants | 809 other packages depend on this package |
This mod requires the following mods to function
BepInEx-BepInExPack
BepInEx pack for Mono Unity games. Preconfigured and ready to use.
Preferred version: 5.4.2100README
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 toBinaryFormatter
. - 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.