Skip to content

Setup

Jump to bottom
Owen edited this page Mar 4, 2024 · 6 revisions

Setting up CSync

There are two ways to depend upon CSync, but I recommend using the NuGet package.
This will automatically include both an assembly reference and documentation as opposed to Thunderstore.

NuGet (Recommended)

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

dotnet add package Owen3H.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 Owen3H.BepInEx.CSync package.
3. Choose the latest version and hit Install.

Manual Reference

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

Feel free to join my discord if you need support.

  1. Setup
    1.1. NuGet (Recommended)
    1.2. Manual Reference
  2. Usage Guide
    2.1. Creating a serializable config
    2.2. Binding config entries
    2.3. Specify BepInEx dependency
    2.4. Using the config
  3. Optional Features
    3.1. Allow host sync control
    3.2. Subscribing to Events
    3.3. Resyncing the config
  4. FAQ / Common Issues
    4.1 Unsynced variables
Clone this wiki locally