Mirror/README.md

Mirror is a high level Networking API for Unity, built on top of the low level Telepathy library.

Mirror is built and tested for MMO Scale Networking by the developers of uMMORPG, uSurvival and Cubica.

Mirror is optimized for ease of use and probability of success. Projects that use Mirror are small, concise and maintainable. uMMORPG was possible with <6000 lines of code. We needed a networking library that allows us to launch our games, period.

With Mirror, the Server & Client are ONE project (hence the name). Instead of having one code base for the server and one for the client, we simply use the same code for both of them.

• [Server] / [Client] tags can be used for the server-only and client-only parts.
• [Command] are used for Client->Server, and [ClientRpc] / [TargetRpc] for Server->Client communication.
• [SyncVar]s and SyncLists are used to automatically synchronize state.

What previously required 10.000 lines of code, now takes 1.000 lines of code. Therein lies the magic of Mirror.

Note: Mirror is based on Unity's abandoned UNET Networking system. We fixed it up and pushed it to MMO Scale.

Documentation

Check out our Documentation and read the Wiki.

The main difference is that you have to use using Mirror; instead of using UnityEngine.Networking; at the top of your scripts.

Oh, and you won't have to worry about channels, low level networking, packet loss, lack of support or bugs ever again. Mirror just works.

Usage Guide

Import mirror from the Asset Store into your project.

Alternatively, you can install it manually:

1. Download Mirror (for Unity 2017.4 and 2018). Use it at your own risk!
2. Drop the DLLs into your Project's Plugins folder
3. Select Runtime/Mirror.Runtime.dll and tell Unity to Exclude the Editor platform
4. Select Runtime-Editor/Mirror.Runtime.dll and tell Unity to only Include the Editor platform

Migration Guide

If you are still using UNET and want to switch to Mirror, you should check out our Migration Guide. Don't panic, it's very easy and won't take more than 5 minutes.

Example Projects

Download Mirror from the Asset Store, we have several small example projects included.

For a fully polished complete project example, consider uMMORPG or uSurvival.

Community Transports

If you don't want to use Telepathy or UNET's LLAPI as low level transport, then check out:

• https://github.com/FizzCube/SteamNetNetworkTransport (SteamNetwork)
• https://github.com/SoftwareGuy/Ignorance/ (ENet)

Donations

Mirror is developed by volunteers. If you like what we are doing, consider leaving a small donation.

Build

Building Mirror yourself is very easy. Simply download the project, open it in Visual Studio or Rider, build it once for Release and once for Release-Editor. You will then find all the necessary DLLs in the Output directory.

Benchmarks

• Telepathy 1000 connections test
• uMMORPG 207 CCU worst case test (everyone broadcasting to everyone else)
• uSurvival 122 CCU worst case test

Contributing

If you like to contribute, feel free to submit pull requests and visit our Discord Server.

We follow the KISS principle, so make sure that your Pull Requests contain no magic.

We need Mirror to be MMO Scale. Bug fixes are always highly appreciated. New features will be considered very carefully.