You are viewing a potentially older version of this package. View all versions.
Notest-ConfigSync-1.0.1 icon

ConfigSync

Tool for Content Warning mod developers to temporarily sync host configs with other players in a lobby.

Date uploaded 7 months ago
Version 1.0.1
Download link Notest-ConfigSync-1.0.1.zip
Downloads 5309
Dependency string Notest-ConfigSync-1.0.1

This mod requires the following mods to function

BepInEx-BepInExPack-5.4.2100 icon
BepInEx-BepInExPack

BepInEx pack for Mono Unity games. Preconfigured and ready to use.

Preferred version: 5.4.2100
RugbugRedfern-MyceliumNetworking-1.0.14 icon
RugbugRedfern-MyceliumNetworking

An easy to use networking library for sending custom RPCs through Steam.

Preferred version: 1.0.14

README

ConfigSync

Dependencies

This depends on Mycelium!

How do I use this

Download the latest dll from the releases tab or clone and build the repo, then add it as a reference to the project. After adding it as a reference you can add it as a dependency:

[BepInDependency(ConfigSync.MyPluginInfo.PLUGIN_GUID)] // Make sure to specify if it's a soft or a hard dependency! BepInEx sets dependencies to hard by default.
public class YourMod : BaseUnityPlugin { // ...

And for in-depth documentation, check out the documentation or one of the demos! Demos available are the BepInEx config branch and the ContentSettings config branch

Does this add something?

By itself, no — this is an API for mod developers to temporarily sync settings/configurations from the host to other players when in a lobby.

It doesn't work

If the mod is throwing an error use the github issues page and copy-paste the error in there, with a description of what is happening and what you expected to happen if applicable. Or just ping me at the Content Warning Modding Discord server!

Credits

Big thanks to Day A.K.A. www.day.dream for helping me test the library and helping me with reflection!

CHANGELOG

v2.0.0

  • Added: Serialize and Deserialize class
  • Added: Serialize and Deserialize dictionary
  • Refactor: Use RPCs instead of LobbyData

v1.0.0

Initial version