| .github | ||
| Assets | ||
| doc | ||
| Packages | ||
| ProjectSettings | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .releaserc.yml | ||
| alt rigidbody.txt | ||
| appveyor.yml | ||
| CONTRIBUTING.md | ||
| FUNDING.yml | ||
| LICENSE | ||
| README.md | ||
| Regex for comment.txt | ||
| setversion.ps1 | ||
Mission
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 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.
Architecture
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] s are used for Client->Server communication
- [ClientRpc] / [TargetRpc] for Server->Client communication
- [SyncVar] s / SyncLists are used to automatically synchronize state
Note: Mirror is based on Unity's abandoned UNET Networking system. We fixed it up and pushed it to MMO Scale.
Low Level Transports
- (built in) Telepathy: TCP
- (built in) UNET LLAPI: UDP
- (built in) Ninja.Websockets: Websockets
- Apathy: Native TCP
- FizzySteam: SteamNetwork
- Ignorance: ENET UDP
- LiteNetLib4 LiteNetLib UDP
Getting Started
Download Mirror on the Asset Store, open one of the examples & press Play!
Check out our Documentation to learn how it all works.
If you are migrating from UNET, then please check out our Migration Guide. Don't panic, it's very easy and won't take more than 5 minutes.
Funding
Mirror is free & open source software funded by Donations. If you love it, please consider supporting Mirror on GitHub. As reward, you'll receive our Network Profiler, priority support access and more :)
Benchmarks
- Telepathy 1000 connections test
- uMMORPG 480 CCU worst case test (everyone broadcasting to everyone else)
Development & Contributing
Mirror is used in production by games ranging from small indie projects to large scale MMORPGs that will run for a decade.
Imagine if your dream game requires networking bug fixes 10 years from now when most contributors moved on and you are left alone with the code base. It is of utmost importance that we follow the KISS principle in order for our future games to survive.
Mirror has plenty of features. What matters now is that we make them as simple, as stable and as performant as possible (in that order).
If you want to contribute, please keep that mind and understand that while fixes / tests / improvements are highly appreciated, new features have a low probability of being merged.