Skip to content

Home

Jump to bottom
Owen edited this page May 12, 2024 · 25 revisions

This wiki showcases how to setup and use the library and its features.
NOTE: This documentation refers to v2.0.0 and higher.

CSync will work automatically with games that use Unity NGO.
Games with custom networking (Valheim, ROR2) are not supported yet!

FAQ

Q: Why are my variables not synced?
A: There may be multiple reasons for this, but the most common solutions are:

1. Making sure your SyncedEntry variables are not prefixed with the static keyword.
2. Referencing via .Instance. Good: if (Config.Instance.EXAMPLE_VAR). Bad: if (Plugin.Config.EXAMPLE_VAR)
3. Only using synced variables once the sync has completed. Use the SyncComplete event if necessary.

If these don't solve your problem, please make an issue as it could possibly be a bug.

If your problem is still not fixed or is not covered, please join the discord where I can help you further.

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