7.4 KiB
Stop worrying about networking. Because we do.
Mirror
Mirror is a high level Networking library for Unity, compatible with different low level Transports.
Mirror is for small indie games & large scale MMOs, made by the developers of uMMORPG and Cubica.
Mirror is optimized for ease of use & probability of success.
We needed a networking library that allows us to launch our games and survive the next decade.
Architecture
The Server & Client are ONE project in order to achieve an order of magnitude gain in productivity.
Making multiplayer games this way is fun & easy. Instead of MonoBehaviour, Mirror provides NetworkBehaviour components with:
- [Server] / [Client] tags for server-only / client-only code
- [Command] for Client->Server function calls (e.g. UseItem)
- [ClientRpc] / [TargetRpc] for Server->Client function calls (e.g. AddChatMessage)
- [SyncVar] / SyncList to automatically synchronize variables from Server->Client
Note: Mirror is based on Unity's abandoned UNET Networking system. We fixed it up and pushed it to MMO Scale.
Many Transports Available
- KCP - kcp2k line-by-line kcp.c translation.
- TCP - libuv2k based on Native C networking backend used by Node.js.
- TCP - Telepathy Simple, message based, MMO Scale TCP networking in C#. And no magic.
- WebSockets - SimpleWebTransport WebSockets transport layer for Mirror that target WebGL clients.
- WebSockets - AsioTransport WebSockets transport layer for Mirror that target WebGL clients.
- WebRTC - WebRTCTransport WebRTC transport layer for Mirror that target WebRTC clients.
- Multiplexer Multiplexer is a bridging transport to allow a server to handle clients on different transports concurrently, for example desktop clients using Telepathy together with WebGL clients using Websockets.
- Fallback Fallback is a compatibility transport for transports that don't run on all platforms and need fallback options to cover all other platforms.
- UDP - Ignorance Ignorance implements a reliable and unreliable sequenced UDP transport based on ENet.
- UDP - LiteNetLibTransport LiteNetLibTransport implements a UDP transport based on LiteNetLib.
- Steam - FizzySteamworks Transport utilising Steam P2P network, building on Steamworks.NET.
- Steam - FizzyFacepunch Transport utilising Steam P2P network, building on Facepunch.Steamworks.
- Epic - EpicTransport Transport utilising Epic Online Services for lobbies and relay.
- Relay - DarkReflectiveMirror Relay service transport for Mirror.
Getting Started
Get Unity 2018/2019 LTS, 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.
Made with Mirror
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 and more :)
Benchmarks
- 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 MMOs that will run for a decade or more.
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 in order for our games to survive.
Keeping the next decade in mind, contributing fixes / tests / improvements is highly appreciated while new features have a low probability of being merged.
At this point, what we don't add to Mirror is more important than what we do add to it!