charleslemaux/Mirror
1
0
Fork 0
mirror of https://github.com/MirrorNetworking/Mirror.git synced 2024-11-17 18:40:33 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
vis2k 2020-09-08 16:49:11 +02:00 committed by GitHub
parent 4acddf46ae
commit 9aff8e3921
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -25,20 +25,7 @@ With Mirror, the **Server & Client are ONE** project _(hence the name)_. Instead
_Note: Mirror is based on Unity's abandoned UNET Networking system. We fixed it up and pushed it to MMO Scale._
## Documentation
Check out our [Documentation](https://mirror-networking.com/docs/).
If you are migrating from UNET, then please check out our [Migration Guide](https://mirror-networking.com/docs/General/Migration.html). Don't panic, it's very easy and won't take more than 5 minutes.
## Installation
Download [Mirror on the Asset Store](https://assetstore.unity.com/packages/tools/network/mirror-129321), open one of the examples & press Play!
## Examples
We included several smaller example projects in Mirror.
For a fully polished, complete project example, consider [uMMORPG](https://assetstore.unity.com/packages/templates/systems/ummorpg-components-edition-159401) or [uSurvival](https://assetstore.unity.com/packages/templates/systems/usurvival-95015).
## Transports
## Low Level Transports
Mirror supports many different low level networking transports:
* (built in) [Telepathy](https://github.com/vis2k/Telepathy): TCP
@ -49,6 +36,15 @@ Mirror supports many different low level networking transports:
* [Ignorance](https://github.com/SoftwareGuy/Ignorance/): ENET UDP
* [LiteNetLib4](https://github.com/MirrorNetworking/LiteNetLibTransport/) LiteNetLib UDP
## Documentation
## Getting Started
Download [Mirror on the Asset Store](https://assetstore.unity.com/packages/tools/network/mirror-129321), open one of the examples & press Play!
Check out our [Documentation](https://mirror-networking.com/docs/) to learn how it all works.
If you are migrating from UNET, then please check out our [Migration Guide](https://mirror-networking.com/docs/General/Migration.html). Don't panic, it's very easy and won't take more than 5 minutes.
## Donations & Priority Support
Please support [Mirror on GitHub](https://github.com/sponsors/vis2k). Priority support included!