Lethal Company Modding Wiki

Appearance

CSync (Config Syncing Library) ​

About CSync ​

CSync is a utility library for conveniently syncing the values of some BepInEx ConfigEntry instances from host to clients.

History

CSync was originally authored by @Owen3H. Sadly, Owen fell out of favour with the Lethal Company Modding discord and removed CSync from the Thunderstore.

This led to the creation of a fork, under the @lc-sigurd organisation. As of April 2024, the fork has undergone extensive changes, resolving many issues that remain unfixed in Owen's distribution of CSync.

Shortly after removing CSync from the Thunderstore in March, Owen reinstated the mod. It is nonetheless recommended to use Sigurd's distribution of CSync.

For unknown reasons, Owen has transferred ownership of the original CSync repository to @DeathWrench.

Setup ​

There are two ways to depend upon CSync, but using the NuGet package is recommended. This will automatically include both an assembly reference and XML documentation. Depending via the Thunderstore method will not include XML documentation.

1. Open the terminal in Visual Studio.
2. Run the following command.

console
dotnet add package Sigurd.BepInEx.CSync

Alternatively, you can install it visually via the NuGet package manager.

  1. Head to Project > Manage NuGet Packages.
  2. Search and select the Sigurd.BepInEx.CSync package.
  3. Choose the latest version and hit Install.

Thunderstore (Manual) ​

  1. Download the latest version of the library on the Thunderstore page.
  2. Extract the zip into your game directory root.
  3. In your mod's project, add an Assembly Reference to ../BepInEx/plugins/CSync/com.sigurd.csync.dll.

Overview ​