| .github | ||
| Assets | ||
| doc | ||
| Packages | ||
| ProjectSettings | ||
| UserSettings | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .releaserc.yml | ||
| appveyor.yml | ||
| CONTRIBUTING.md | ||
| FUNDING.yml | ||
| LICENSE | ||
| README.md | ||
| setversion.ps1 | ||
It's only the dreamers who ever move mountains.
Mirror
Mirror is a high level Networking library for Unity 2019/2020 LTS, compatible with different low level Transports.
Mirror is for indie games & small 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.
Mirror is stable & production ready.
Free & Open
Mirror is free & open source!
- Code: MIT licensed.
- Dedicated Servers: Anywhere!
- Player Hosted: Free Epic Relay!
We need Mirror for our own games, which is why we will never charge anything.
Funded only by Donations from our fantastic community of over 10,000 people.
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
Getting Started
Get Unity 2020 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
Population: ONE
The BigBoxVR team started using Mirror in February 2019 for what eventually became one of the most popular Oculus Rift games.
In addition to 24/7 support from the Mirror team, BigBoxVR also hired one of our engineers.
Population: ONE was recently acquired by Facebook.
Nimoyd
Nudge Nudge Games' first title: the colorful, post-apocalyptic open world sandbox game Nimoyd is being developed with Mirror.
Soon to be released for PC & mobile!
A Glimpse of Luna
A Glimpse of Luna - a tactical multiplayer card battle game with the most beautiful concept art & soundtrack.
Made with Mirror by two brothers with no prior game development experience.
Inferna
One of the first MMORPGs made with Mirror, released in 2019.
An open world experience with over 1000 CCU during its peak, spread across multiple server instances.
Samutale
A sandbox survival samurai MMORPG, originally released in September 2016.
Later on, the Netherlands based Maple Media switched their netcode to Mirror.
Untamed Isles
The turn based, monster taming MMORPG Untamed Isles is currently being developed by Phat Loot Studios.
After their successful Kickstarter, the New Zealand based studio is aiming for a 2022 release date.
Zooba
Wildlife Studio's hit Zooba made it to rank #5 of the largest battle royal shooters in the U.S. mobile market.
The game has over 50 million downloads on Google Play, with Wildlife Studios as one of the top 10 largest mobile gaming companies in the world.
SCP: Secret Laboratory
Northwood Studios' first title: the multiplayer horror game SCP: Secret Laboratory was one of Mirror's early adopters.
Released in December 2017, today it has more than 140,000 reviews on Steam.
Naïca Online
Naïca is a beautiful, free to play 2D pixel art MMORPG.
The France based team was one of Mirror's early adopters, releasing their first public beta in November 2020.
Laurum Online
Laurum Online - a 2D retro mobile MMORPG with over 500,000 downloads on Google Play.
And many more...
Mirror LTS (Long Term Support)
If you use Mirror in production, consider Mirror LTS!
- Bug fixes only.
- Consistent API: update any time, without any breaking features.
- Lives along side Unity 2019 LTS.
- Supported from Sept. 2021 to Sept 2022, depending on feedback.
Mirror V46 LTS is available to all GitHub Sponsors.
All sponsors are invited to the Mirror V46 LTS Repository automatically.
Low Level Transports
- (built in) KCP: reliable UDP
- (built in) Telepathy: TCP
- (built in) Websockets: Websockets
- Ignorance: ENET UDP
- LiteNetLib UDP
- FizzySteam: SteamNetwork
- FizzyFacepunch: SteamNetwork
- Epic Relay: Epic Online Services
- Bubble: Apple GameCenter
- Light Reflective Mirror: Self-Hosted Relay
- Oculus P2P: Oculus Platform Service
Benchmarks
- uMMORPG 480 CCU (worst case)
- Jesus' Benchmarks
Development & Contributing
Mirror is used in production by everything from small indie projects to million dollar funded games that will run for a decade or more.
Therefore it is important for us to follow the KISS principle in order for our games to survive, so that we can still fix networking bugs 10 years from now if needed.
Bug Bounty
A lot of projects use Mirror in production. If you found a critical bug / exploit in Mirror core, please reach out to us in private. Depending on the severity of the exploit, we offer $50 - $500 for now. Rewards based on Mirror's donations, capped at amount of donations we received that month.
Specifically we are looking for:
- Ways to crash a Mirror server
- Ways to exploit a Mirror server
- Ways to leave a Mirror server in undefined state
We are not looking for DOS/DDOS attacks. The exploit should be possible with just a couple of network packets, and it should be reproducible.
Credits / past findings / fixes:
- 2020, fholm: fuzzing ConnectMessage to stop further connects [#2397]