2020-01-14 10:45:52 +00:00
2018-09-25 11:37:56 +00:00
2020-01-18 22:00:50 +00:00
[](https://assetstore.unity.com/packages/tools/network/mirror-129321)
2020-09-08 14:24:29 +00:00
[](https://mirror-networking.com/docs)
2019-11-28 15:24:12 +00:00
[](https://www.youtube.com/playlist?list=PLkx8oFug638oBYF5EOwsSS-gOVBXj1dkP)
2018-11-13 19:55:15 +00:00
[](https://forum.unity.com/threads/mirror-networking-for-unity-aka-hlapi-community-edition.425437/)
2020-09-08 14:23:26 +00:00
[](https://ci.appveyor.com/project/vis2k73562/hlapi-community-edition/branch/mirror)
2020-03-01 16:42:38 +00:00
[](https://sonarcloud.io/dashboard?id=vis2k_Mirror)
2018-08-04 13:03:53 +00:00
[](https://discordapp.com/invite/N9QVxbM)
2018-11-13 19:35:20 +00:00
[](https://github.com/vis2k/Mirror/releases/latest)
2018-07-15 21:06:02 +00:00
2020-09-08 14:57:33 +00:00
## Mission
2018-08-28 10:43:21 +00:00
Mirror is a **high level** Networking API for Unity, built on top of the **low level** [Telepathy ](https://github.com/vis2k/Telepathy ) library.
2018-07-15 21:06:02 +00:00
2020-09-08 14:37:10 +00:00
Mirror is built [and tested ](https://www.youtube.com/watch?v=mDCNff1S9ZU ) for **MMO Scale** Networking by the developers of [uMMORPG ](https://assetstore.unity.com/packages/templates/systems/ummorpg-51212 ) and [Cubica ](https://cubica.net ).
2018-07-15 21:06:02 +00:00
2019-05-14 11:45:56 +00:00
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 ](https://mirror-networking.com/showcase/ ), period .
2018-07-15 21:06:02 +00:00
2020-09-08 14:41:32 +00:00
## Architecture
2018-08-28 10:43:21 +00:00
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.
2020-09-08 14:41:32 +00:00
* **[Server]** / ** [Client]** tags can be used for the server-only and client-only parts
2020-09-08 14:42:29 +00:00
* **[Command]** s are used for Client->Server communication
2020-09-08 14:41:32 +00:00
* **[ClientRpc]** / ** [TargetRpc]** for Server->Client communication
2020-09-08 14:42:29 +00:00
* **[SyncVar]** s / SyncLists are used to automatically synchronize state
2018-07-15 21:06:02 +00:00
2018-08-28 10:43:21 +00:00
_Note: Mirror is based on Unity's abandoned UNET Networking system. We fixed it up and pushed it to MMO Scale._
2018-07-15 21:06:02 +00:00
2020-09-08 14:49:11 +00:00
## Low Level Transports
2020-09-08 14:36:41 +00:00
* (built in) [Telepathy ](https://github.com/vis2k/Telepathy ): TCP
* (built in) [UNET LLAPI ](https://docs.unity3d.com/Manual/UNetUsingTransport.html ): UDP
* (built in) [Ninja.Websockets ](https://github.com/ninjasource/Ninja.WebSockets ): Websockets
2020-09-08 15:28:21 +00:00
* (soon) Libuv: Node.js's native C TCP backend
2020-09-08 14:36:41 +00:00
* [Apathy ](https://mirror-networking.com/apathy/ ): Native TCP
* [FizzySteam ](https://github.com/Raystorms/FizzySteamyMirror/ ): SteamNetwork
* [Ignorance ](https://github.com/SoftwareGuy/Ignorance/ ): ENET UDP
2020-09-08 15:26:57 +00:00
* [LiteNetLib ](https://github.com/MirrorNetworking/LiteNetLibTransport/ ) LiteNetLib UDP
2018-11-09 14:50:35 +00:00
2020-09-08 14:49:11 +00:00
## Getting Started
Download [Mirror on the Asset Store ](https://assetstore.unity.com/packages/tools/network/mirror-129321 ), open one of the examples & press Play!
Check out our [Documentation ](https://mirror-networking.com/docs/ ) to learn how it all works.
2020-09-08 15:26:47 +00:00
If you are migrating from UNET, then please check out our [Migration Guide ](https://mirror-networking.com/docs/General/Migration.html ).
2020-09-08 14:49:11 +00:00
2020-09-08 14:56:54 +00:00
## Funding
2020-09-08 15:09:20 +00:00
Mirror is free & open source software funded by Donations. If you love it, please consider supporting [Mirror on GitHub ](https://github.com/sponsors/vis2k ). As reward, you'll receive our [Network Profiler ](https://mirror-networking.com/docs/Guides/Profiler.html?q=Profiler ), priority support access and more :)
2018-07-15 21:06:02 +00:00
2018-10-08 15:11:50 +00:00
## Benchmarks
2018-08-28 10:43:21 +00:00
* Telepathy [1000 connections ](https://github.com/vis2k/Telepathy ) test
2019-02-17 18:12:40 +00:00
* [uMMORPG 480 CCU worst case test ](https://youtu.be/mDCNff1S9ZU ) (everyone broadcasting to everyone else)
2018-07-15 21:06:02 +00:00
2020-09-08 15:18:05 +00:00
## Development & Contributing
2020-09-08 15:23:04 +00:00
Mirror is used **in production** by games ranging from small indie projects to large scale MMOs that will run for a decade or more.
2018-07-15 21:06:02 +00:00
2020-09-08 15:23:39 +00:00
10 years from now if your players encounter a networking bug and most of our contributors already moved on, someone will need to fix it. Therefore it is of utmost importance for us to follow the [KISS principle ](https://en.wikipedia.org/wiki/KISS_principle ) in order for our games to survive.
2018-06-07 13:40:15 +00:00
2020-09-08 15:22:33 +00:00
Keeping the next decade in mind, contributing **fixes** / **tests** / **improvements** is highly appreciated while new features have a low probability of being merged.
2019-03-16 10:03:03 +00:00
2020-09-08 15:22:33 +00:00
_At this point, what we don't add to Mirror is more important than what we do add to it!_
