Owen3H-CSync icon

CSync

Configuration file syncing library for BepInEx.

Last updated 4 hours ago
Total downloads 493945
Total rating 12 
Categories BepInEx Server-side Libraries Mods Tools
Dependency string Owen3H-CSync-2.0.0
Dependants 512 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack-5.4.2100 icon
BepInEx-BepInExPack

BepInEx pack for Mono Unity games. Preconfigured and ready to use.

Preferred version: 5.4.2100

README

CSync

A BepInEx configuration file syncing library.
This library will help you force clients to have the same settings as the host!

Features

  • Can serialize a ConfigEntry with a drop-in replacement.
  • No seperate config file system, retains BepInEx support.
  • Uses DataContractSerializer, a fast and safer alternative to BinaryFormatter.
  • Provides helpful extension methods.

Setup & Usage

To setup and use CSync, pleaser refer to the wiki.
It is highly recommended mod authors migrate to v2.0.0!

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.