Mirror/README.md

315 lines
21 KiB
Markdown
Raw Normal View History

![Mirror Logo](https://user-images.githubusercontent.com/16416509/119120944-6db26780-ba5f-11eb-9cdd-fc8500207f4d.png)
2021-05-21 10:58:47 +00:00
2020-01-18 22:00:50 +00:00
[![Download](https://img.shields.io/badge/asset_store-brightgreen.svg)](https://assetstore.unity.com/packages/tools/network/mirror-129321)
[![Documentation](https://img.shields.io/badge/docs-brightgreen.svg)](https://mirror-networking.gitbook.io/)
2020-11-11 13:56:52 +00:00
[![Showcase](https://img.shields.io/badge/showcase-brightgreen.svg)](https://mirror-networking.com/showcase/)
2021-12-10 00:32:24 +00:00
[![Video Tutorials](https://img.shields.io/badge/video_tutorial-brightgreen.svg)](https://mirror-networking.gitbook.io/docs/community-guides/video-tutorials)
2018-11-13 19:55:15 +00:00
[![Forum](https://img.shields.io/badge/forum-brightgreen.svg)](https://forum.unity.com/threads/mirror-networking-for-unity-aka-hlapi-community-edition.425437/)
2020-09-08 14:23:26 +00:00
[![Build](https://img.shields.io/appveyor/ci/vis2k73562/hlapi-community-edition/Mirror.svg)](https://ci.appveyor.com/project/vis2k73562/hlapi-community-edition/branch/mirror)
2023-08-15 12:50:35 +00:00
[![Discord](https://img.shields.io/discord/343440455738064897.svg)](https://discordapp.com/invite/xVW4nU4C34)
[![release](https://img.shields.io/github/release/vis2k/Mirror.svg)](https://github.com/vis2k/Mirror/releases/latest)
2021-06-21 15:09:03 +00:00
[![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://github.com/vis2k/Mirror/blob/master/LICENSE)
2020-12-16 03:09:53 +00:00
[![Roadmap](https://img.shields.io/badge/roadmap-blue.svg)](https://trello.com/b/fgAE7Tud)
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
2023-06-26 09:45:41 +00:00
The **#1** free **open source** game networking library for **Unity 2019 / 2020 / 2021 / 2022 LTS**.
Used **in production** by major hits like [**Population: ONE**](https://www.populationonevr.com/) and many [**more**](#made-with-mirror).
2023-01-24 17:34:47 +00:00
Originally based on [**UNET**](https://blog.unity.com/technology/announcing-unet-new-unity-multiplayer-technology): battle tested **since 2014** for 9 years and counting!
2020-09-08 16:22:10 +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) 🎮.
2022-10-11 10:03:36 +00:00
**Made in 🇩🇪🇺🇸🇬🇧🇸🇬🇹🇼 with ❤️**.
2021-05-21 10:58:47 +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
2022-10-11 10:03:36 +00:00
[SyncVar] public int health = 100;
// Lists, Dictionaries, Sets too
2022-10-11 10:03:36 +00:00
SyncList<Item> inventory = new SyncList<Item>();
// Server/Client-only code
2022-10-11 10:03:36 +00:00
[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
[ClientRpc] void RpcRespawn() {} // Server to all Clients
[TargetRpc] void Hello() {} // Server to one Client
2022-10-11 10:03:36 +00:00
}
```
2023-04-11 02:37:05 +00:00
There's also **NetworkServer** & **NetworkClient**.</br>
And that's about it 🤩
2021-05-21 10:58:47 +00:00
2022-10-11 10:03:36 +00:00
---
## Free, Open Source & Community Focused
2023-06-26 09:45:41 +00:00
**Mirror** is **free & open source** (MIT Licensed).
2021-05-20 08:27:17 +00:00
2023-06-26 09:45:41 +00:00
🍺 "**Free**" as in free beer, and freedom to use it any way you like.
2022-10-11 10:03:36 +00:00
2023-06-26 09:45:41 +00:00
- Host Game [Servers](https://mirror-networking.gitbook.io/docs/hosting/the-pragmatic-hosting-guide) anywhere!
- Customize anything freely!
- No paywalls, no CCU costs, no strings attached!
2020-09-08 15:36:34 +00:00
🤝 We are a team of **professional** game developers, who are paid to **use Mirror in production**. Our incentives will always align with the community, because we are Mirror users just like you!
2023-09-27 12:36:54 +00:00
❤️ Our [**fantastic community**](https://discordapp.com/invite/xVW4nU4C34) of over **14,000** users contributes feedback & improvements every day. Please join us on our journey, help others, and consider a [**Donation**](https://github.com/sponsors/miwarnec) if you love our work!
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
2023-06-26 09:45:41 +00:00
Get **Unity 2019 / 2020 / 2021 / 2022 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
Check out our [Documentation](https://mirror-networking.gitbook.io/) to learn how it all works.
2020-09-08 14:49:11 +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-12-21 20:19:38 +00:00
---
## Mirror LTS (Long Term Support)
Mirror LTS is available on the [Asset Store](https://assetstore.unity.com/packages/tools/network/mirror-lts-102631).
Mirror LTS gives you peace of mind to run your game in production.
Without any breaking changes, ever!
* **Bug fixes** only.
* **Consistent API**: update any time, without any breaking features.
* Lives along side **Unity 2019/2020/2021** LTS.
* Supported for two years at a time.
---
2020-11-11 13:24:21 +00:00
## Made with Mirror
### [Population: ONE](https://www.populationonevr.com/)
2023-07-27 04:43:47 +00:00
[![Population: ONE](https://github.com/MirrorNetworking/Mirror/assets/16416509/dddc778b-a97f-452d-b5f8-6ec42c6da4f1)](https://www.populationonevr.com/)
2022-12-12 20:52:00 +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.
2023-03-03 01:50:36 +00:00
**Population: ONE** was [acquired by Meta](https://uploadvr.com/population-one-facebook-bigbox-acquire/) in June 2021, and they've just released a new [Sandbox](https://www.youtube.com/watch?v=jcI0h8dn9tA) addon in 2022!
### [Swarm VR](https://www.swarmvrgame.com/)
[![swarmvr_compressed](https://user-images.githubusercontent.com/16416509/222610677-fa38f173-f76b-422f-b39d-8e0ef0cee798.jpg)](https://www.swarmvrgame.com/)
2023-03-03 01:54:27 +00:00
SPIDER-MAN WITH GUNS!
SWARM is a fast-paced, arcade-style grapple shooter, with quick sessions, bright colorful worlds and globally competitive leaderboards that will take you back to the glory days of Arcade Games.
2023-03-03 01:50:36 +00:00
Available for the [Meta Quest](https://www.oculus.com/experiences/quest/2236053486488156/), made with Mirror.
2022-12-12 20:49:21 +00:00
### [Nimoyd](https://www.nimoyd.com/)
2022-07-15 02:37:26 +00:00
[![nimoyd_smaller](https://user-images.githubusercontent.com/16416509/178142672-340bac2c-628a-4610-bbf1-8f718cb5b033.jpg)](https://www.nimoyd.com/)
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!_
2023-10-18 13:11:02 +00:00
### [Unleashed](https://www.unleashedgames.io/)
[![unleashed](https://github.com/MirrorNetworking/Mirror/assets/16416509/ef3bcf74-8fa9-4d22-801d-4d29cb59a013)](https://www.unleashedgames.io/)
2023-10-18 13:11:59 +00:00
From original devs of **World of Warcraft**, **Kingdoms of Amalur**, and **EverQuest** comes a new family friendly fantasy adventure. Fight against the forces of darkness, explore a world consumed by wild magic, and build a stronghold with your friends to increase your power in a new world.
2023-10-18 13:11:02 +00:00
_Lead by industry veterans Brian Birmingham & Irena Pereira, Unleashed is developing their next gen adventure game made with Mirror!_
2023-10-18 13:21:13 +00:00
Follow them on X: https://twitter.com/UnleashingGames/
2022-07-20 18:11:44 +00:00
### [Dinkum](https://store.steampowered.com/app/1062520/Dinkum/)
2022-07-20 18:11:25 +00:00
[![dinkum](https://user-images.githubusercontent.com/16416509/180051810-50c9ebfd-973b-4f2f-8448-d599443d9ce3.jpg)](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.
### [A Glimpse of Luna](https://www.glimpse-luna.com/)
2022-07-15 02:37:26 +00:00
[![a glimpse of luna](https://user-images.githubusercontent.com/16416509/178148229-5b619655-055a-4583-a1d3-18455bde631f.jpg)](https://www.glimpse-luna.com/)
[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
[![sun haven](https://user-images.githubusercontent.com/16416509/185836661-2bfd6cd0-523a-4af4-bac7-c202ed01de7d.jpg)](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.
2023-01-17 08:42:26 +00:00
### [A Township Tale](https://townshiptale.com/)
2023-01-17 08:44:33 +00:00
[![A Township Tale](https://user-images.githubusercontent.com/16416509/212850393-1abdce51-1abe-4745-8a7d-67e9ebae96a7.png)](https://townshiptale.com/)
2023-01-17 08:42:26 +00:00
A Township Tale is an immersive VR experience, where you can build towns and explore worlds with your friends.
Made with our KCP transport, available on the [Meta Quest Store](https://www.oculus.com/experiences/quest/2913958855307200/) with over 6000+ ratings.
### [Inferna](https://inferna.net/)
2022-07-15 02:37:26 +00:00
[![Inferna MMORPG](https://user-images.githubusercontent.com/16416509/178148768-5ba9ea5b-bcf1-4ace-ad7e-591f2185cbd5.jpg)](https://inferna.net/)
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
[![samutale](https://user-images.githubusercontent.com/16416509/178149040-b54e0fa1-3c41-4925-8428-efd0526f8d44.jpg)](https://www.samutale.com/)
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
[![Untamed Isles](https://user-images.githubusercontent.com/16416509/178143679-1c325b54-0938-4e84-97b6-b59db62a51e7.jpg)](https://store.steampowered.com/app/1823300/Untamed_Isles/)
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
[![Zooba](https://user-images.githubusercontent.com/16416509/178141846-60805ad5-5a6e-4840-8744-5194756c2a6d.jpg)](https://play.google.com/store/apps/details?id=com.wildlife.games.battle.royale.free.zooba&gl=US)
[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/)
[![Portals](https://user-images.githubusercontent.com/9826063/209373815-8e6288ba-22fc-4cee-8867-19f587188827.png)](https://theportal.to/)
Animal Crossing meets Yakuza meets Minecraft — a city builder with a multiplayer central hub. Gather, trade and build — all in the browser!
2022-09-15 04:27:29 +00:00
### [SCP: Secret Laboratory](https://scpslgame.com/)
2022-07-15 02:37:26 +00:00
[![scp - secret laboratory_smaller](https://user-images.githubusercontent.com/16416509/178142224-413b3455-cdff-472e-b918-4246631af12f.jpg)](https://scpslgame.com/)
[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
[![Naica Online](https://user-images.githubusercontent.com/16416509/178147710-8ed83bbd-1bce-4e14-8465-edfb40af7c7f.png)](https://naicaonline.com/)
[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
[![Laurum Online](https://user-images.githubusercontent.com/16416509/178149616-3852d198-6fc9-44d5-9f63-da4e52f5546a.jpg)](https://laurum.online/)
[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/)
[![Empires Mobile](https://user-images.githubusercontent.com/16416509/207028553-c646f12c-c164-47d3-a1fc-ff79409c04fa.jpg)](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-12-13 12:06:07 +00:00
### [Castaways](https://www.castaways.com/)
[![Castaways](https://user-images.githubusercontent.com/16416509/207313082-e6b95590-80c6-4685-b0d1-f1c39c236316.png)](https://www.castaways.com/)
[Castaways](https://www.castaways.com/) is a sandbox game where you are castaway to a small remote island where you must work with others to survive and build a thriving new civilization.
Castaway runs in the Browser, thanks to Mirror's WebGL support.
2023-08-04 09:43:56 +00:00
### [Overpowered](https://overpoweredcardgame.com/)
[![Overpowered](https://github.com/MirrorNetworking/Mirror/assets/16416509/5bdbb227-970d-434e-b062-94fde1297f7c)](https://overpoweredcardgame.com/)
[Overwpowered](https://overpoweredcardgame.com/), the exciting new card game that combines strategy, myth, and fun into one riveting web-based experience. Launched in 2023, made with Mirror!
### 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>
<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>
2023-06-26 04:02:09 +00:00
<a href="https://store.steampowered.com/app/1970020/__Touhou_Fairy_Knockout__One_fairy_to_rule_them_all/"><img src="https://github.com/MirrorNetworking/Mirror/assets/16416509/dc1286a8-b619-4f68-9dfe-6a501be7e233" title="Touhou Fairy Knockout" height="100"/></a>
2023-07-21 11:05:37 +00:00
<a href="https://store.steampowered.com/app/2168680/Nuclear_Option/"><img src="https://github.com/MirrorNetworking/Mirror/assets/16416509/4e98520e-9bde-4305-8b02-bada090a02dd" title="Nuclear Option" height="100"/></a>
<a href="https://store.steampowered.com/app/2499940/Shattered_Lands/"><img src="https://github.com/MirrorNetworking/Mirror/assets/57072365/52930403-c1d1-4c27-9477-e03215acbda5" title="Shattered Lands" height="100"/></a>
2023-11-08 08:51:15 +00:00
<a href="https://store.steampowered.com/app/1955340/Super_Raft_Boat_Together"><img src="https://github.com/MirrorNetworking/Mirror/assets/57072365/0d30b84a-0b2b-4790-8687-d95e2fa23df1" title="Super Raft Boat Together" height="100"/></a>
2021-03-10 04:09:54 +00:00
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)
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.
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
---
# Information Security
2023-06-14 08:09:12 +00:00
![Mirror alternative Logo](https://github.com/MirrorNetworking/Mirror/assets/16416509/ca26e97c-2f26-487d-a48e-e23ec762bc79)
2023-06-14 08:13:05 +00:00
**Mirror-Networking** follows common information security industry standards & best practices.
Mirror is free open source software (**MIT Licensed**), with over 80% test coverage. The company is located in Germany. We do not collect any user data, impose no restrictions on users & developers, or rely on any closed source dependencies other than Unity.
2023-06-14 08:13:43 +00:00
This makes Mirror an attractive choice for government agencies and large corporations with strict information security requirements.
Feel free to reach out to business [**at**] mirror-networking.com if you have any questions, or need to review any of our policies:
* **Development best Practices and SDLC**.pdf
* **Disaster Recovery Procedure**.pdf
* **Document Retention and Destruction Policy**.pdf
* **Encryption Policy**.pdf
* **Information Security Guidelines**.pdf
* **[Privacy Policy](https://mirror-networking.com/privacy-policy/)**
* **[Security Policy](https://github.com/MirrorNetworking/Mirror/blob/master/SECURITY.md)**
* **Vulnerability Management Policy**.pdf
2023-06-14 08:14:54 +00:00
Please reach out if you decide to use Mirror.
We are excited to hear about your project, and happy to help if needed!
2022-10-11 10:03:36 +00:00
---
2023-01-25 12:08:44 +00:00
# Incident Response & Bug Bounty
2023-01-25 12:19:02 +00:00
A lot of projects use Mirror in production. If you found a critical bug / exploit in Mirror core, please follow the steps outlined in our [Security Policy](SECURITY.md).
2021-03-10 03:38:49 +00:00
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)]
2023-06-08 01:51:41 +00:00
* 2023-04-05: IncludeSec: [kcp2k UDP spoofing](http://blog.includesecurity.com/?p=1407) [[#3286](https://github.com/vis2k/Mirror/pull/3286)]
2023-07-27 08:28:11 +00:00
* 2023-06-27: James Frowen: ClientToServer [SyncVar] [allocation attacks](https://github.com/MirrorNetworking/Mirror/pull/3562)
2022-10-11 11:22:39 +00:00
---
# Credits & Thanks 🙏
2022-12-23 21:56:45 +00:00
🪞 **Alexey Abramychev** (UNET)<br/>
2022-10-11 11:22:39 +00:00
🪞 **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/>