the-egg-corp/csync

Configuration syncing library for BepInEx.

CSync

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.
  

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.

Disclaimer

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.

csync's Issues

New incompatibility introduced, not certain who's side this falls on.

The Mod 'YippeeKeyMod' and 'LethalMeltdown' both suggest Csync 1.0.7 but worked fine on Csync 1.0.8

2.0.0 however I've already discovered a problematic behavior has popped up.

With a fresh Mod profile and only YippeeKeyMod and allowing CSync to update to latest when prompted to 2.0.0

Once the player is on the ship, you can no longer leave via the exit menu, took a bit to narrow down, but this is barebones reproducible.

Unsure who this falls upon to investigate! But I'll have to stay at 1.0.8 to keep known things working.

https://thunderstore.io/c/lethal-company/p/Quadmesh/YippeeKeyMod/

[Suggestion] Event for RevertSync too

pre-2.0.0 boilerplate code I use for one of my mods calls a function to update static values both after syncing and unsyncing, so having a callback for it would be helpful

CSync is not fully game-independent.

Currently, the library applies patches that are specific to Lethal Company.
In the spirit of keeping it generic, an alternative should be found.

This is especially important now CSync is available for Valheim and RoR2.

Can't leave the round.

Once I have loaded a save game, I can no longer exit the game. This error message follows: