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

improve readme by merging documentation and migration guide. usage guide renamed to installation.

Browse Source
This commit is contained in:
vis2k 2019-03-16 10:37:29 +01:00
parent 23d83afcd2
commit 4e099fab54
1 changed files with 3 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -25,12 +25,9 @@ _Note: Mirror is based on Unity's abandoned UNET Networking system. We fixed it
## Documentation ## Documentation
Check out our [Documentation](https://vis2k.github.io/Mirror/). Check out our [Documentation](https://vis2k.github.io/Mirror/).
If you are migrating from UNET, then please check out our [Migration Guide](https://vis2k.github.io/Mirror/General/Migration). Don't panic, it's very easy and won't take more than 5 minutes.
The main difference is that you have to use `using Mirror;` instead of `using UnityEngine.Networking;` at the top of your scripts. ## Installation
_Oh, and you won't have to worry about channels, low level networking, [packet loss](https://forum.unity.com/threads/unet-deprecation-thread.543501/page-3#post-3597869), [lack of support](https://forum.unity.com/threads/is-hlapi-dead.517436/) or [bugs](https://issuetracker.unity3d.com/issues/unet-networkwriter-dot-write-causing-readstring-slash-readbytes-out-of-range-errors-in-clients) ever again. Mirror just works._
## Usage Guide
**If you are coming from a current UNET implementation or are seeking the stable version:** **If you are coming from a current UNET implementation or are seeking the stable version:**
@ -41,10 +38,7 @@ Import mirror from the [Asset Store](https://www.assetstore.unity3d.com/#!/conte
*Note: New releases are bleeding edge and may come with undiscovered bugs. Use at your own risk!* *Note: New releases are bleeding edge and may come with undiscovered bugs. Use at your own risk!*
1. [Download Mirror](https://github.com/vis2k/Mirror/releases) (for Unity 2018.2.20 or 2018.3.x). 1. [Download Mirror](https://github.com/vis2k/Mirror/releases) (for Unity 2018.2.20 or 2018.3.x).
2. Decompress the zip file in Assets 2. Decompress the zip file in your Assets folder
## Migration Guide
If you are still using UNET and want to switch to Mirror, you should check out our [Migration Guide](https://vis2k.github.io/Mirror/General/Migration). Don't panic, it's very easy and won't take more than 5 minutes.
## Example Projects ## Example Projects
Download Mirror from the [Asset Store](https://www.assetstore.unity3d.com/#!/content/129321), we have several small example projects included. Download Mirror from the [Asset Store](https://www.assetstore.unity3d.com/#!/content/129321), we have several small example projects included.