Mirage is a high level Networking API for Unity.

Mirage is built and tested for MMO Scale Networking by the developers of Cubica.

Mirage is optimized for ease of use and probability of success.

With Mirage the objects in the client are mirror images of the objects in the server. Mirage provides all the tools necessary to keep them in sync and pass messages between them.

Installation

To install Mirage, follow these steps:

1. Install Unity 2020.1.17 or later
2. Start a new project or open your existing one
3. Add openupm registry. Click on the menu Edit -> Project settings..., and add a scoped registry like so:
   Name: OpenUPM
   Url: https://package.openupm.com
   Scopes:
   • com.cysharp.unitask
   • com.openupm
   • com.miragenet
4. Close the project settings
5. Open the package manager. Click on menu Window -> Package Manager and select "Packages: My Registries", select the latest version of Mirage and click install, like so:
6. You may come back to the package manager to unistall Mirage or upgrade it.

Comparison with Mirror

When migrating a project from Mirror to Mirage, these will be the most notable differences.

Mirage	Mirror
Install via Unity Package Manager	Install from Asset Store
Errors are thrown as exceptions	Errors are logged
[ServerRpc]	[Command]
[ClientRpc(target=Client.Owner)]	[TargetRpc]
Subscribe to events in NetworkServer	Override methods in NetworkManager
Subscribe to events in NetworkClient	Override methods in NetworkManager
Subscribe to events in NetworkIdentity	Override methods in NetworkBehaviour
Methods use PascalCase (C# guidelines)	No consistency
NetworkTime available in NetworkBehaviour	NetworkTime is global static
Send any data as messages	Messages must implement NetworkMessage
Supports Unity 2019.3 or later	Supports Unity 2018.4 or later
Offers simple Socket API to implement new protocols	Each protocol requires a new transport

Mirage has many new features

• Mirage supports fast domain reload
• Components can be added in child objects
• Your client can connect to multiple servers. For example chat server and game server
• Modular, use only the components you need.
• Error handling
• Version defines
• Server Rpcs can return values
• The default transport features DoS prevention
• The default transport has CRC64 integrity check

If you look under the hood, the code base has some significant differences based on the core values of each project

• Mirage follows the SOLID principles.
• Mirage avoids singletons and static state in general.
• Mirage has high
• Mirage has low
• Mirage values code quality, Mirror values API stability

Development environment

If you want to contribute to Mirage, follow these steps:

Linux and Mac

1. Install git
2. clone this repo
3. Open in unity 2020.1.x or later

Windows

1. Install git or use your favorite git client
2. as administrator, clone this repo with symbolic links support:

   git clone -c core.symlinks=true https://github.com/MirageNet/Mirage.git

   It you don't want to use administrator, add symlink support to your account. If you don't enable symlinks, you will be able to work on Mirage but Unity will not see the examples.
3. Open in unity 2019.4.x or later

Transport and Sockets

Mirage supports multiple ways of transporting data:

• Native UDP socket (default on Windows, Mac and Linux)
• C# UDP Socket (default on other platforms)
• Steam (Facepunch Steamworks)
• Websocket, to support webgl clients (coming soon)

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request 😃