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
d06de6d9ce
Mirror/doc/index.md

54 lines
4.6 KiB
Markdown
Raw Normal View History

Update index.md
2019-09-05 17:16:12 +00:00
# Mirror Networking for Unity
New Documentation (#184) * Documentation Outline * Spacing adjustments * Captured old wiki content * yml fix * Docs work * resize images * Replaced images * Removed md from links * Renamed Misty to Fizzy * Captured Unity docs * links cleanup * clear links * Cleanup and moved NetworkBehavior to Classes. * added slashes to yml paths * reverted slashes * Fixes bad link * Update Ignorance.md This should be enough documentation for now, yeah? * Localized images * Update Ignorance.md formatting updates * Lots of Cleanup * fix link * Formatting * fix code blocks * Lots of content and cleanup * fixed yml * Added blank line * Added spaces in titles * tightened bullets * Fixed bullet spacing * Fixed more bullets * unbolded content * Cleanup and removal of empty pages Updated README with links to docs pages * Restored prior version * Contributing * Improvements to content * lower case fix * fix link * renamed Contributions * fixed link * home page content * Fixed Encoding * Moved Why TCP * Replaced Unity with Mirror * Telepathy Description * changed to h2 * Moved Sample down * Removed dead links * Copied Contributions Added Test Fixed h3's * Fixed headings * added to Test * Fixed image alts and links * fixed last alt
2018-12-26 22:07:24 +00:00
Updated home page doc
2019-07-04 15:47:35 +00:00
**Mirror is the most compatible direct replacement for the deprecated Unity Networking API.**
New Documentation (#184) * Documentation Outline * Spacing adjustments * Captured old wiki content * yml fix * Docs work * resize images * Replaced images * Removed md from links * Renamed Misty to Fizzy * Captured Unity docs * links cleanup * clear links * Cleanup and moved NetworkBehavior to Classes. * added slashes to yml paths * reverted slashes * Fixes bad link * Update Ignorance.md This should be enough documentation for now, yeah? * Localized images * Update Ignorance.md formatting updates * Lots of Cleanup * fix link * Formatting * fix code blocks * Lots of content and cleanup * fixed yml * Added blank line * Added spaces in titles * tightened bullets * Fixed bullet spacing * Fixed more bullets * unbolded content * Cleanup and removal of empty pages Updated README with links to docs pages * Restored prior version * Contributing * Improvements to content * lower case fix * fix link * renamed Contributions * fixed link * home page content * Fixed Encoding * Moved Why TCP * Replaced Unity with Mirror * Telepathy Description * changed to h2 * Moved Sample down * Removed dead links * Copied Contributions Added Test Fixed h3's * Fixed headings * added to Test * Fixed image alts and links * fixed last alt
2018-12-26 22:07:24 +00:00
Restructure docs (#2249) * moving all guides to Articles folder * updating toc for root and articles * fixing toc * css on side toc * fixing links on index
2020-09-16 21:27:05 +00:00
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](Articles/General/Migration.md) to do most of the work for you!
New Documentation (#184) * Documentation Outline * Spacing adjustments * Captured old wiki content * yml fix * Docs work * resize images * Replaced images * Removed md from links * Renamed Misty to Fizzy * Captured Unity docs * links cleanup * clear links * Cleanup and moved NetworkBehavior to Classes. * added slashes to yml paths * reverted slashes * Fixes bad link * Update Ignorance.md This should be enough documentation for now, yeah? * Localized images * Update Ignorance.md formatting updates * Lots of Cleanup * fix link * Formatting * fix code blocks * Lots of content and cleanup * fixed yml * Added blank line * Added spaces in titles * tightened bullets * Fixed bullet spacing * Fixed more bullets * unbolded content * Cleanup and removal of empty pages Updated README with links to docs pages * Restored prior version * Contributing * Improvements to content * lower case fix * fix link * renamed Contributions * fixed link * home page content * Fixed Encoding * Moved Why TCP * Replaced Unity with Mirror * Telepathy Description * changed to h2 * Moved Sample down * Removed dead links * Copied Contributions Added Test Fixed h3's * Fixed headings * added to Test * Fixed image alts and links * fixed last alt
2018-12-26 22:07:24 +00:00
doc links as they should be
2019-09-21 00:55:52 +00:00
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](https://assetstore.unity.com/packages/templates/systems/ummorpg-51212), [uSurvival](https://assetstore.unity.com/packages/templates/systems/usurvival-95015), [Cubica](https://www.cubica.net/), and [more](https://mirror-networking.com/showcase/)!
New Documentation (#184) * Documentation Outline * Spacing adjustments * Captured old wiki content * yml fix * Docs work * resize images * Replaced images * Removed md from links * Renamed Misty to Fizzy * Captured Unity docs * links cleanup * clear links * Cleanup and moved NetworkBehavior to Classes. * added slashes to yml paths * reverted slashes * Fixes bad link * Update Ignorance.md This should be enough documentation for now, yeah? * Localized images * Update Ignorance.md formatting updates * Lots of Cleanup * fix link * Formatting * fix code blocks * Lots of content and cleanup * fixed yml * Added blank line * Added spaces in titles * tightened bullets * Fixed bullet spacing * Fixed more bullets * unbolded content * Cleanup and removal of empty pages Updated README with links to docs pages * Restored prior version * Contributing * Improvements to content * lower case fix * fix link * renamed Contributions * fixed link * home page content * Fixed Encoding * Moved Why TCP * Replaced Unity with Mirror * Telepathy Description * changed to h2 * Moved Sample down * Removed dead links * Copied Contributions Added Test Fixed h3's * Fixed headings * added to Test * Fixed image alts and links * fixed last alt
2018-12-26 22:07:24 +00:00
Updated home page doc
2019-07-04 15:47:35 +00:00
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](https://discord.gg/2BvnM4R) for prompt support
Update documentation recommended version
2020-07-30 17:11:07 +00:00
- **Requires Unity 2018.4 LTS and Runtime .Net 4.x (default in Unity 2019) and .Net 2.0 Compatibility is recommended**
Updated home page doc
2019-07-04 15:47:35 +00:00
- Alpha / Beta Unity versions cannot be supported
**Multiple Transports Available:**
Restructure docs (#2249) * moving all guides to Articles folder * updating toc for root and articles * fixing toc * css on side toc * fixing links on index
2020-09-16 21:27:05 +00:00
- **TCP** ([Telepathy](Articles/Transports/Telepathy.md) and [Apathy](https://mirror-networking.com/apathy/) and [Booster](https://mirror-networking.com/booster/))
docs: Updating transport docs (#2337) * updating transport pages on litenetlib and simpleweb transports * updating other pages to reference new transports * updating links for new transports
2020-10-16 18:01:39 +00:00
- **UDP** ([ENet](Articles/Transports/Ignorance.md) and [LiteNetLib](Articles/Transports/LiteNetLibTransport.md))
- **WebGL** ([Secure Web Sockets](Articles/Transports/SimpleWebTransport.md))
Restructure docs (#2249) * moving all guides to Articles folder * updating toc for root and articles * fixing toc * css on side toc * fixing links on index
2020-09-16 21:27:05 +00:00
- **Steam** ([Steamworks.Net](Articles/Transports/FizzySteamworks.md)) and ([FacePunch](Articles/Transports/FizzyFacepunch.md))
- **Multiplexer** ([Multiplexer](Articles/Transports/Multiplexer.md))
- **Fallback** ([Fallback](Articles/Transports/Fallback.md))
Updated home page doc
2019-07-04 15:47:35 +00:00
**List Server**
We've developed a [List Server](https://mirror-networking.com/list-server/) where game servers can register and clients can connect to find those servers to play on them.
**Key Features & Components:**
Restructure docs (#2249) * moving all guides to Articles folder * updating toc for root and articles * fixing toc * css on side toc * fixing links on index
2020-09-16 21:27:05 +00:00
- [Transports](Articles/Transports/index.md) are interchangeable components
doc: Updated index doc
2020-05-07 07:25:30 +00:00
- Additive Scene handling
Updated home page doc
2019-07-04 15:47:35 +00:00
- Single and separated Unity projects supported
Update index.md making links include Network
2020-09-16 23:29:55 +00:00
- [Network Authenticators](Articles/Components/Authenticators/index.md) to manage access to your game
- [Network Discovery](Articles/Components/NetworkDiscovery.md) to easily connect LAN players to a LAN Server or Host
- [Network Manager](Articles/Components/NetworkManager.md) and [HUD](Articles/Components/NetworkManagerHUD.md)
- [Network Room Manager](Articles/Components/NetworkRoomManager.md) and [Room Player](Articles/Components/NetworkRoomPlayer.md)
- [Network Identity](Articles/Components/NetworkIdentity.md)
- [Network Transform](Articles/Components/NetworkTransform.md) to sync position, rotation, and scale with interpolation
- [Network Animator](Articles/Components/NetworkAnimator.md) with 64 parameters
- [Network Proximity Checker](Articles/Components/NetworkProximityChecker.md) to help with Area of Interest
- [Network Scene Checker](Articles/Components/NetworkSceneChecker.md) to isolate players and networked objects to Additive scene instances
- [Network Match Checker](Articles/Components/NetworkMatchChecker.md) to isolate players and networked objects by [Network Visibility](Articles/Guides/Visibility.md)
Restructure docs (#2249) * moving all guides to Articles folder * updating toc for root and articles * fixing toc * css on side toc * fixing links on index
2020-09-16 21:27:05 +00:00
- [SyncVar](Articles/Guides/Sync/SyncVars.md), [SyncList](Articles/Guides/Sync/SyncLists.md), [SyncDictionary](Articles/Guides/Sync/SyncDictionary.md), and [SyncHashSet](Articles/Guides/Sync/SyncHashSet.md)
Updated home page doc
2019-07-04 15:47:35 +00:00
**Integrations**
- [Dissonance Voice Chat](https://assetstore.unity.com/packages/tools/audio/dissonance-voice-chat-70078)
- [Network Sync Transform](https://github.com/emotitron/NetworkSyncTransform)
- [Noble Connect Free](https://assetstore.unity.com/packages/tools/network/noble-connect-free-141599)
- [Rucksack](https://assetstore.unity.com/packages/templates/systems/rucksack-multiplayer-inventory-system-114921)
- [RTS Engine](https://assetstore.unity.com/packages/templates/packs/rts-engine-79732)
- [Smooth Sync](https://assetstore.unity.com/packages/tools/network/smooth-sync-96925)
- [Weather Maker](https://assetstore.unity.com/packages/tools/particles-effects/weather-maker-unity-weather-system-sky-water-volumetric-clouds-a-60955)
docs: Updated various documents
2020-02-18 04:10:47 +00:00
- [Steamworks Networking](https://assetstore.unity.com/packages/tools/integration/steamworks-networking-151300)
- [Master Audio Multiplayer](https://assetstore.unity.com/packages/tools/audio/master-audio-multiplayer-69547)
Reference in New Issue Copy Permalink