An easy-to-implement configuration file syncing library.
The wiki should cover all you need to start using CSync.
If you have a suggestion or want something fixed, I'm all ears over at my discord! :)
Important
- 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.
- 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.
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.