PrefsGUISync For Mirror

March 3, 2025 ยท View on GitHub

npm version openupm

Synchronization subset for PrefsGUI over Mirror.

Installation

Install Mirror

Install package via scoped registry

Edit > ProjectSettings... > Package Manager > Scoped Registries

Enter the following and click the Save button.

"name": "fuqunaga",
"url": "https://registry.npmjs.com",
"scopes": [ "ga.fuquna" ]

Window > Package Manager

Select MyRegistries in Packages:

Select PrefsGUISync For Mirror and click the Install button

Usage

Put Packages/PrefsGUISync For Mirror/Runtime/PrefsGUISync.prefab to the scene.
PrefsGUISyncForMirror component inherits from NetworkBehaivour, so take steps to make it work(call Spawn() or put it on the online scene).

Now all prefs are automatically synchronized between the server and client!

Skip synchronization of specified prefs

Disable sync toggle at the EditorWindow(See the section below).
or set prefs's key to PrefsGUISyncForMirror.ignoreKeyList.

EditorWindow

Window > PrefsGUI

You can set whether to synchronize with the sync toggle.

Reduces the amount of data sent

Sync only value changed prefs

image
  • Default: on.
  • PrefsGUISyncForMirror only sends prefs that have changed from their default values.
  • This assumes that the prefs for the same key on the server and client share the same default values.
  • If this flag is set to false, all prefs values will be sent.

Divide spawn data

image
  • Default: off.
  • PrefsGUISyncForMirror sends all sync target prefs values when connecting to a client.
  • If the data is too large, it may cause an error due to Mirror's capacity limit (approximately 300 kbytes).
NetworkConnection.Send: message of type Mirror.SpawnMessage with a size of [*] bytes is larger than the max allowed message size in one batch: 297421.
  • Setting enableDivideSpawnData to true will divide the data and send it in smaller packets.
  • When using this feature, there may be cases where PrefsGUISyncForMirror.enabled == true on the client side, but the reception of the prefs values has not yet been completed.
  • Please monitor the completion of the reception using either PrefsGUISyncForMirror.IsSpawnFinished or the onSpawnFinished event.

Consider using transport other than KCP such as Telepathy

  • Mirror's capacity limitation is derived from KCP Transport.
  • If you encounter capacity limit errors, consider using a transport protocol other than KCP.
  • For instance, Telepathy can handle larger amounts of data by configuring an appropriate buffer size.

Reference