Sigurd.BepInEx.CSync 3.1.0

Prefix Reserved
.NET Standard 2.1 This package targets .NET Standard 2.1. The package is compatible with this framework or higher. .NET Framework 4.7.2 This package targets .NET Framework 4.7.2. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Sigurd.BepInEx.CSync --version 3.1.0                

                    
                

            
NuGet\Install-Package Sigurd.BepInEx.CSync -Version 3.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Sigurd.BepInEx.CSync" Version="3.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Sigurd.BepInEx.CSync --version 3.1.0                

                    
                

            
#r "nuget: Sigurd.BepInEx.CSync, 3.1.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Sigurd.BepInEx.CSync as a Cake Addin
#addin nuget:?package=Sigurd.BepInEx.CSync&version=3.1.0

// Install Sigurd.BepInEx.CSync as a Cake Tool
#tool nuget:?package=Sigurd.BepInEx.CSync&version=3.1.0

CSync <img align="right" width="128" height="128" src="https://github.com/lc-sigurd/CSync/raw/main/CSync/assets/icons/icon.png">

GitHub Actions Workflow Status Release Version Thunderstore Version Thunderstore Downloads

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's Named Messages to avoid Netcode Patcher and NetworkBehaviour.

Disclaimer

This project is a fork of the original CSync project authored by @Owen3H.

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.

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 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. 
.NET Framework net472 is compatible.  net48 is compatible.  net481 was computed. 
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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
5.0.1 186 5/19/2024
5.0.0 114 4/29/2024
4.1.0 119 4/2/2024
4.0.2 95 4/1/2024
4.0.1 89 4/1/2024
4.0.0 89 4/1/2024
3.1.1 166 3/5/2024
3.1.0 101 3/4/2024
3.0.4 96 3/4/2024