Skip to content

unitystation/Mirror

 
 

Repository files navigation

Mirror Logo

HOW TO UPDATE FOR Unitystation, Bump the version number in Mirror\Assets\Mirror\package.json

Then go to the main project and unitystation\UnityProject\Packages\packages-lock.json go to "org.unitystation.spacemirror": and And delete the hash In the hash field And it should grab the most up-to-date version

Mirror Networking

The #1 free open source game networking library for Unity 2019 / 2020 / 2021.

Used in production by major hits like Population: ONE and many more.

Originally based on UNET: battle tested since 2014 for 9 years and counting!

Mirror is stable, modular & easy to use for all types of games, even small MMORPGs 🎮.

Made in 🇩🇪🇺🇸🇬🇧🇸🇬🇹🇼 with ❤️.


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:

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
    [ClientRpc] void RpcRespawn() {}         // server to all clients
    [TargetRpc] void Hello() {}              // server to one client
}

There's also NetworkServer & NetworkClient. And that's about it 🤩.


Free, Open & Community Funded

Mirror is free & open source (MIT Licensed).

"Free" as in free beer, and freedom to use it any way you like.

Mirror is funded by Donations from our fantastic community of over 14,000 users!

The top quote is from Fitzcarraldo, which is quite reminiscent of this project.


Getting Started

Get Unity 2019 / 2020 / 2021 LTS, Download Mirror, 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.


Mirror LTS (Long Term Support)

Mirror LTS is available on the Asset Store.

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.

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 acquired by Meta in June 2021, and they've just released a new Sandbox addon in 2022!

swarmvr_compressed 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.

Available for the Meta Quest, made with Mirror.

nimoyd_smaller 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!

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 in 2019.

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.

sun haven 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, Sun Haven was released on Steam in 2021 and later on ported to Mirror in 2022.

A Township Tale 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 with over 6000+ ratings.

Inferna MMORPG 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.

Portals Animal Crossing meets Yakuza meets Minecraft — a city builder with a multiplayer central hub. Gather, trade and build — all in the browser!

scp - secret laboratory_smaller 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.

Naica 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.

Empires Mobile Empires Mobile - Retro mobile MMORPG for Android and iOS, reaching 5000 CCU at times. Check out their video for some early MMORPG nostalgia.

Castaways Castaways 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.

And many more...

Modular Transports

Mirror uses KCP (reliable UDP) by default, but you may use any of our community transports for low level packet sending:

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.

We prefer to work slow & thoroughly in order to not break everyone's games 🐌.

Therefore, we need to KISS 😗.


Incident Response & Bug Bounty

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.

Credits / past findings / fixes:

  • 2020, fholm: fuzzing ConnectMessage to stop further connects [#2397]

Credits & Thanks 🙏

🪞 Alexey Abramychev (UNET)
🪞 Alan
🪞 c6burns
🪞 Coburn
🪞 cooper
🪞 FakeByte
🪞 fholm
🪞 Gabe (BigBoxVR)
🪞 imer
🪞 James Frowen
🪞 JesusLuvsYooh
🪞 Mischa
🪞 Mr. Gadget
🪞 NinjaKickja
🪞 Paul Pacheco
🪞 Sean Riley (UNET)