2022-07-10 14:52:31 +00:00
2021-05-21 10:58:47 +00:00
2020-01-18 22:00:50 +00:00
[](https://assetstore.unity.com/packages/tools/network/mirror-129321)
2021-02-26 06:15:43 +00:00
[](https://mirror-networking.gitbook.io/)
2020-11-11 13:56:52 +00:00
[](https://mirror-networking.com/showcase/)
2021-12-10 00:32:24 +00:00
[](https://mirror-networking.gitbook.io/docs/community-guides/video-tutorials)
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)
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)
2021-06-21 15:09:03 +00:00
[](https://github.com/vis2k/Mirror/blob/master/LICENSE)
2020-12-16 03:09:53 +00:00
[](https://trello.com/b/fgAE7Tud)
2018-07-15 21:06:02 +00:00
2021-05-21 10:58:47 +00:00
**It's only the dreamers who ever move mountains.**
< img src = "https://user-images.githubusercontent.com/16416509/119117854-3e4e2b80-ba5c-11eb-8236-ce6cfd2b6b07.png" title = "Original Concept Art for Games that made us dream. Copyright Blizzard, Blizzard, Riot Games, Joymax in that order." / >
2020-09-08 16:10:27 +00:00
2022-10-11 10:03:36 +00:00
## Mirror Networking
The ** #1 ** free **open source** game networking library for **Unity 2019 / 2020 / 2021** .
2018-07-15 21:06:02 +00:00
2022-10-11 10:03:36 +00:00
Used **in production** by major hits like [**Population: ONE** ](https://www.populationonevr.com/ ) and many [more ](#made-with-mirror ).
2018-07-15 21:06:02 +00:00
2022-10-11 10:03:36 +00:00
Originally based on [**UNET** ](https://blog.unity.com/technology/announcing-unet-new-unity-multiplayer-technology ): battle tested **since 2014** for 8 years and counting!
2020-09-08 16:22:10 +00:00
2022-10-11 19:03:31 +00:00
Mirror is ** [stable ](https://mirror-networking.gitbook.io/docs/general/tests )**, [**modular** ](#low-level-transports ) & ** [easy to use ](https://mirror-networking.gitbook.io/ )** for all types of games, even small [MMORPGs ](#made-with-mirror ) 🎮.
2018-07-15 21:06:02 +00:00
2022-10-11 10:03:36 +00:00
**Made in 🇩🇪🇺🇸🇬🇧🇸🇬🇹🇼 with ❤️**.
2021-05-21 10:58:47 +00:00
2022-07-10 14:52:31 +00:00
---
2022-10-11 10:03:36 +00:00
## Architecture
The **Server & Client** are **ONE project** in order to achieve maximum productivity.
Simply use **NetworkBehaviour** instead of **MonoBehaviour** .
Making multiplayer games this way is fun & easy:
```cs
public class Player : NetworkBehaviour
{
// synced automatically
[SyncVar] public int health = 100;
// lists, dictionaries, sets too
SyncList< Item > inventory = new SyncList< Item > ();
// server/client-only code
[Server] void LevelUp() {}
[Client] void Animate() {}
void Update()
{
// isServer/isClient for runtime checks
if (isServer) Heal();
if (isClient) Move();
}
// zero overhead remote calls
[Command] void CmdUseItem(int slot) {} // client to server
[Rpc] void RpcRespawn() {} // server to all clients
[TargetRpc] void Hello() {} // server to one client
}
```
There's also **NetworkServer** & **NetworkClient** . And that's about it 🤩.
2021-05-21 10:58:47 +00:00
2022-10-11 10:03:36 +00:00
---
## Free, Open & Community Funded
Mirror is **free & open source** (MIT Licensed).
2021-05-20 08:27:17 +00:00
2022-10-11 10:03:36 +00:00
"Free" as in free beer, and freedom to use it any way you like.
- Run [Dedicated Servers ](https://mirror-networking.gitbook.io/docs/guides/server-hosting ) anywhere.
- Free player hosted games thanks to [Epic Relay ](https://github.com/FakeByte/EpicOnlineTransport )!
2020-09-08 15:36:34 +00:00
2022-10-11 10:03:36 +00:00
Mirror is funded by [**Donations** ](https://github.com/sponsors/vis2k ) from our [fantastic community ](https://discordapp.com/invite/N9QVxbM ) of over 14,000 users!
2018-07-15 21:06:02 +00:00
2022-10-11 10:38:23 +00:00
< img src = "https://user-images.githubusercontent.com/16416509/195067704-5577b581-b829-4c9f-80d0-b6270a3a59e7.png" title = "Fitzcarraldo" / >
_The top quote is from Fitzcarraldo, which is quite reminiscent of this project._
2022-10-11 10:03:36 +00:00
---
2020-09-08 14:49:11 +00:00
## Getting Started
2022-10-11 10:03:36 +00:00
Get **Unity 2019 / 2020 / 2021 LTS** , [Download Mirror ](https://assetstore.unity.com/packages/tools/network/mirror-129321 ), open one of the examples & press Play!
2020-09-08 14:49:11 +00:00
2021-02-26 06:15:43 +00:00
Check out our [Documentation ](https://mirror-networking.gitbook.io/ ) to learn how it all works.
2020-09-08 14:49:11 +00:00
2021-02-26 06:15:43 +00:00
If you are migrating from UNET, then please check out our [Migration Guide ](https://mirror-networking.gitbook.io/docs/general/migration-guide ).
2020-09-08 14:49:11 +00:00
2022-07-10 14:52:31 +00:00
---
2020-11-11 13:24:21 +00:00
## Made with Mirror
2022-07-10 14:52:31 +00:00
### [Population: ONE](https://www.populationonevr.com/)
2022-07-15 02:37:26 +00:00
[](https://www.populationonevr.com/)
2022-07-10 14:52:31 +00:00
The [BigBoxVR ](https://www.bigboxvr.com/ ) 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 ](https://github.com/sponsors/vis2k ) from the Mirror team, BigBoxVR also hired one of our engineers.
**Population: ONE** was recently [acquired by Facebook ](https://uploadvr.com/population-one-facebook-bigbox-acquire/ ).
### [Nimoyd](https://www.nimoyd.com/)
2022-07-15 02:37:26 +00:00
[](https://www.nimoyd.com/)
2022-07-10 14:52:31 +00:00
Nudge Nudge Games' first title: the colorful, post-apocalyptic open world sandbox game [Nimoyd ](https://store.steampowered.com/app/1313210/Nimoyd__Survival_Sandbox/ ) is being developed with Mirror.
_Soon to be released for PC & mobile!_
2022-07-20 18:11:44 +00:00
### [Dinkum](https://store.steampowered.com/app/1062520/Dinkum/)
2022-07-20 18:11:25 +00:00
[](https://store.steampowered.com/app/1062520/Dinkum/)
Set in the Australian Outback, Dinkum is a relaxing farming & survival game. Made by just one developer, Dinkum already reached 1000+ "Overwhelmingly Positive" reviews 1 week after its early access release.
James Bendon initially made the game with UNET, and then [switched to Mirror ](https://www.playdinkum.com/blog/2019/1/11/devlog-13-biomes-and-traps ) in 2019.
2022-07-10 14:52:31 +00:00
### [A Glimpse of Luna](https://www.glimpse-luna.com/)
2022-07-15 02:37:26 +00:00
[](https://www.glimpse-luna.com/)
2022-07-10 14:52:31 +00:00
[A Glimpse of Luna ](https://www.glimpse-luna.com/ ) - a tactical multiplayer card battle game with the most beautiful concept art & soundtrack.
Made with Mirror by two brothers with [no prior game development ](https://www.youtube.com/watch?v=5J2wj8l4pFA&start=12 ) experience.
2022-08-22 03:42:47 +00:00
### [Sun Haven](https://store.steampowered.com/app/1432860/Sun_Haven/)
2022-08-22 03:57:42 +00:00
[](https://store.steampowered.com/app/1432860/Sun_Haven/)
2022-08-22 03:42:47 +00:00
[Sun Haven ](https://store.steampowered.com/app/1432860/Sun_Haven/ ) - A beautiful human town, a hidden elven village, and a monster city filled with farming, magic, dragons, and adventure.
After their successful [Kickstarter ](https://www.kickstarter.com/projects/sunhaven/sunhaven/description ), Sun Haven was released on Steam in 2021 and later on ported to Mirror in 2022.
2022-07-10 14:52:31 +00:00
### [Inferna](https://inferna.net/)
2022-07-15 02:37:26 +00:00
[](https://inferna.net/)
2022-07-10 14:52:31 +00:00
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](https://www.samutale.com/)
2022-07-15 02:37:26 +00:00
[](https://www.samutale.com/)
2022-07-10 14:52:31 +00:00
A sandbox survival samurai MMORPG, originally released in September 2016.
Later on, the Netherlands based Maple Media switched their netcode to Mirror.
### [Untamed Isles](https://store.steampowered.com/app/1823300/Untamed_Isles/)
2022-07-15 02:37:26 +00:00
[](https://store.steampowered.com/app/1823300/Untamed_Isles/)
2022-07-10 14:52:31 +00:00
The turn based, monster taming **MMORPG** [Untamed Isles ](https://store.steampowered.com/app/1823300/Untamed_Isles/ ) is currently being developed by [Phat Loot Studios ](https://untamedisles.com/about/ ).
After their successful [Kickstarter ](https://www.kickstarter.com/projects/untamedisles/untamed-isles ), the New Zealand based studio is aiming for a 2022 release date.
### [Zooba](https://play.google.com/store/apps/details?id=com.wildlife.games.battle.royale.free.zooba&gl=US)
2022-07-15 02:37:26 +00:00
[](https://play.google.com/store/apps/details?id=com.wildlife.games.battle.royale.free.zooba& gl=US)
2022-07-10 14:52:31 +00:00
[Wildlife Studio's ](https://wildlifestudios.com/ ) 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 ](https://play.google.com/store/apps/details?id=com.wildlife.games.battle.royale.free.zooba&gl=US ), with Wildlife Studios as one of the top 10 largest mobile gaming companies in the world.
2022-09-15 04:27:29 +00:00
### [Portals](https://theportal.to/)
2022-09-15 04:30:25 +00:00
[](https://theportal.to/)
2022-09-15 04:27:29 +00:00
A browser-based metaverse, Portals is an immersive social space where you can explore, make your own, and gather with others.
2022-07-10 14:52:31 +00:00
### [SCP: Secret Laboratory](https://scpslgame.com/)
2022-07-15 02:37:26 +00:00
[](https://scpslgame.com/)
2022-07-10 14:52:31 +00:00
[Northwood Studios' ](https://store.steampowered.com/developer/NWStudios/about/ ) 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 ](https://store.steampowered.com/app/700330/SCP_Secret_Laboratory/?curator_clanid=33782778 ).
### [Naïca Online](https://naicaonline.com/)
2022-07-15 02:37:26 +00:00
[](https://naicaonline.com/)
2022-07-10 14:52:31 +00:00
[Naïca ](https://naicaonline.com/ ) is a beautiful, free to play 2D pixel art MMORPG.
The [France based team ](https://naicaonline.com/en/news/view/1 ) was one of Mirror's early adopters, releasing their first public beta in November 2020.
### [Laurum Online](https://laurum.online/)
2022-07-15 02:37:26 +00:00
[](https://laurum.online/)
2022-07-10 14:52:31 +00:00
[Laurum Online ](https://play.google.com/store/apps/details?id=com.project7.project7beta ) - a 2D retro mobile MMORPG with over 500,000 downloads on Google Play.
2022-12-12 10:58:45 +00:00
### [Empires Mobile](https://knightempire.online/)
[](https://knightempire.online/)
2022-12-12 11:20:57 +00:00
[Empires Mobile ](https://knightempire.online/ ) - Retro mobile MMORPG for Android and iOS, reaching 5000 CCU at times. Check out their [video ](https://www.youtube.com/watch?v=v69lW9aWb-w ) for some _early MMORPG_ nostalgia.
2022-12-12 10:58:45 +00:00
2022-07-10 14:52:31 +00:00
### And many more...
2022-07-15 02:37:26 +00:00
< a href = "https://store.steampowered.com/app/719200/The_Wall/" > < img src = "https://cdn.akamai.steamstatic.com/steam/apps/719200/header.jpg?t=1588105839" height = "100" title = "The wall" / > < / a >
< a href = "https://store.steampowered.com/app/535630/One_More_Night/" > < img src = "https://cdn.akamai.steamstatic.com/steam/apps/535630/header.jpg?t=1584831320" height = "100" title = "One more night" / > < / a >
< img src = "https://i.ytimg.com/vi/D_f_MntrLVE/maxresdefault.jpg" height = "100" title = "Block story" / >
< a href = "https://nightz.io" > < img src = "https://user-images.githubusercontent.com/16416509/130729336-9c4e95d9-69bc-4410-b894-b2677159a472.jpg" height = "100" title = "Nightz.io" / > < / a >
< a href = "https://store.steampowered.com/app/1016030/Wawa_United/" > < img src = "https://user-images.githubusercontent.com/16416509/162982300-c29d89bc-210a-43ef-8cce-6e5555bb09bc.png" height = "100" title = "Wawa united" / > < / a >
< a href = "https://store.steampowered.com/app/1745640/MACE_Mapinguaris_Temple/" > < img src = "https://user-images.githubusercontent.com/16416509/166089837-bbecf190-0f06-4c88-910d-1ce87e2f171d.png" title = "MACE" height = "100" / > < / a >
2022-09-14 14:03:11 +00:00
< a href = "https://www.adversator.com/" > < img src = "https://user-images.githubusercontent.com/16416509/178641128-37dc270c-bedf-4891-8284-33573d1776b9.jpg" title = "Adversator" height = "100" / > < / a >
2022-10-21 10:33:13 +00:00
< a href = "https://store.steampowered.com/app/670260/Solace_Crafting/" > < img src = "https://user-images.githubusercontent.com/16416509/197175819-1c2720b6-97e6-4844-80b5-2197a7f22839.png" title = "Solace Crafting" height = "100" / > < / a >
2022-11-25 19:02:50 +00:00
< a href = "https://www.unitystation.org" > < img src = "https://user-images.githubusercontent.com/57072365/204021428-0c621067-d580-4c88-b551-3ac70f9da39d.jpg" title = "UnityStation" height = "100" / > < / a >
2021-03-10 04:09:54 +00:00
2021-09-09 07:50:10 +00:00
## Mirror LTS (Long Term Support)
2021-09-09 09:04:40 +00:00
If you use Mirror in production, consider Mirror LTS!
2021-09-09 07:49:49 +00:00
* **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.
2021-09-09 07:51:43 +00:00
**Mirror V46 LTS** is available to all [GitHub Sponsors ](https://github.com/sponsors/vis2k ).
2021-09-09 07:49:49 +00:00
All sponsors are invited to the [Mirror V46 LTS Repository ](https://github.com/MirrorNetworking/Mirror-46-LTS ) automatically.
2022-10-11 10:03:36 +00:00
## Modular Transports
Mirror uses **KCP** (reliable UDP) by default, but you may use any of our community transports for low level packet sending:
2021-11-01 13:25:17 +00:00
* (built in) [KCP ](https://github.com/vis2k/kcp2k ): reliable UDP
* (built in) [Telepathy ](https://github.com/vis2k/Telepathy ): TCP
* (built in) [Websockets ](https://github.com/MirrorNetworking/SimpleWebTransport ): Websockets
2021-05-21 11:02:03 +00:00
* [Ignorance ](https://github.com/SoftwareGuy/Ignorance/ ): ENET UDP
* [LiteNetLib ](https://github.com/MirrorNetworking/LiteNetLibTransport/ ) UDP
* [FizzySteam ](https://github.com/Chykary/FizzySteamworks/ ): SteamNetwork
* [FizzyFacepunch ](https://github.com/Chykary/FizzyFacepunch/ ): SteamNetwork
* [Epic Relay ](https://github.com/FakeByte/EpicOnlineTransport ): Epic Online Services
2021-06-22 11:27:07 +00:00
* [Bubble ](https://github.com/Squaresweets/BubbleTransport ): Apple GameCenter
2021-05-21 11:02:03 +00:00
* [Light Reflective Mirror ](https://github.com/Derek-R-S/Light-Reflective-Mirror ): Self-Hosted Relay
* [Oculus P2P ](https://github.com/hyferg/MirrorOculusP2P ): Oculus Platform Service
2018-10-08 15:11:50 +00:00
## Benchmarks
2022-10-11 10:03:36 +00:00
* [2022] mischa [400-800 CCU ](https://discord.com/channels/343440455738064897/1007519701603205150/1019879180592238603 ) tests
* [2021] [Jesus' Benchmarks ](https://docs.google.com/document/d/1GMxcWAz3ePt3RioK8k4erpVSpujMkYje4scOuPwM8Ug/edit?usp=sharing )
* [2019] [uMMORPG 480 CCU ](https://youtu.be/mDCNff1S9ZU ) (worst case)
2018-07-15 21:06:02 +00:00
2020-09-08 15:18:05 +00:00
## Development & Contributing
2021-05-21 10:58:47 +00:00
Mirror is used **in production** by everything from small indie projects to million dollar funded games that will run for a decade or more.
2018-07-15 21:06:02 +00:00
2022-10-11 10:03:36 +00:00
We prefer to work slow & thoroughly in order to not break everyone's games 🐌.
2018-06-07 13:40:15 +00:00
2022-10-11 10:03:36 +00:00
Therefore, we need to [KISS ](https://en.wikipedia.org/wiki/KISS_principle ) 😗.
2021-03-10 03:38:49 +00:00
2022-10-11 10:03:36 +00:00
---
2021-03-10 03:38:49 +00:00
# Bug Bounty
2022-10-11 11:27:52 +00:00
< img src = "https://user-images.githubusercontent.com/16416509/110572995-718b5900-8195-11eb-802c-235c82a03bf7.png" >
2021-03-10 03:41:39 +00:00
2021-03-11 04:18:40 +00:00
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.
2021-03-10 03:38:49 +00:00
Depending on the severity of the exploit, we offer $50 - $500 for now.
2021-03-10 03:45:42 +00:00
Rewards based on Mirror's [donations ](https://github.com/sponsors/vis2k ), capped at amount of donations we received that month.
2021-03-10 03:38:49 +00:00
2021-03-10 03:39:19 +00:00
**Specifically we are looking for:**
2021-03-10 03:38:49 +00:00
* 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.
2021-03-10 03:39:19 +00:00
**Credits / past findings / fixes:**
2021-03-10 03:49:37 +00:00
* 2020, fholm: fuzzing ConnectMessage to stop further connects [[#2397 ](https://github.com/vis2k/Mirror/pull/2397 )]
2022-10-11 11:22:39 +00:00
---
# Credits & Thanks 🙏
🪞 **Alexey Abramychev (UNET)** < br />
🪞 **Alan** < br />
🪞 **c6burns** < br />
🪞 **Coburn** < br />
🪞 **cooper** < br />
🪞 **FakeByte** < br />
🪞 **fholm** < br />
🪞 **Gabe** (BigBoxVR)< br />
🪞 **imer** < br />
🪞 **James Frowen** < br />
🪞 **JesusLuvsYooh** < br />
🪞 **Mischa** < br />
🪞 **Mr. Gadget** < br />
🪞 **NinjaKickja** < br />
🪞 **Paul Pacheco** < br />
🪞 **Sean Riley** (UNET)< br />
