charleslemaux/Mirror
1
0
Fork 0
mirror of https://github.com/MirrorNetworking/Mirror.git synced 2024-11-18 02:50:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
#1 Open Source Unity Networking Library
4,963 Commits 189 Branches 1,882 Tags 486 MiB
C# 99.6%
GLSL 0.3%
ae50ec751e
Go to file
vis2k ae50ec751e ClientScene: internal callbacks moved to NetworkClient
2021-03-07 19:04:31 +08:00
.github Update issue templates 2021-03-07 11:24:25 +08:00
Assets ClientScene: internal callbacks moved to NetworkClient 2021-03-07 19:04:31 +08:00
doc Documentation moved to https://mirror-networking.gitbook.io 2021-02-26 14:15:43 +08:00
Packages feat: KCP Transport (https://github.com/vis2k/kcp2k) (#2381) 2020-10-30 13:53:13 +01:00
ProjectSettings add preprocessordefine 2021-03-06 14:23:00 +08:00
UserSettings feat: KCP Transport (https://github.com/vis2k/kcp2k) (#2381) 2020-10-30 13:53:13 +01:00
.editorconfig ci: Release only if tests pass (#1692) 2020-04-11 20:46:44 -05:00
.gitattributes ensure future c# code has consistent EOL 2019-01-05 10:09:05 -06:00
.gitignore restored 1bitpack_kenny metas 2020-04-19 17:32:51 -04:00
.releaserc.yml Update release notes with breaking:xxxx comments (#2418) 2020-11-11 12:22:07 -06:00
appveyor.yml ci: if docs have errors, fail the PR (#2065) 2020-07-04 13:49:02 +02:00
CONTRIBUTING.md Update CONTRIBUTING.md 2020-11-29 11:50:54 +08:00
FUNDING.yml move the funding button to where github can find it 2019-12-13 06:42:15 -06:00
LICENSE Proper MIT license (#1431) 2020-01-13 11:38:34 +01:00
README.md Documentation moved to https://mirror-networking.gitbook.io 2021-02-26 14:15:43 +08:00
setversion.ps1 fix build with appveyor warning (#1340) 2019-12-21 14:20:06 -06:00

README.md

Mirror Logo

Download Documentation Showcase Video Tutorial Forum Build Coverage Discord release Roadmap

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.

Low Level Transports

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

Population: ONE
Population: ONE

Zooba
Zooba

SCP: Secret Laboratory
SCP: Secret Laboratory

Naïca Online
Naïca Online

Laurum Online
Laurum Online

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

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!