charleslemaux/Mirror
1
0
Fork 0
mirror of https://github.com/MirrorNetworking/Mirror.git synced 2024-11-18 19:10:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
aac498df4b
Mirror/docs/_data/navigation.yml

179 lines
5.5 KiB
YAML
Raw Normal View History

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
- title: "General"
children:
- title: "Overview"
url: "/General"
- title: "Getting Started"
url: "/General/Start"
- title: "Migration Guide"
url: "/General/Migration"
- title: "Deprecations"
url: "/General/Deprecations"
Docs (#497) * Showcase and ChangeLog docs * Fixed image file extension
2019-02-28 16:29:06 +00:00
- title: "ChangeLog"
url: "/General/ChangeLog"
- title: "Showcase"
url: "/General/Showcase"
Updated Navigation for Integrations
2019-03-22 16:27:40 +00:00
- title: "Integrations"
url: "/General/Integrations"
Docs (#497) * Showcase and ChangeLog docs * Fixed image file extension
2019-02-28 16:29:06 +00:00
- title: "Why TCP?"
url: "/General/WhyTCP"
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
- title: "Support"
url: "/General/Support"
- title: "Concepts"
children:
- title: "Overview"
url: "/Concepts"
- title: "Authority"
url: "/Concepts/Authority"
- title: "About IDs"
url: "/Concepts/IDs"
- title: "Clients and Servers"
url: "/Concepts/ClientsServers"
Document authentication (#575)
2019-03-09 22:01:35 +00:00
- title: "Authentication"
url: "/Concepts/Authentication"
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
- title: "Conversion"
url: "/Concepts/Conversion"
- title: "Debugging"
url: "/Concepts/Debugging"
- title: "HLAPI"
url: "/Concepts/HLAPI"
- title: "Clock Synchronization"
url: "/Concepts/ClockSync"
- title: "Mobile Tips"
url: "/Concepts/MobileTips"
- title: "Project Setup"
url: "/Concepts/Setup"
- title: "State Syncronization"
url: "/Concepts/StateSync"
- title: "Advanced State Syncronization"
url: "/Concepts/StateSyncAdvanced"
- title: "Visibility"
url: "/Concepts/Visibility"
- title: "Custom Visibility"
url: "/Concepts/VisibilityCustom"
- title: "Communications"
children:
- title: "Overview"
url: "/Concepts/Communications"
- title: "Remote Actions"
url: "/Concepts/Communications/RemoteActions"
- title: "Network Manager Callbacks"
url: "/Concepts/Communications/NetworkManager"
- title: "Network Behavior Callbacks"
url: "/Concepts/Communications/NetworkBehavior"
- title: "Network Messages"
url: "/Concepts/Communications/NetworkMessages"
- title: "GameObjects"
children:
- title: "Overview"
url: "/Concepts/GameObjects"
- title: "Spawn Player"
url: "/Concepts/GameObjects/SpawnPlayer"
- title: "Spawn Player - Custom"
url: "/Concepts/GameObjects/SpawnPlayerCustom"
- title: "Spawn Object"
url: "/Concepts/GameObjects/SpawnObject"
- title: "Spawn Object - Custom"
url: "/Concepts/GameObjects/SpawnObjectCustom"
- title: "Scene Objects"
url: "/Concepts/GameObjects/SceneObjects"
- title: "Components"
children:
- title: "Overview"
url: "/Components"
- title: "NetworkManager"
url: "/Components/NetworkManager"
Network Lobby Manager & Lobby Player (#356) * Initial Commit with Unity's Network Lobby Components * Lobby Components WIP * Massive simplifications and structural changes to NetworkLobbyManager and NetworkLobbyPlayer * Replaced more default messages with Command structure resulting in further simplification and less LOC * Completed removal of messages * Code Formatting and GUI Layout * Fixed bugs and finished Remove feature in UI * Added Network Lobby Manager Doc * Network Lobby Docs * Network Lobby Player Doc * Updated doc and image about Offline Scene * changed to PNG * Added Lobby components to navigation * Conformed to naming convention Removed some leftover cruft Removed maxPlayers (redundant to maxConnections) Trapped and killed null ref in OnServerDisconnect * Fixed mistake in OnServerDisconnect * Fix Active Scene check * Alow clean switch to Offline scene * Add Help URL attributes to components * Added Help URL Attributes * Fixed OnGUI logic error. * Added Example and README * Fixed Disconnect handler * Updated Docs * Added Header for Inspector * Finished Lobby Example Minigame * Minor cleanup * Set targetFramerates * Code Cleanup Changed to extended Lobby Manager for player Indexes & colors * Minor changes to align with Mirror's NetworkManager * Fixed logic error * SyncVar Hook Workaround Random Start Positions * Revert making CallOnClientEnterLobby public * Added documentation to the extension * Minor code rearrangement * Made OnGUI virtual so it can be overridden. Added AllPlayersReady bool for convenience to extenders Start Game enhancement to example. * added comments * Corrected namespaces and usings * Reworked DontDestroyOnLoad LobbyPlayer: Moved code from OnStartClient to Start Added LobbyPlayerExt to Lobby Example Code cleanup, added regions Fixed Start Game button bug * Final push of Lobby example to make sure it's complete. * Improved Lobby Example * Code cleanup * Added ground texture Set player camera angle Adjusted lighting angle * Updated ReadMe Cleaned up privates Fixed example to use SetParent Changed to 5 max connections in example * Prefab name fixes due to Mirror master's changes Changed camera handling and GamePlayer Prefab Two more SetParent fixes Demoted two warnings to information Added more comments to example scripts * Revisions based on Vis2K review...more to come. * Added f's where assigning literals to floats * Removed manual calls to SyncVar Hooks because the bug is now fixed. * Changed to GUILayout * wrapped in namespace * Changed to GUILayout * All changes per peer review * Renamed folder to Lobby. * Fix due to change in Mirror 1691 * Renamed Scenes Added LobbyScene property to OfflineGUI script.
2019-02-20 15:58:50 +00:00
- title: "NetworkLobbyManager"
url: "/Components/NetworkLobbyManager"
- title: "NetworkLobbyPlayer"
url: "/Components/NetworkLobbyPlayer"
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
- title: "NetworkManagerHUD"
url: "/Components/NetworkManagerHUD"
- title: "NetworkIdentity"
url: "/Components/NetworkIdentity"
- title: "NetworkStartPosition"
url: "/Components/NetworkStartPosition"
- title: "NetworkProximityChecker"
url: "/Components/NetworkProximityChecker"
- title: "NetworkTransform"
url: "/Components/NetworkTransform"
- title: "NetworkTransformChild"
url: "/Components/NetworkTransformChild"
- title: "NetworkAnimator"
url: "/Components/NetworkAnimator"
- title: "NetworkNavMeshAgent"
url: "/Components/NetworkNavMeshAgent"
- title: "NetworkController"
url: "/Components/NetworkController"
- title: "NetworkRigidbody"
url: "/Components/NetworkRigidbody"
Added documentation folder
2018-12-18 18:42:55 +00:00
- title: "Classes"
children:
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
- title: "Overview"
url: "/Classes"
- title: "NetworkServer"
url: "/Classes/NetworkServer"
- title: "NetworkConnection"
url: "/Classes/NetworkConnection"
- title: "NetworkClient"
url: "/Classes/NetworkClient"
- title: "NetworkBehavior"
url: "/Classes/NetworkBehavior"
- title: "Attributes"
url: "/Classes/Attributes"
- title: "SyncLists"
url: "/Classes/SyncLists"
Update navigation.yml Added navigation for SyncDictionary and SyncHashSet
2019-03-22 13:53:13 +00:00
- title: "SyncDictionary"
url: "/Classes/SyncDictionary"
- title: "SyncHashSet"
url: "/Classes/SyncHashSet"
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
- title: "Events"
children:
- title: "Application Events"
url: "/Events/Application"
- title: "Server Events"
url: "/Events/Server"
- title: "Client Events"
url: "/Events/Client"
- title: "Other Events"
url: "/Events/Other"
- title: "Messages"
children:
- title: "Overview"
url: "/Messages"
- title: "Transports"
children:
- title: "Overview"
url: "/Transports"
- title: "TCP - Telepathy"
url: "/Transports/Telepathy"
- title: "UDP - Ignorance"
url: "/Transports/Ignorance"
Update Transport Docs
2019-03-11 17:39:48 +00:00
- title: "UDP - LiteNetLib4Mirror"
url: "/Transports/LiteNetLib4Mirror"
- title: "WebGL - WebSockets"
url: "/Transports/WebSockets"
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
- title: "Steam - Fizzy"
url: "/Transports/Fizzy"
Update Transport Docs
2019-03-11 17:39:48 +00:00
- title: "Multiplexer - Multiplexer"
url: "/Transports/Multiplexer"
Added link for Insight
2019-01-07 17:04:15 +00:00
- title: "Socket - Insight"
url: "/Transports/Insight"
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
- title: "Sample Projects"
Added documentation folder
2018-12-18 18:42:55 +00:00
children:
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
- title: "Overview"
url: "/Samples"
- title: "Pong"
url: "/Samples/Pong"
- title: "Services"
children:
- title: "Overview"
url: "/Services"
- title: "Match Service"
url: "/Services/Match"
- title: "Chat Service"
url: "/Services/Chat"
- title: "NAT Service"
url: "/Services/NAT"
- title: "Relay Service"
url: "/Services/Relay"
Reference in New Issue Copy Permalink