Sigurd.BepInEx.CSync
5.0.1
Prefix Reserved
dotnet add package Sigurd.BepInEx.CSync --version 5.0.1
NuGet\Install-Package Sigurd.BepInEx.CSync -Version 5.0.1
<PackageReference Include="Sigurd.BepInEx.CSync" Version="5.0.1" />
paket add Sigurd.BepInEx.CSync --version 5.0.1
#r "nuget: Sigurd.BepInEx.CSync, 5.0.1"
// Install Sigurd.BepInEx.CSync as a Cake Addin #addin nuget:?package=Sigurd.BepInEx.CSync&version=5.0.1 // Install Sigurd.BepInEx.CSync as a Cake Tool #tool nuget:?package=Sigurd.BepInEx.CSync&version=5.0.1
CSync <img align="right" width="128" height="128" src="https://github.com/lc-sigurd/CSync/raw/main/CSync/assets/icons/icon.png">
A BepInEx configuration file syncing library. This library will help you force clients to have the same settings as the host!
[!IMPORTANT]
- This is NOT a standalone mod, it is intended for mod developers and does nothing on its own!<br>
- This does NOT edit or replace config files directly, everything is done in-memory.<br>
- It will NOT sync configs from mods that aren't dependent upon it.<br>
- CSync uses Unity Netcode's NetworkBehaviour with NetworkList to sync values.
Disclaimer
This project is a fork of the original CSync project authored by @Owen3H.
Features
- A serializable, drop-in replacement for
ConfigEntry
:SyncedEntry
- No seperate config file system, retains BepInEx support
- Uses
TomlTypeConverter
, the same system used by BepInEx to save/load values to/from config files - Provides extension methods for conveniently binding
SyncedEntry
instances
Setup & Usage
A guide to both setting up and using CSync is available on Lethal Wiki.
License
This project has the CC BY-NC-SA 4.0
license.<br>
This means the following terms apply:
Attribution<br> If you remix or adapt this project, appropriate credit must be given.<br> Cloning the repo with intent to contribute is not subject to this.
NonCommercial<br> You may not use this material for commercial purposes.
ShareAlike<br> When remixing, adapting or building upon this material, you must distribute the new material under the same license as the original.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.1 is compatible. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.1
- BepInEx.Core (>= 5.4.21)
- LethalCompany.GameLibs.Steam (>= 49.0.0-alpha.1)
- UnityEngine.Modules (>= 2022.3.9)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.