charleslemaux/Mirror
1
0
Fork 0
mirror of https://github.com/MirrorNetworking/Mirror.git synced 2024-11-18 11:00:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
8ff560fedf
Mirror/doc/index.md
Paul Pacheco 35fee94d56
docs: switch to docfx for documentation (#1026) 
* Moved doc files to docfx folder

* load csproj

* doc generation

* Run docfx

* Add docfx

* Deploy docs to mirror-networking.com

* use deploy phase

* deploy whole generated site

* Fixed the semantic release command

* Is last \ required?

* show debug log

* using lftp for site deploy

* Testing lftp

* Show current folder

* try -e command option

* Show me the files

* use plain ftp

* use choco install instead of cinst

* fix ssl certificate validation

* fix username

* Upload site to xmldocs folder

* no need to archive docs

* No need for debug output

* Fix file permissions

* show me .htaccess

* Show me contents

* Wipe out folder to fix permissions

* Set file permissions

* Fix file permissions

* complete toc list

* Migrated intro page

* Remove old docs

* Update link to docs

* Add link to github

* Only update docs for stuff in master

* This is a powershell command

* Update doc/articles/Concepts/Communications/RemoteActions.md

* Update doc/articles/Concepts/VisibilityCustom.md

* Update doc/articles/Concepts/Authority.md

* Update doc/articles/Concepts/GameObjects/SpawnObjectCustom.md

* Update doc/articles/Concepts/Authority.md

* Update doc/articles/Classes/SyncVars.md

* No need to run semver twice
2019-08-24 10:20:33 -05:00

3.4 KiB
Raw Blame History

Documentation

Mirror is the most compatible direct replacement for the deprecated Unity Networking API.

Mirror has nearly all of the components and features from UNet, making networking easy, concise and maintainable, whether you're starting from scratch or converting an existing project. We even have a Migration Tool to do most of the work for you!

Built to support games of any scale, from LAN party games to dedicated high-volume authoritative servers running hundreds of players, Mirror is the core networking solution for uMMORPG, uSurvival, Cubica, and more!

uMMORPG was possible with <6000 lines of code. We needed a networking library that allows us to launch our games, period!

  • Full Source included for debugging convenience

  • Several working examples included

  • Active Discord for prompt support

  • Requires Unity 2018.3.6+ and Runtime .Net 4.x

  • Alpha / Beta Unity versions cannot be supported

Multiple Transports Available:

List Server

We've developed a List Server where game servers can register and clients can connect to find those servers to play on them.

Key Features & Components:

Integrations