https://github.com/fuqunaga/syncutilformirror

Sync Utilities For Mirror
https://github.com/fuqunaga/syncutilformirror

mirror networking unity

Last synced: 4 months ago
JSON representation

Sync Utilities For Mirror

• Host: GitHub
• URL: https://github.com/fuqunaga/syncutilformirror
• Owner: fuqunaga
• License: mit
• Created: 2022-05-09T05:41:30.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-21T06:38:47.000Z (8 months ago)
• Last Synced: 2025-02-21T15:49:53.751Z (4 months ago)
• Topics: mirror, networking, unity
• Language: C#
• Homepage:
• Size: 101 MB
• Stars: 14
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# SyncUtil For Mirror

Sync Utilities For [Mirror](https://github.com/vis2k/Mirror)  

  

# Installation

## Install Dependency

 - [Mirror via AssetStore](https://assetstore.unity.com/packages/tools/network/mirror-129321)

## Install package via scoped registory

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

Enter the following and click the Save button.

```

"name": "fuqunaga",

"url": "https://registry.npmjs.com",

"scopes": [ "ga.fuquna" ]

```

![](Documentation~/2022-04-12-17-29-38.png)

**Window > Package Manager**

Select `MyRegistries` in `Packages:`

![](Documentation~/2022-04-12-17-40-26.png)

Select `SyncUtil For Mirror` and click the Install button

# How to run Examples

1. Add all scene files(*.unity) to `Scenes In Build` of Build Settings.

1. Open and run *SyncUtilExamples.unity* scene. this is an example scene launcher.

# Functions

## SyncParam

Synchronization of member variables outside NetworkBeheivour.

![](Documentation~/syncparam.gif)

## SyncBehaviourEnabled, SyncGameObjectActive

![](Documentation~/syncbehaviourenabled.gif)

## InstanceRandom

Deterministic random per instance.

![](Documentation~/instancerandom.gif)

## LockStep

Deterministic LockStep framework.

- Chasing Playback

- Consistency Checker(Check for client out-of-sync)

![](Documentation~/lockstep.gif)

*[Lorentz Attractor](https://en.wikipedia.org/wiki/Lorenz_system) implementation on CPU*

![](Documentation~/lockstep_gpu.gif)

*[Conway's Game of Life](https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life) implementation on GPU*

## Spawner

Spawn prefabs when the server is started.  

Register prefabs to NetworkManager's spawn prefabs.

![](Documentation~/2022-07-11-17-56-03.png)

## ServerOrStandAlone

Deactivate child GameObjects when server or standalone.

  

## ClientInvisibility

Specify the invisibility per Client to a GameObject.

![](Documentation~/clientinvisibility.gif)

  

## OnlineOfflineSceneLoadHelper

Load/Unload online/offline scene on hierarchy when application play.  

![](Documentation~/onlineofflinesceneloadhelper.gif)

# References

- [RosettaUI](https://github.com/fuqunaga/RosettaUI) - Code-based GUI library for development menus for Unity

- [PrefsGUI](https://github.com/fuqunaga/PrefsGUI) - Accessors and GUIs for persistent preference values using a JSON file

- [PrefsGUISyncForMirror](https://github.com/fuqunaga/PrefsGUISyncForMirror) - Sync subset for PrefsGUI over Mirror