-
-
Notifications
You must be signed in to change notification settings - Fork 0
FAQ
Owen edited this page May 12, 2024
·
6 revisions
There may be multiple reasons for this, but the most common solutions are:
-
1. Making sure your
SyncedEntry
variables are not prefixed with thestatic
keyword. -
2. Referencing via
.Instance
and not through other means.
// GOOD
if (MyConfig.Instance.EXAMPLE_VAR)
// BAD
if (MyConfig.Default.EXAMPLE_VAR)
if (Plugin.MyConfig.EXAMPLE_VAR)
-
3. Only using synced variables once the sync has completed.
- Use the
SyncComplete
event if necessary.
- Use the
If none of these address your problem, please make an issue as it could possibly be a bug.
If your problem is not covered here or remains unfixed, please join the discord and send a message in the #support
channel!
Feel free to join my discord if you need support.
-
Setup
1.1. NuGet (Recommended)
1.2. Manual Reference -
Usage Guide
2.1. Creating a serializable config
2.2. Binding config entries
2.3. Specify BepInEx dependency
2.4. Using the config -
Optional Features
3.1. Allow host sync control
3.2. Subscribing to Events
3.3. Resyncing the config -
FAQ / Common Issues
4.1 Unsynced variables