diff --git a/Assets/Mirror/Runtime/doc.csproj b/Assets/Mirror/Runtime/doc.csproj
new file mode 100644
index 000000000..9033c1a1d
--- /dev/null
+++ b/Assets/Mirror/Runtime/doc.csproj
@@ -0,0 +1,11 @@
+
+
+ netstandard2.0
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/README.md b/README.md
index bc647a4a0..511d8dcdc 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
[](https://www.assetstore.unity3d.com/#!/content/129321)
-[](https://vis2k.github.io/Mirror/)
+[](https://mirror-networking.com/xmldocs)
[](https://forum.unity.com/threads/mirror-networking-for-unity-aka-hlapi-community-edition.425437/)
[](https://www.patreon.com/MirrorNetworking)
[](https://ci.appveyor.com/project/vis2k73562/hlapi-community-edition/branch/mirror)
diff --git a/appveyor.yml b/appveyor.yml
index 1c061686f..3816be84c 100644
--- a/appveyor.yml
+++ b/appveyor.yml
@@ -7,14 +7,11 @@ version: '{branch}-{build}'
# - ps: $blockRdp = $true; iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/appveyor/ci/master/scripts/enable-rdp.ps1'))
install:
- - set PATH=C:\Ruby25-x64\bin;%PATH%
- - cd docs
- - gem install bundler -v 1.17.3
- - bundle install
- - cd ..
- - cp c:\Tools\curl\bin\libcurl.dll C:\Ruby25-x64\bin
- choco install unitypackager
-
+ - choco install docfx
+ - choco install lftp
+ - npm install -g semantic-release@15
+
#build:
# project: Mirror/Networking.sln
# verbosity: minimal
@@ -23,10 +20,8 @@ install:
skip_tags: true
build_script:
- - cd docs
- - bundle exec jekyll build
- - ruby checksite.rb
- - cd ..
+ - docfx metadata doc\docfx.json
+ - docfx build doc\docfx.json
after_build:
- RMDIR /Q /S Assets\Mirror\Tests
@@ -40,8 +35,11 @@ artifacts:
image: Visual Studio 2017
-before_deploy:
- - npm install -g semantic-release@15
+environment:
+ LFTP_PASSWORD:
+ secure: sH23IC4a98S5uTtgYNHNvg==
deploy_script:
- semantic-release
+ - ps: IF ($env:APPVEYOR_REPO_BRANCH -eq "master") { lftp -e 'set ftp:ssl-allow no ; mirror -R -c -e -p doc/_site public_html/xmldocs; chmod -R a+X public_html/xmldocs ; ls -l public_html/xmldocs/ ; ls -l public_html/xmldocs/styles/ ; bye' -u mirreofx --env-password ftp://mirror-networking.com }
+
diff --git a/doc/.gitignore b/doc/.gitignore
new file mode 100644
index 000000000..4378419e7
--- /dev/null
+++ b/doc/.gitignore
@@ -0,0 +1,9 @@
+###############
+# folder #
+###############
+/**/DROP/
+/**/TEMP/
+/**/packages/
+/**/bin/
+/**/obj/
+_site
diff --git a/doc/api/.gitignore b/doc/api/.gitignore
new file mode 100644
index 000000000..e8079a3be
--- /dev/null
+++ b/doc/api/.gitignore
@@ -0,0 +1,5 @@
+###############
+# temp file #
+###############
+*.yml
+.manifest
diff --git a/doc/api/index.md b/doc/api/index.md
new file mode 100644
index 000000000..78dc9c005
--- /dev/null
+++ b/doc/api/index.md
@@ -0,0 +1,2 @@
+# PLACEHOLDER
+TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*!
diff --git a/docs/Classes/Attributes.md b/doc/articles/Classes/Attributes.md
similarity index 76%
rename from docs/Classes/Attributes.md
rename to doc/articles/Classes/Attributes.md
index e7f081e0a..369862126 100644
--- a/docs/Classes/Attributes.md
+++ b/doc/articles/Classes/Attributes.md
@@ -20,13 +20,13 @@ These attributes can be used for Unity game loop methods like Start or Update, a
A Custom Attribute that can be added to member functions of NetworkBehaviour scripts, to make them only run on clients, but not generate warnings.
- **ClientRpc**
- The server uses a Remote Procedure Call (RPC) to run that function on clients. See also: [Remote Actions](../Concepts/Communications/RemoteActions)
+ The server uses a Remote Procedure Call (RPC) to run that function on clients. See also: [Remote Actions](../Concepts/Communications/RemoteActions.md)
- **TargetRpc**
- This is an attribute that can be put on methods of NetworkBehaviour classes to allow them to be invoked on clients from a server. Unlike the ClientRpc attribute, these functions are invoked on one individual target client, not all of the ready clients. See also: [Remote Actions](../Concepts/Communications/RemoteActions)
+ This is an attribute that can be put on methods of NetworkBehaviour classes to allow them to be invoked on clients from a server. Unlike the ClientRpc attribute, these functions are invoked on one individual target client, not all of the ready clients. See also: [Remote Actions](../Concepts/Communications/RemoteActions.md)
- **Command**
- Call this from a client to run this function on the server. Make sure to validate input etc. It's not possible to call this from a server. Use this as a wrapper around another function, if you want to call it from the server too. See also [Remote Actions](../Concepts/Communications/RemoteActions)
+ Call this from a client to run this function on the server. Make sure to validate input etc. It's not possible to call this from a server. Use this as a wrapper around another function, if you want to call it from the server too. See also [Remote Actions](../Concepts/Communications/RemoteActions.md)
The allowed argument types are:
- Basic type (byte, int, float, string, UInt64, etc)
@@ -42,7 +42,7 @@ These attributes can be used for Unity game loop methods like Start or Update, a
- Game object with a NetworkIdentity component attached.
- **SyncVar**
- [SyncVars](SyncVars) are used to synchronize a variable from the server to all clients automatically. Don't assign them from a client, it's pointless. Don't let them be null, you will get errors. You can use int, long, float, string, Vector3 etc. (all simple types) and NetworkIdentity and game object if the game object has a NetworkIdentity attached to it. You can use [hooks](SyncVarHook).
+ [SyncVars](SyncVars.md) are used to synchronize a variable from the server to all clients automatically. Don't assign them from a client, it's pointless. Don't let them be null, you will get errors. You can use int, long, float, string, Vector3 etc. (all simple types) and NetworkIdentity and game object if the game object has a NetworkIdentity attached to it. You can use [hooks](SyncVarHook.md).
- **SyncEvent**
- [SyncEvents](SyncEvents) are networked events like ClientRpc's, but instead of calling a function on the game object, they trigger Events instead.
+ [SyncEvent](SyncEvent.md) are networked events like ClientRpc's, but instead of calling a function on the game object, they trigger Events instead.
diff --git a/docs/Classes/NetworkBehaviour.md b/doc/articles/Classes/NetworkBehaviour.md
similarity index 96%
rename from docs/Classes/NetworkBehaviour.md
rename to doc/articles/Classes/NetworkBehaviour.md
index 19e652aaf..8d3e4ffba 100644
--- a/docs/Classes/NetworkBehaviour.md
+++ b/doc/articles/Classes/NetworkBehaviour.md
@@ -100,7 +100,7 @@ The `Server` and `Client` attributes are for your own custom callback functions.
The `ServerCallback` and `ClientCallback` attributes are for built-in callback functions that are called automatically by Mirror. These attributes do not cause a warning to be generated.
-For more information, see [Attributes](Attributes).
+For more information, see [Attributes](Attributes.md).
## Commands
@@ -120,7 +120,7 @@ Commands are called just by invoking the function normally on the client. Instea
Commands are type-safe, have built-in security and routing to the player, and use an efficient serialization mechanism for the arguments to make calling them fast.
-See [Communications](../Concepts/Communications) and related sections for more information.
+See [Communications](../Concepts/Communications/index.md) and related sections for more information.
## Client RPC Calls
@@ -134,7 +134,7 @@ To define a Client RPC call in your code, you must write a function which:
- Has the `ClientRPC` attribute
-See [Communications](../Concepts/Communications) and related sections for more information.
+See [Communications](../Concepts/Communications/index.md) and related sections for more information.
## Networked Events
@@ -152,6 +152,6 @@ You can use events to build powerful networked game systems that can be extended
SyncEvent is the base class that Commands and ClientRpc calls are derived from. You can use the SyncEvent attribute on your own functions to make your own event-driven networked game play code. Using SyncEvent, you can extend Mirror’s Multiplayer features to better fit your own programming patterns.
-See [SyncEvents](SyncEvent) for more details.
+See [SyncEvents](SyncEvent.md) for more details.
diff --git a/docs/Classes/NetworkClient.md b/doc/articles/Classes/NetworkClient.md
similarity index 97%
rename from docs/Classes/NetworkClient.md
rename to doc/articles/Classes/NetworkClient.md
index 76dbc2741..78d06e97e 100644
--- a/docs/Classes/NetworkClient.md
+++ b/doc/articles/Classes/NetworkClient.md
@@ -26,7 +26,7 @@
The IP address of the server this client is connected to.
- **serverPort**
- Deprecated. Port was moved to the [Transports](../Transports) that support it.
+ Deprecated. Port was moved to the [Transports](../Transports/index.md) that support it.
## Methods
diff --git a/docs/Classes/NetworkConnection.md b/doc/articles/Classes/NetworkConnection.md
similarity index 97%
rename from docs/Classes/NetworkConnection.md
rename to doc/articles/Classes/NetworkConnection.md
index 2e3e65b11..fee8f07c2 100644
--- a/docs/Classes/NetworkConnection.md
+++ b/doc/articles/Classes/NetworkConnection.md
@@ -22,7 +22,7 @@ Network Connection is a high-level API class that encapsulates a network connect
The incremented connectionId for this connection.
- **hostId**
- Deprecated. Use `connection.GetType() == typeof(NetworkConnection)` to check if it's a regular or local connection.
+ Deprecated. Use `connection.GetType() == typeof(NetworkConnection.md)` to check if it's a regular or local connection.
- **isReady**
Flag to control whether state updates are sent to this connection
@@ -31,7 +31,7 @@ Network Connection is a high-level API class that encapsulates a network connect
The last time that a message was received on this connection.
- **playerController**
- A reference to the [NetworkIdentity](../Components/NetworkIdentity) playerController.
+ A reference to the [NetworkIdentity](../Components/NetworkIdentity.md) playerController.
## Methods
diff --git a/docs/Classes/NetworkServer.md b/doc/articles/Classes/NetworkServer.md
similarity index 100%
rename from docs/Classes/NetworkServer.md
rename to doc/articles/Classes/NetworkServer.md
diff --git a/docs/Classes/SyncDictionary.md b/doc/articles/Classes/SyncDictionary.md
similarity index 94%
rename from docs/Classes/SyncDictionary.md
rename to doc/articles/Classes/SyncDictionary.md
index eb57e6b0b..6b169e55e 100644
--- a/docs/Classes/SyncDictionary.md
+++ b/doc/articles/Classes/SyncDictionary.md
@@ -12,7 +12,7 @@ A SyncDictionary is an associative array containing an unordered list of key, va
- Struct with any of the above
-SyncDictionary works much like [SyncLists](SyncLists): when you make a change on the server the change is propagated to all clients and the Callback is called.
+SyncDictionary works much like [SyncLists](SyncLists.md): when you make a change on the server the change is propagated to all clients and the Callback is called.
To use it, create a class that derives from SyncDictionary for your specific type. This is necessary because the Weaver will add methods to that class. Then add a field to your NetworkBehaviour class.
diff --git a/docs/Classes/SyncEvent.md b/doc/articles/Classes/SyncEvent.md
similarity index 100%
rename from docs/Classes/SyncEvent.md
rename to doc/articles/Classes/SyncEvent.md
diff --git a/docs/Classes/SyncHashSet.md b/doc/articles/Classes/SyncHashSet.md
similarity index 100%
rename from docs/Classes/SyncHashSet.md
rename to doc/articles/Classes/SyncHashSet.md
diff --git a/docs/Classes/SyncLists.md b/doc/articles/Classes/SyncLists.md
similarity index 100%
rename from docs/Classes/SyncLists.md
rename to doc/articles/Classes/SyncLists.md
diff --git a/docs/Classes/SyncSortedSet.md b/doc/articles/Classes/SyncSortedSet.md
similarity index 100%
rename from docs/Classes/SyncSortedSet.md
rename to doc/articles/Classes/SyncSortedSet.md
diff --git a/docs/Classes/SyncVarHook.md b/doc/articles/Classes/SyncVarHook.md
similarity index 100%
rename from docs/Classes/SyncVarHook.md
rename to doc/articles/Classes/SyncVarHook.md
diff --git a/docs/Classes/SyncVars.md b/doc/articles/Classes/SyncVars.md
similarity index 90%
rename from docs/Classes/SyncVars.md
rename to doc/articles/Classes/SyncVars.md
index 784ef6fae..ac373f256 100644
--- a/docs/Classes/SyncVars.md
+++ b/doc/articles/Classes/SyncVars.md
@@ -26,4 +26,4 @@ The server automatically sends SyncVar updates when the value of a SyncVar chang
## SyncVar Hooks
-The [SyncVar hook](SyncVarHook) attribute can be used to specify a method to be called when the SyncVar changes value on the client.
+The [SyncVar hook](SyncVarHook.md) attribute can be used to specify a method to be called when the SyncVar changes value on the client.
diff --git a/docs/Classes/UNetDirections.jpg b/doc/articles/Classes/UNetDirections.jpg
similarity index 100%
rename from docs/Classes/UNetDirections.jpg
rename to doc/articles/Classes/UNetDirections.jpg
diff --git a/docs/Classes/index.md b/doc/articles/Classes/index.md
similarity index 75%
rename from docs/Classes/index.md
rename to doc/articles/Classes/index.md
index b2bb218b2..6bfe9b7e2 100644
--- a/docs/Classes/index.md
+++ b/doc/articles/Classes/index.md
@@ -2,35 +2,35 @@
Mirror includes the following classes:
-- [NetworkServer](NetworkServer)
+- [NetworkServer](NetworkServer.md)
Network Server is a High-Level-API class that manages connections from multiple clients.
-- [NetworkClient](NetworkClient)
+- [NetworkClient](NetworkClient.md)
Network Client is a high-level API class that manages a network connection from a client to a server, and can send and receive messages between the client and the server.
-- [NetworkConnection](NetworkConnection)
+- [NetworkConnection](NetworkConnection.md)
Network Connection is a high-level API class that encapsulates a network connection.
-- [NetworkBehavior](NetworkBehavior)
+- [NetworkBehaviour](NetworkBehaviour.md)
Network Behaviour scripts work with game objects that have a NetworkIdentity component. These scripts can perform high-level API functions such as Commands, ClientRpc’s, SyncEvents and SyncVars.
-- [Attributes](Attributes)
+- [Attributes](Attributes.md)
Networking attributes are added to member functions of NetworkBehaviour scripts, to make them run on either the client or server.
-- [SyncVars](SyncVars)
+- [SyncVars](SyncVars.md)
SyncVars are variables of scripts that inherit from NetworkBehaviour, which are synchronized from the server to clients.
-- [SyncEvents](SyncEvent)
+- [SyncEvents](SyncEvent.md)
SyncEvents are networked events like ClientRpc’s, but instead of calling a function on the game object, they trigger Events instead.
-- [SyncLists](SyncLists)
+- [SyncLists](SyncLists.md)
SyncLists contain lists of values and synchronize data from servers to clients.
-- [SyncDictionary](SyncDictionary)
+- [SyncDictionary](SyncDictionary.md)
A SyncDictionary is an associative array containing an unordered list of key, value pairs.
-- [SyncHashSet](SyncHashSet)
+- [SyncHashSet](SyncHashSet.md)
An unordered set of values that do not repeat.
-- [SyncSortedSet](SyncSortedSet)
+- [SyncSortedSet](SyncSortedSet.md)
A sorted set of values tha do not repeat.
diff --git a/doc/articles/Classes/toc.yml b/doc/articles/Classes/toc.yml
new file mode 100644
index 000000000..aaed39e92
--- /dev/null
+++ b/doc/articles/Classes/toc.yml
@@ -0,0 +1,24 @@
+- name: NetworkServer
+ href: NetworkServer.md
+- name: NetworkConnection
+ href: NetworkConnection.md
+- name: NetworkClient
+ href: NetworkClient.md
+- name: NetworkBehaviour
+ href: NetworkBehaviour.md
+- name: Attributes
+ href: Attributes.md
+- name: SyncVars
+ href: SyncVars.md
+- name: SyncVar Hooks
+ href: SyncVarHook.md
+- name: SyncEvents
+ href: SyncEvent.md
+- name: SyncLists
+ href: SyncLists.md
+- name: SyncDictionary
+ href: SyncDictionary.md
+- name: SyncHashSet
+ href: SyncHashSet.md
+- name: SyncSortedSet
+ href: SyncSortedSet.md
\ No newline at end of file
diff --git a/docs/Components/NetworkAddressAndPortSettings.png b/doc/articles/Components/NetworkAddressAndPortSettings.png
similarity index 100%
rename from docs/Components/NetworkAddressAndPortSettings.png
rename to doc/articles/Components/NetworkAddressAndPortSettings.png
diff --git a/docs/Components/NetworkAnimator.md b/doc/articles/Components/NetworkAnimator.md
similarity index 100%
rename from docs/Components/NetworkAnimator.md
rename to doc/articles/Components/NetworkAnimator.md
diff --git a/docs/Components/NetworkAnimatorComponent.png b/doc/articles/Components/NetworkAnimatorComponent.png
similarity index 100%
rename from docs/Components/NetworkAnimatorComponent.png
rename to doc/articles/Components/NetworkAnimatorComponent.png
diff --git a/docs/Components/NetworkController.md b/doc/articles/Components/NetworkController.md
similarity index 100%
rename from docs/Components/NetworkController.md
rename to doc/articles/Components/NetworkController.md
diff --git a/docs/Components/NetworkGame3Instances.jpg b/doc/articles/Components/NetworkGame3Instances.jpg
similarity index 100%
rename from docs/Components/NetworkGame3Instances.jpg
rename to doc/articles/Components/NetworkGame3Instances.jpg
diff --git a/docs/Components/NetworkIdentity.jpg b/doc/articles/Components/NetworkIdentity.jpg
similarity index 100%
rename from docs/Components/NetworkIdentity.jpg
rename to doc/articles/Components/NetworkIdentity.jpg
diff --git a/docs/Components/NetworkIdentity.md b/doc/articles/Components/NetworkIdentity.md
similarity index 97%
rename from docs/Components/NetworkIdentity.md
rename to doc/articles/Components/NetworkIdentity.md
index a49d753db..57cbeff8b 100644
--- a/docs/Components/NetworkIdentity.md
+++ b/doc/articles/Components/NetworkIdentity.md
@@ -15,13 +15,13 @@ If none of these options is checked, the server will have authority over the obj
With the Unity’s server-authoritative networking system, the server must spawn networked game objects with network identities, using `NetworkServer.Spawn`. This automatically creates them on clients that are connected to the server, and assigns them a `netId`.
-You must put a Network Identity component on any Prefabs that spawn at runtime for the network system to use them. See [Object Spawning](../Concepts/GameObjects/SpawnObject) for more information.
+You must put a Network Identity component on any Prefabs that spawn at runtime for the network system to use them. See [Object Spawning](../Concepts/GameObjects/SpawnObject.md) for more information.
## Scene-based Network Game Objects
You can also network game objects that are saved as part of your Scene (for example, environmental props). Networking game objects makes them behave slightly differently, because you need to have them spawn across the network.
-When building your game, Unity disables all Scene-based game objects with Network Identity components. When a client connects to the server, the server sends spawn messages to tell the client which Scene game objects to enable and what their most up-to-date state information is. This ensures the client’s game does not contain game objects at incorrect locations when they start playing, or that Unity does not spawn and immediately destroy game objects on connection (for example, if an event removed the game object before that client connected). See [Networked Scene Game Objects](../Concepts/GameObjects/SceneObjects) for more information.
+When building your game, Unity disables all Scene-based game objects with Network Identity components. When a client connects to the server, the server sends spawn messages to tell the client which Scene game objects to enable and what their most up-to-date state information is. This ensures the client’s game does not contain game objects at incorrect locations when they start playing, or that Unity does not spawn and immediately destroy game objects on connection (for example, if an event removed the game object before that client connected). See [Networked Scene Game Objects](../Concepts/GameObjects/SceneObjects.md) for more information.
## Preview Pane Information
diff --git a/docs/Components/NetworkIdentityPreview.png b/doc/articles/Components/NetworkIdentityPreview.png
similarity index 100%
rename from docs/Components/NetworkIdentityPreview.png
rename to doc/articles/Components/NetworkIdentityPreview.png
diff --git a/docs/Components/NetworkIdentityPreviewRuntime.png b/doc/articles/Components/NetworkIdentityPreviewRuntime.png
similarity index 100%
rename from docs/Components/NetworkIdentityPreviewRuntime.png
rename to doc/articles/Components/NetworkIdentityPreviewRuntime.png
diff --git a/docs/Components/NetworkLobbyManager.PNG b/doc/articles/Components/NetworkLobbyManager.PNG
similarity index 100%
rename from docs/Components/NetworkLobbyManager.PNG
rename to doc/articles/Components/NetworkLobbyManager.PNG
diff --git a/docs/Components/NetworkLobbyManager.md b/doc/articles/Components/NetworkLobbyManager.md
similarity index 93%
rename from docs/Components/NetworkLobbyManager.md
rename to doc/articles/Components/NetworkLobbyManager.md
index 4c7697c1a..227535bd4 100644
--- a/docs/Components/NetworkLobbyManager.md
+++ b/doc/articles/Components/NetworkLobbyManager.md
@@ -2,7 +2,7 @@
\*\*Please see the Lobby example in the Examples folder in your Mirror folder
-The Network Lobby Manager is a specialized type of [Network Manager](NetworkManager) that provides a multiplayer lobby before entering the main play scene of the game. It allows you to set up a network with:
+The Network Lobby Manager is a specialized type of [Network Manager](NetworkManager.md) that provides a multiplayer lobby before entering the main play scene of the game. It allows you to set up a network with:
- A maximum player limit
@@ -26,7 +26,7 @@ There are two types of player objects with the Network Lobby Manager:
- Handles commands in the lobby
-- Must use the [Network Lobby Player](NetworkLobbyPlayer) component
+- Must use the [Network Lobby Player](NetworkLobbyPlayer.md) component
**Player Prefab**
diff --git a/docs/Components/NetworkLobbyPlayer.PNG b/doc/articles/Components/NetworkLobbyPlayer.PNG
similarity index 100%
rename from docs/Components/NetworkLobbyPlayer.PNG
rename to doc/articles/Components/NetworkLobbyPlayer.PNG
diff --git a/docs/Components/NetworkLobbyPlayer.md b/doc/articles/Components/NetworkLobbyPlayer.md
similarity index 83%
rename from docs/Components/NetworkLobbyPlayer.md
rename to doc/articles/Components/NetworkLobbyPlayer.md
index 577fd125d..3540f8453 100644
--- a/docs/Components/NetworkLobbyPlayer.md
+++ b/doc/articles/Components/NetworkLobbyPlayer.md
@@ -1,6 +1,6 @@
# NetworkLobbyPlayer
-The Network Lobby Player stores per-player state for the [Network Lobby Manager](NetworkLobbyManager) while in the lobby. When using this component, you need to write a script which allows players to indicate they are ready to begin playing, which sets the ReadyToBegin property.
+The Network Lobby Player stores per-player state for the [Network Lobby Manager](NetworkLobbyManager.md) while in the lobby. When using this component, you need to write a script which allows players to indicate they are ready to begin playing, which sets the ReadyToBegin property.
A game object with a Network Lobby Player component must also have a Network Identity component. When you create a Network Lobby Player component on a game object, Unity also creates a Network Identity component on that game object if it does not already have one.
diff --git a/docs/Components/NetworkManager.md b/doc/articles/Components/NetworkManager.md
similarity index 98%
rename from docs/Components/NetworkManager.md
rename to doc/articles/Components/NetworkManager.md
index 94c83c15e..1ebb6e639 100644
--- a/docs/Components/NetworkManager.md
+++ b/doc/articles/Components/NetworkManager.md
@@ -30,7 +30,7 @@ If you are already familiar with multiplayer game development, you might find it
Mirror's uses a separate component (derived from the Transport class) to connect across the network. By default, it is Telepathy Transport. This design choice of separating the transport into its own component allows game developers to choose the transport that best fits their game needs. Changing transports is as simple as swapping out the component on the Network Manager object and assigning it to the Transport field.
-Transports are available for TCP, UDP, WebGL, and Steam. Additionally, there's a Multiplex transport that allows for using two transports together on the server, e.g. Telepathy and WebSockets, so that desktop and browser players can play together on the same server seamlessly. See [Transports](../Transports) for more information.
+Transports are available for TCP, UDP, WebGL, and Steam. Additionally, there's a Multiplex transport that allows for using two transports together on the server, e.g. Telepathy and WebSockets, so that desktop and browser players can play together on the same server seamlessly. See [Transports](../Transports/index.md) for more information.
## Game State Management
@@ -70,7 +70,7 @@ If you have one Network Manager that is persisted through scenes via Don't Destr
## Start Positions
-The Network Manager will spawn Player Prefab at their defined transform position and rotation by default, however the Player Spawn Method property allows you to control how start positions are chosen in conjunction with [Network Start Position](NetworkStartPosition) components.
+The Network Manager will spawn Player Prefab at their defined transform position and rotation by default, however the Player Spawn Method property allows you to control how start positions are chosen in conjunction with [Network Start Position](NetworkStartPosition.md) components.
- Choose Random to spawn players at randomly chosen startPosition options.
@@ -100,7 +100,7 @@ You should normally make sure the Network Manager persists between Scenes, other
There are virtual functions on the `NetworkManager` class that you can customize by creating your own derived class that inherits from `NetworkManager`. When implementing these functions, be sure to take care of the functionality that the default implementations provide. For example, in `OnServerAddPlayer`, the function `NetworkServer.AddPlayer` must be called to activate the player game object for the connection.
-See [Application](../Events/Application), [Server](../Events/Server), [Client](../Events/Client), and [Other](../Events/Other) events for more information.
+See [Application](../Events/Application.md), [Server](../Events/Server.md), [Client](../Events/Client.md), and [Other](../Events/Other.md) events for more information.
## Properties
diff --git a/docs/Components/NetworkManagerHUD.md b/doc/articles/Components/NetworkManagerHUD.md
similarity index 100%
rename from docs/Components/NetworkManagerHUD.md
rename to doc/articles/Components/NetworkManagerHUD.md
diff --git a/docs/Components/NetworkManagerHUDComponent.png b/doc/articles/Components/NetworkManagerHUDComponent.png
similarity index 100%
rename from docs/Components/NetworkManagerHUDComponent.png
rename to doc/articles/Components/NetworkManagerHUDComponent.png
diff --git a/docs/Components/NetworkManagerHUDConnected.png b/doc/articles/Components/NetworkManagerHUDConnected.png
similarity index 100%
rename from docs/Components/NetworkManagerHUDConnected.png
rename to doc/articles/Components/NetworkManagerHUDConnected.png
diff --git a/docs/Components/NetworkManagerHUDConnectionAttempt.png b/doc/articles/Components/NetworkManagerHUDConnectionAttempt.png
similarity index 100%
rename from docs/Components/NetworkManagerHUDConnectionAttempt.png
rename to doc/articles/Components/NetworkManagerHUDConnectionAttempt.png
diff --git a/docs/Components/NetworkManagerHUDHostingLAN.png b/doc/articles/Components/NetworkManagerHUDHostingLAN.png
similarity index 100%
rename from docs/Components/NetworkManagerHUDHostingLAN.png
rename to doc/articles/Components/NetworkManagerHUDHostingLAN.png
diff --git a/docs/Components/NetworkManagerHUDUI.png b/doc/articles/Components/NetworkManagerHUDUI.png
similarity index 100%
rename from docs/Components/NetworkManagerHUDUI.png
rename to doc/articles/Components/NetworkManagerHUDUI.png
diff --git a/docs/Components/NetworkManagerInspector.png b/doc/articles/Components/NetworkManagerInspector.png
similarity index 100%
rename from docs/Components/NetworkManagerInspector.png
rename to doc/articles/Components/NetworkManagerInspector.png
diff --git a/docs/Components/NetworkManagerSpawnInfo.png b/doc/articles/Components/NetworkManagerSpawnInfo.png
similarity index 100%
rename from docs/Components/NetworkManagerSpawnInfo.png
rename to doc/articles/Components/NetworkManagerSpawnInfo.png
diff --git a/docs/Components/NetworkNavMeshAgent.md b/doc/articles/Components/NetworkNavMeshAgent.md
similarity index 100%
rename from docs/Components/NetworkNavMeshAgent.md
rename to doc/articles/Components/NetworkNavMeshAgent.md
diff --git a/docs/Components/NetworkProximityCheck.png b/doc/articles/Components/NetworkProximityCheck.png
similarity index 100%
rename from docs/Components/NetworkProximityCheck.png
rename to doc/articles/Components/NetworkProximityCheck.png
diff --git a/docs/Components/NetworkProximityChecker.md b/doc/articles/Components/NetworkProximityChecker.md
similarity index 100%
rename from docs/Components/NetworkProximityChecker.md
rename to doc/articles/Components/NetworkProximityChecker.md
diff --git a/docs/Components/NetworkRigidbody.md b/doc/articles/Components/NetworkRigidbody.md
similarity index 100%
rename from docs/Components/NetworkRigidbody.md
rename to doc/articles/Components/NetworkRigidbody.md
diff --git a/docs/Components/NetworkStartPosition.jpg b/doc/articles/Components/NetworkStartPosition.jpg
similarity index 100%
rename from docs/Components/NetworkStartPosition.jpg
rename to doc/articles/Components/NetworkStartPosition.jpg
diff --git a/docs/Components/NetworkStartPosition.md b/doc/articles/Components/NetworkStartPosition.md
similarity index 100%
rename from docs/Components/NetworkStartPosition.md
rename to doc/articles/Components/NetworkStartPosition.md
diff --git a/docs/Components/NetworkTransform.md b/doc/articles/Components/NetworkTransform.md
similarity index 100%
rename from docs/Components/NetworkTransform.md
rename to doc/articles/Components/NetworkTransform.md
diff --git a/docs/Components/NetworkTransform.png b/doc/articles/Components/NetworkTransform.png
similarity index 100%
rename from docs/Components/NetworkTransform.png
rename to doc/articles/Components/NetworkTransform.png
diff --git a/docs/Components/NetworkTransformChild.md b/doc/articles/Components/NetworkTransformChild.md
similarity index 100%
rename from docs/Components/NetworkTransformChild.md
rename to doc/articles/Components/NetworkTransformChild.md
diff --git a/docs/Components/NetworkTransformChild.png b/doc/articles/Components/NetworkTransformChild.png
similarity index 100%
rename from docs/Components/NetworkTransformChild.png
rename to doc/articles/Components/NetworkTransformChild.png
diff --git a/docs/Components/index.md b/doc/articles/Components/index.md
similarity index 76%
rename from docs/Components/index.md
rename to doc/articles/Components/index.md
index 3e539c1d8..974b74e1e 100644
--- a/docs/Components/index.md
+++ b/doc/articles/Components/index.md
@@ -2,31 +2,31 @@
General description of Components
-- [NetworkManager](NetworkManager)
+- [NetworkManager](NetworkManager.md)
The Network Manager is a component for managing the networking aspects of a multiplayer game.
-- [NetworkLobbyManager](NetworkLobbyManager)
+- [NetworkLobbyManager](NetworkLobbyManager.md)
The Network Lobby Manager is an extension component of Network Manager that provides a basic functional lobby.
-- [NetworkLobbyPlayer](NetworkLobbyPlayer)
+- [NetworkLobbyPlayer](NetworkLobbyPlayer.md)
The Network Lobby Player is a component that's required on Player prefabs used in the Lobby Scene with the Network Lobby Manager above.
-- [NetworkManagerHUD](NetworkManagerHUD)
+- [NetworkManagerHUD](NetworkManagerHUD.md)
The Network Manager HUD is a quick-start tool to help you start building your multiplayer game straight away, without first having to build a user interface for game creation/connection/joining. It allows you to jump straight into your gameplay programming, and means you can build your own version of these controls later in your development schedule.
-- [NetworkIdentity](NetworkIdentity)
+- [NetworkIdentity](NetworkIdentity.md)
The Network Identity component is at the heart of the Mirror networking high-level API. It controls a game object’s unique identity on the network, and it uses that identity to make the networking system aware of the game object. It offers two different options for configuration and they are mutually exclusive, which means either one of the options or none can be checked.
-- [NetworkStartPosition](NetworkStartPosition)
+- [NetworkStartPosition](NetworkStartPosition.md)
Network Start Position is used by the Network Manager when creating player objects. The position and rotation of the Network Start Position are used to place the newly created player object.
-- [NetworkProximityChecker](NetworkProximityChecker)
+- [NetworkProximityChecker](NetworkProximityChecker.md)
The Network Proximity Checker component controls the visibility of game objects for network clients, based on proximity to players.
-- [NetworkTransform](NetworkTransform)
+- [NetworkTransform](NetworkTransform.md)
The Network Transform component synchronizes the movement and rotation of game objects across the network. Note that the network Transform component only synchronizes spawned networked game objects.
-- [NetworkTransformChild](NetworkTransformChild)
+- [NetworkTransformChild](NetworkTransformChild.md)
The Network Transform Child component synchronizes the position and rotation of the child game object of a game object with a Network Transform component.
-- [NetworkAnimator](NetworkAnimator)
+- [NetworkAnimator](NetworkAnimator.md)
The Network Animator component allows you to synchronize animation states for networked objects. It synchronizes state and parameters from an Animator Controller.
-- [NetworkNavMeshAgent](NetworkNavMeshAgent)
+- [NetworkNavMeshAgent](NetworkNavMeshAgent.md)
Coming Soon
-- [NetworkController](NetworkController)
+- [NetworkController](NetworkController.md)
Coming Soon
-- [NetworkRigidbody](NetworkRigidbody)
+- [NetworkRigidbody](NetworkRigidbody.md)
Coming Soon
diff --git a/doc/articles/Components/toc.yml b/doc/articles/Components/toc.yml
new file mode 100644
index 000000000..c70c4201b
--- /dev/null
+++ b/doc/articles/Components/toc.yml
@@ -0,0 +1,26 @@
+- name: NetworkManager
+ href: NetworkManager.md
+- name: NetworkLobbyManager
+ href: NetworkLobbyManager.md
+- name: NetworkLobbyPlayer
+ href: NetworkLobbyPlayer.md
+- name: NetworkManagerHUD
+ href: NetworkManagerHUD.md
+- name: NetworkIdentity
+ href: NetworkIdentity.md
+- name: NetworkStartPosition
+ href: NetworkStartPosition.md
+- name: NetworkProximityChecker
+ href: NetworkProximityChecker.md
+- name: NetworkTransform
+ href: NetworkTransform.md
+- name: NetworkTransformChild
+ href: NetworkTransformChild.md
+- name: NetworkAnimator
+ href: NetworkAnimator.md
+- name: NetworkNavMeshAgent
+ href: NetworkNavMeshAgent.md
+- name: NetworkController
+ href: NetworkController.md
+- name: NetworkRigidbody
+ href: NetworkRigidbody.md
diff --git a/docs/Concepts/Authentication.md b/doc/articles/Concepts/Authentication.md
similarity index 100%
rename from docs/Concepts/Authentication.md
rename to doc/articles/Concepts/Authentication.md
diff --git a/docs/Concepts/Authority.md b/doc/articles/Concepts/Authority.md
similarity index 100%
rename from docs/Concepts/Authority.md
rename to doc/articles/Concepts/Authority.md
diff --git a/docs/Concepts/ClientsServers.md b/doc/articles/Concepts/ClientsServers.md
similarity index 100%
rename from docs/Concepts/ClientsServers.md
rename to doc/articles/Concepts/ClientsServers.md
diff --git a/docs/Concepts/ClockSync.md b/doc/articles/Concepts/ClockSync.md
similarity index 100%
rename from docs/Concepts/ClockSync.md
rename to doc/articles/Concepts/ClockSync.md
diff --git a/docs/Concepts/Communications/NetworkBehavior.md b/doc/articles/Concepts/Communications/NetworkBehavior.md
similarity index 100%
rename from docs/Concepts/Communications/NetworkBehavior.md
rename to doc/articles/Concepts/Communications/NetworkBehavior.md
diff --git a/docs/Concepts/Communications/NetworkManager.md b/doc/articles/Concepts/Communications/NetworkManager.md
similarity index 100%
rename from docs/Concepts/Communications/NetworkManager.md
rename to doc/articles/Concepts/Communications/NetworkManager.md
diff --git a/docs/Concepts/Communications/NetworkMessages.md b/doc/articles/Concepts/Communications/NetworkMessages.md
similarity index 100%
rename from docs/Concepts/Communications/NetworkMessages.md
rename to doc/articles/Concepts/Communications/NetworkMessages.md
diff --git a/docs/Concepts/Communications/RemoteActions.md b/doc/articles/Concepts/Communications/RemoteActions.md
similarity index 100%
rename from docs/Concepts/Communications/RemoteActions.md
rename to doc/articles/Concepts/Communications/RemoteActions.md
diff --git a/docs/Concepts/Communications/UNetDirections.jpg b/doc/articles/Concepts/Communications/UNetDirections.jpg
similarity index 100%
rename from docs/Concepts/Communications/UNetDirections.jpg
rename to doc/articles/Concepts/Communications/UNetDirections.jpg
diff --git a/docs/Concepts/Communications/index.md b/doc/articles/Concepts/Communications/index.md
similarity index 100%
rename from docs/Concepts/Communications/index.md
rename to doc/articles/Concepts/Communications/index.md
diff --git a/doc/articles/Concepts/Communications/toc.yml b/doc/articles/Concepts/Communications/toc.yml
new file mode 100644
index 000000000..fe97960a1
--- /dev/null
+++ b/doc/articles/Concepts/Communications/toc.yml
@@ -0,0 +1,8 @@
+- name: Remote Actions
+ href: RemoteActions.md
+- name: Network Manager Callbacks
+ href: NetworkManager.md
+- name: Network Behavior Callbacks
+ href: NetworkBehavior.md
+- name: Network Messages
+ href: NetworkMessages.md
\ No newline at end of file
diff --git a/docs/Concepts/Conversion.md b/doc/articles/Concepts/Conversion.md
similarity index 100%
rename from docs/Concepts/Conversion.md
rename to doc/articles/Concepts/Conversion.md
diff --git a/docs/Concepts/GameObjects/NetworkLocalPlayers.png b/doc/articles/Concepts/GameObjects/NetworkLocalPlayers.png
similarity index 100%
rename from docs/Concepts/GameObjects/NetworkLocalPlayers.png
rename to doc/articles/Concepts/GameObjects/NetworkLocalPlayers.png
diff --git a/docs/Concepts/GameObjects/SceneObjects.md b/doc/articles/Concepts/GameObjects/SceneObjects.md
similarity index 100%
rename from docs/Concepts/GameObjects/SceneObjects.md
rename to doc/articles/Concepts/GameObjects/SceneObjects.md
diff --git a/docs/Concepts/GameObjects/SpawnObject.md b/doc/articles/Concepts/GameObjects/SpawnObject.md
similarity index 100%
rename from docs/Concepts/GameObjects/SpawnObject.md
rename to doc/articles/Concepts/GameObjects/SpawnObject.md
diff --git a/docs/Concepts/GameObjects/SpawnObjectCustom.md b/doc/articles/Concepts/GameObjects/SpawnObjectCustom.md
similarity index 100%
rename from docs/Concepts/GameObjects/SpawnObjectCustom.md
rename to doc/articles/Concepts/GameObjects/SpawnObjectCustom.md
diff --git a/docs/Concepts/GameObjects/SpawnObjects.PNG b/doc/articles/Concepts/GameObjects/SpawnObjects.PNG
similarity index 100%
rename from docs/Concepts/GameObjects/SpawnObjects.PNG
rename to doc/articles/Concepts/GameObjects/SpawnObjects.PNG
diff --git a/docs/Concepts/GameObjects/SpawnPlayer.md b/doc/articles/Concepts/GameObjects/SpawnPlayer.md
similarity index 100%
rename from docs/Concepts/GameObjects/SpawnPlayer.md
rename to doc/articles/Concepts/GameObjects/SpawnPlayer.md
diff --git a/docs/Concepts/GameObjects/SpawnPlayerCustom.md b/doc/articles/Concepts/GameObjects/SpawnPlayerCustom.md
similarity index 98%
rename from docs/Concepts/GameObjects/SpawnPlayerCustom.md
rename to doc/articles/Concepts/GameObjects/SpawnPlayerCustom.md
index 2c7c35a8e..789218fa9 100644
--- a/docs/Concepts/GameObjects/SpawnPlayerCustom.md
+++ b/doc/articles/Concepts/GameObjects/SpawnPlayerCustom.md
@@ -45,7 +45,7 @@ You don’t need to use `playerPrefab` on the `NetworkManager` to create player
In addition to players, client connections also have a “ready” state. The host sends clients that are ready information about spawned game objects and state synchronization updates; clients which are not ready are not sent these updates. When a client initially connects to a server, it is not ready. While in this non-ready state, the client can do things that don’t require real-time interactions with the game state on the server, such as loading Scenes, allowing the player to choose an avatar, or fill in log-in boxes. Once a client has completed all its pre-game work, and all its Assets are loaded, it can call `ClientScene.Ready` to enter the “ready” state. The simple example above demonstrates implementation of ready states; because adding a player with `NetworkServer.AddPlayerForConnection` also puts the client into the ready state if it is not already in that state.
-Clients can send and receive network messages without being ready, which also means they can do so without having an active player game object. So a client at a menu or selection screen can connect to the game and interact with it, even though they have no player game object. See documentation on [Network Messages](../../Communications/NetworkMessages) for more details about sending messages without using commands and RPC calls.
+Clients can send and receive network messages without being ready, which also means they can do so without having an active player game object. So a client at a menu or selection screen can connect to the game and interact with it, even though they have no player game object. See documentation on [Network Messages](../Communications/NetworkMessages.md) for more details about sending messages without using commands and RPC calls.
## Switching Players
diff --git a/docs/Concepts/GameObjects/index.md b/doc/articles/Concepts/GameObjects/index.md
similarity index 100%
rename from docs/Concepts/GameObjects/index.md
rename to doc/articles/Concepts/GameObjects/index.md
diff --git a/doc/articles/Concepts/GameObjects/toc.yml b/doc/articles/Concepts/GameObjects/toc.yml
new file mode 100644
index 000000000..7e5bfa96a
--- /dev/null
+++ b/doc/articles/Concepts/GameObjects/toc.yml
@@ -0,0 +1,10 @@
+- name: Spawn Player
+ href: SpawnPlayer.md
+- name: Spawn Player - Custom
+ href: SpawnPlayerCustom.md
+- name: Spawn Object
+ href: SpawnObject.md
+- name: Spawn Object - Custom
+ href: SpawnObjectCustom.md
+- name: Scene Objects
+ href: SceneObjects.md
diff --git a/docs/Concepts/IDs.md b/doc/articles/Concepts/IDs.md
similarity index 100%
rename from docs/Concepts/IDs.md
rename to doc/articles/Concepts/IDs.md
diff --git a/docs/Concepts/NetworkProximityCheck.png b/doc/articles/Concepts/NetworkProximityCheck.png
similarity index 100%
rename from docs/Concepts/NetworkProximityCheck.png
rename to doc/articles/Concepts/NetworkProximityCheck.png
diff --git a/docs/Concepts/StateSync.md b/doc/articles/Concepts/StateSync.md
similarity index 96%
rename from docs/Concepts/StateSync.md
rename to doc/articles/Concepts/StateSync.md
index d4b3c4a0a..0f68296b8 100644
--- a/docs/Concepts/StateSync.md
+++ b/doc/articles/Concepts/StateSync.md
@@ -6,17 +6,17 @@ State synchronization is done from the Server to remote clients. The local clien
Data is not synchronized in the opposite direction - from remote clients to the server. To do this, you need to use Commands.
-- [SyncVars](../Classes/SyncVars)
+- [SyncVars](../Classes/SyncVars.md)
SyncVars are variables of scripts that inherit from NetworkBehaviour, which are synchronized from the server to clients.
-- [SyncEvents](../Classes/SyncEvent)
+- [SyncEvents](../Classes/SyncEvent.md)
SyncEvents are networked events like ClientRpc’s, but instead of calling a function on the game object, they trigger Events instead.
-- [SyncLists](../Classes/SyncLists)
+- [SyncLists](../Classes/SyncLists.md)
SyncLists contain lists of values and synchronize data from servers to clients.
-- [SyncDictionary](../Classes/SyncDictionary)
+- [SyncDictionary](../Classes/SyncDictionary.md)
A SyncDictionary is an associative array containing an unordered list of key, value pairs.
-- [SyncHashSet](../Classes/SyncHashSet)
+- [SyncHashSet](../Classes/SyncHashSet.md)
An unordered set of values that do not repeat.
-- [SyncSortedSet](../Classes/SyncSortedSet)
+- [SyncSortedSet](../Classes/SyncSortedSet.md)
A sorted set of values tha do not repeat.
## Advanced State Synchronization
diff --git a/docs/Concepts/Visibility.md b/doc/articles/Concepts/Visibility.md
similarity index 94%
rename from docs/Concepts/Visibility.md
rename to doc/articles/Concepts/Visibility.md
index 859db6a47..614e6726a 100644
--- a/docs/Concepts/Visibility.md
+++ b/doc/articles/Concepts/Visibility.md
@@ -16,7 +16,7 @@ However, it can be also be resource intensive or complex to determine accurately
## Network Proximity Checker Component
-Mirror’s [Network Proximity Checker](../Components/NetworkProximityChecker) component is simplest way to implement network visibility for players. It works in conjunction with the physics system to determine whether game objects are close enough (that is, “visible” for the purposes of sending network messages in your multiplayer game).
+Mirror’s [Network Proximity Checker](../Components/NetworkProximityChecker.md) component is simplest way to implement network visibility for players. It works in conjunction with the physics system to determine whether game objects are close enough (that is, “visible” for the purposes of sending network messages in your multiplayer game).
## Network Visibility on Remote Clients
diff --git a/docs/Concepts/VisibilityCustom.md b/doc/articles/Concepts/VisibilityCustom.md
similarity index 87%
rename from docs/Concepts/VisibilityCustom.md
rename to doc/articles/Concepts/VisibilityCustom.md
index 1fbc2c80f..02ac9d2f5 100644
--- a/docs/Concepts/VisibilityCustom.md
+++ b/doc/articles/Concepts/VisibilityCustom.md
@@ -1,6 +1,6 @@
# Customizing Network Visibility
-The built-in [Network Proximity Checker](../Components/NetworkProximityChecker) component is the built-in default component for determining a game object’s network visibility. However, this only provides you with a distance-based check. Sometimes you might want to use other kinds of visibility check, such as grid-based rules, line-of-sight tests, navigation path tests, or any other type of test that suits your game.
+The built-in [Network Proximity Checker](../Components/NetworkProximityChecker.md) component is the built-in default component for determining a game object’s network visibility. However, this only provides you with a distance-based check. Sometimes you might want to use other kinds of visibility check, such as grid-based rules, line-of-sight tests, navigation path tests, or any other type of test that suits your game.
To do this, you can implement your own custom equivalent of the Network Proximity Checker. To do that, you need to understand how the Network Proximity Checker works. See documentation on the Network Proximity Checker component.
diff --git a/docs/Concepts/index.md b/doc/articles/Concepts/index.md
similarity index 100%
rename from docs/Concepts/index.md
rename to doc/articles/Concepts/index.md
diff --git a/doc/articles/Concepts/toc.yml b/doc/articles/Concepts/toc.yml
new file mode 100644
index 000000000..1da5854a3
--- /dev/null
+++ b/doc/articles/Concepts/toc.yml
@@ -0,0 +1,24 @@
+- name: Authority
+ href: Authority.md
+- name: About IDs
+ href: IDs.md
+- name: Clients and Servers
+ href: ClientsServers.md
+- name: Authentication
+ href: Authentication.md
+- name: Conversion
+ href: Conversion.md
+- name: Clock Synchronization
+ href: ClockSync.md
+- name: State Syncronization
+ href: StateSync.md
+- name: Visibility
+ href: Visibility.md
+- name: Custom Visibility
+ href: VisibilityCustom.md
+- name: Communications
+ href: Communications/toc.yml
+ topicHref: Communications/index.md
+- name: GameObjects
+ href: GameObjects/toc.yml
+ topicHref: GameObjects/index.md
diff --git a/docs/Events/Application.md b/doc/articles/Events/Application.md
similarity index 100%
rename from docs/Events/Application.md
rename to doc/articles/Events/Application.md
diff --git a/docs/Events/Client.md b/doc/articles/Events/Client.md
similarity index 100%
rename from docs/Events/Client.md
rename to doc/articles/Events/Client.md
diff --git a/docs/Events/Other.md b/doc/articles/Events/Other.md
similarity index 100%
rename from docs/Events/Other.md
rename to doc/articles/Events/Other.md
diff --git a/docs/Events/Server.md b/doc/articles/Events/Server.md
similarity index 100%
rename from docs/Events/Server.md
rename to doc/articles/Events/Server.md
diff --git a/doc/articles/Events/toc.yml b/doc/articles/Events/toc.yml
new file mode 100644
index 000000000..1596777d5
--- /dev/null
+++ b/doc/articles/Events/toc.yml
@@ -0,0 +1,8 @@
+- name: Application Events
+ href: Application.md
+- name: Server Events
+ href: Server.md
+- name: Client Events
+ href: Client.md
+- name: Other Events
+ href: Other.md
diff --git a/docs/Examples/AdditiveScenes.md b/doc/articles/Examples/AdditiveScenes.md
similarity index 100%
rename from docs/Examples/AdditiveScenes.md
rename to doc/articles/Examples/AdditiveScenes.md
diff --git a/docs/Examples/Basic.md b/doc/articles/Examples/Basic.md
similarity index 100%
rename from docs/Examples/Basic.md
rename to doc/articles/Examples/Basic.md
diff --git a/docs/Examples/Lobby.md b/doc/articles/Examples/Lobby.md
similarity index 100%
rename from docs/Examples/Lobby.md
rename to doc/articles/Examples/Lobby.md
diff --git a/docs/Examples/Pong.md b/doc/articles/Examples/Pong.md
similarity index 100%
rename from docs/Examples/Pong.md
rename to doc/articles/Examples/Pong.md
diff --git a/docs/Examples/Pong1.jpg b/doc/articles/Examples/Pong1.jpg
similarity index 100%
rename from docs/Examples/Pong1.jpg
rename to doc/articles/Examples/Pong1.jpg
diff --git a/docs/Examples/Pong2.jpg b/doc/articles/Examples/Pong2.jpg
similarity index 100%
rename from docs/Examples/Pong2.jpg
rename to doc/articles/Examples/Pong2.jpg
diff --git a/docs/Examples/Pong3.jpg b/doc/articles/Examples/Pong3.jpg
similarity index 100%
rename from docs/Examples/Pong3.jpg
rename to doc/articles/Examples/Pong3.jpg
diff --git a/docs/Examples/Pong4.jpg b/doc/articles/Examples/Pong4.jpg
similarity index 100%
rename from docs/Examples/Pong4.jpg
rename to doc/articles/Examples/Pong4.jpg
diff --git a/docs/Examples/Tanks.md b/doc/articles/Examples/Tanks.md
similarity index 100%
rename from docs/Examples/Tanks.md
rename to doc/articles/Examples/Tanks.md
diff --git a/docs/Examples/index.md b/doc/articles/Examples/index.md
similarity index 91%
rename from docs/Examples/index.md
rename to doc/articles/Examples/index.md
index 386e61b8f..4086d588f 100644
--- a/docs/Examples/index.md
+++ b/doc/articles/Examples/index.md
@@ -2,17 +2,17 @@
Mirror includes several small examples to help you learn how to use various features and how to set things up so they work together.
-- [Basic](Basic)
+- [Basic](Basic.md)
Basic is what it sounds like...the most rudimentary baseline of a networked game. Features SyncVars updating random UI data for each player.
-- [Tanks](Tanks)
+- [Tanks](Tanks.md)
This is a simple scene with animated tanks, networked rigidbody projectiles, and NavMesh movement
-- [Pong](Pong)
+- [Pong](Pong.md)
A simple example for "How to build a multiplayer game with Mirror" is Pong. It illustrates the usage of `NetworkManager`, `NetworkManagerHUD`, NetworkBehaviour, NetworkIdentity, `NetworkTransform`, `NetworkStartPosition`and various Attributes.
-- [Additive Scenes](AdditiveScenes)
+- [Additive Scenes](AdditiveScenes.md)
The Additive Scenes example demonstrates a server additively loading a sub-scene into a main scene at startup, and having a server-only trigger that generates a message to any client whose player enters the trigger zone to also load the sub-scene, and subsequently unload it when they leave the trigger zone. Only players inside the trigger zone can see the objects in the sub-scene. Network Proximity Checker components are key to making this scenario work.
-- [Lobby System](Lobby)
+- [Lobby System](Lobby.md)
The Lobby System example demonstrates how to set up a "staging" scene where players assemble before starting a match. When all players are ready, the server sends them all a message to change scenes (along with the server itself) to the actual game play scene so they all come in at once. Includes fully playable game with a character controller where players collect server-spawned prizes for score.
diff --git a/doc/articles/Examples/toc.yml b/doc/articles/Examples/toc.yml
new file mode 100644
index 000000000..c6475994c
--- /dev/null
+++ b/doc/articles/Examples/toc.yml
@@ -0,0 +1,6 @@
+- name: Basic
+ href: Basic.md
+- name: Pong
+ href: Pong.md
+- name: Lobby
+ href: Lobby.md
diff --git a/docs/General/ChangeLog.md b/doc/articles/General/ChangeLog.md
similarity index 95%
rename from docs/General/ChangeLog.md
rename to doc/articles/General/ChangeLog.md
index 6e279bd6f..6eadf8ad1 100644
--- a/docs/General/ChangeLog.md
+++ b/doc/articles/General/ChangeLog.md
@@ -81,12 +81,12 @@
## Version 3.4.9 -- 2019-Apr-6
- Added: Semantic Versioning (which is why we jumped from 1.6 to 3.4.9)
-- Added: [SyncDictionary](../Classes/SyncDictionary)
-- Added: [SyncHashSet](../Classes/SyncHashSet)
-- Added: [SyncSortedSet](../Classes/SyncSortedSet)
+- Added: [SyncDictionary](../Classes/SyncDictionary.md)
+- Added: [SyncHashSet](../Classes/SyncHashSet.md)
+- Added: [SyncSortedSet](../Classes/SyncSortedSet.md)
- Added: SyncList and SyncDictionary support all IList and IDictionary derived types, respectively
-- Added: Documentation for [SyncVars](../Classes/SyncVars)
-- Added: Documentation for [SyncEvents](../Classes/SyncEvent)
+- Added: Documentation for [SyncVars](../Classes/SyncVars.md)
+- Added: Documentation for [SyncEvents](../Classes/SyncEvent.md)
- Added: NoRotation to NetworkTransform
- Added: Scale is now included in spawn payload along with position and rotation
- Added: Generic `IMessageBase` to allow struct message types
@@ -121,12 +121,12 @@
- Fixed: NetworkAnimator bandwidth abuse
- Fixed: NetworkAnimator float sync bug
- Fixed: Persistent SceneID's for Networked objects
-- Changed: Documentation for [Transports](../Transports)
+- Changed: Documentation for [Transports](../Transports/index.md)
- Changed: Weaver is now full source...FINALLY!
- Changed: ClientScene.AddPlayer 2nd parameter is now `byte[] extraData` instead of `MessageBase extraMessage`
- - Please refer to the code sample [here](../Concepts/Authentication) to see how to update your code.
+ - Please refer to the code sample [here](../Concepts/Authentication.md) to see how to update your code.
- Changed: NetworkManager -- Headless Auto-Start moved to `Start()` from `Awake()`
-- Changed: Removed Message ID's for all messages - See [Network Messages](../Concepts/Communications/NetworkMessages) for details
+- Changed: Removed Message ID's for all messages - See [Network Messages](../Concepts/Communications/NetworkMessages.md) for details
- Message IDs are now generated automatically based on the message name.
- Previously you would call Send(MyMessage.MsgId, message), now you call Send(message)
- Removed: Documentation for Groove Transport - use Websockets Transport instead
diff --git a/docs/General/Deprecations.md b/doc/articles/General/Deprecations.md
similarity index 92%
rename from docs/General/Deprecations.md
rename to doc/articles/General/Deprecations.md
index 5adbed286..163c9b0b8 100644
--- a/docs/General/Deprecations.md
+++ b/doc/articles/General/Deprecations.md
@@ -9,11 +9,11 @@ As part of the Unity Services, this entire namespace was removed. It didn't wor
## Network Discovery
-NetworkDiscovery was a UNet component intended for UDP projects. Since Mirror was built on TCP, it was removed. Now that all [transports](../Transports) are separate components, Discovery has been reimplemented in at least one of them.
+NetworkDiscovery was a UNet component intended for UDP projects. Since Mirror was built on TCP, it was removed. Now that all [transports](../Transports/index.md) are separate components, Discovery has been reimplemented in at least one of them.
## networkPort in Network Manager
-Network Manager's `networkPort` property was removed now that all transports are separate components. Not all transports use ports, but those that do have a field for it. See [Transports](../Transports) for more info.
+Network Manager's `networkPort` property was removed now that all transports are separate components. Not all transports use ports, but those that do have a field for it. See [Transports](../Transports/index.md) for more info.
## Network Server Simple
@@ -31,7 +31,7 @@ This component was significantly simplified so that it only syncs position and r
In classic UNET, QoS Flags were used to determine how packets got to the remote end. For example, if you needed a packet to be prioritized in the queue, you would specify a high priority flag which the Unity LLAPI would then receive and deal appropriately. Unfortunately, this caused a lot of extra work for the transport layer and some of the QoS flags did not work as intended due to buggy or code that relied on too much magic.
-In Mirror, QoS flags were replaced with a "Channels" system. This system paves the way for future Mirror improvements, so you can send data on different channels - for example, you could have all game activity on channel 0, while in-game text chat is sent on channel 1 and voice chat is sent on channel 2. In the future, it may be possible to assign a transport system per channel, allowing one to have a TCP transport for critical game network data on channel 0, while in-game text and voice chat is running on a UDP transport in parallel on channel 1. Some transports (such as Ignorance) also provide legacy compatibility for those attached to QoS flags.
+In Mirror, QoS flags were replaced with a "Channels" system. This system paves the way for future Mirror improvements, so you can send data on different channels - for example, you could have all game activity on channel 0, while in-game text chat is sent on channel 1 and voice chat is sent on channel 2. In the future, it may be possible to assign a transport system per channel, allowing one to have a TCP transport for critical game network data on channel 0, while in-game text and voice chat is running on a UDP transport in parallel on channel 1. Some transports (such as Ignorance.md) also provide legacy compatibility for those attached to QoS flags.
The currently defined channels are:
diff --git a/docs/General/Integrations/Dissonance.jpg b/doc/articles/General/Integrations/Dissonance.jpg
similarity index 100%
rename from docs/General/Integrations/Dissonance.jpg
rename to doc/articles/General/Integrations/Dissonance.jpg
diff --git a/docs/General/Integrations/NetworkSyncTransform.jpg b/doc/articles/General/Integrations/NetworkSyncTransform.jpg
similarity index 100%
rename from docs/General/Integrations/NetworkSyncTransform.jpg
rename to doc/articles/General/Integrations/NetworkSyncTransform.jpg
diff --git a/docs/General/Integrations/NobleConnectFree.jpg b/doc/articles/General/Integrations/NobleConnectFree.jpg
similarity index 100%
rename from docs/General/Integrations/NobleConnectFree.jpg
rename to doc/articles/General/Integrations/NobleConnectFree.jpg
diff --git a/docs/General/Integrations/Rucksack.jpg b/doc/articles/General/Integrations/Rucksack.jpg
similarity index 100%
rename from docs/General/Integrations/Rucksack.jpg
rename to doc/articles/General/Integrations/Rucksack.jpg
diff --git a/docs/General/Integrations/SmoothSync.jpg b/doc/articles/General/Integrations/SmoothSync.jpg
similarity index 100%
rename from docs/General/Integrations/SmoothSync.jpg
rename to doc/articles/General/Integrations/SmoothSync.jpg
diff --git a/docs/General/Integrations/WeatherMaker.jpg b/doc/articles/General/Integrations/WeatherMaker.jpg
similarity index 100%
rename from docs/General/Integrations/WeatherMaker.jpg
rename to doc/articles/General/Integrations/WeatherMaker.jpg
diff --git a/docs/General/Integrations/index.md b/doc/articles/General/Integrations/index.md
similarity index 97%
rename from docs/General/Integrations/index.md
rename to doc/articles/General/Integrations/index.md
index a20fa0089..18dc4e837 100644
--- a/docs/General/Integrations/index.md
+++ b/doc/articles/General/Integrations/index.md
@@ -28,4 +28,4 @@ Here we will maintain a list of assets known to be compatible with Mirror. If y
## [Rucksack](https://assetstore.unity.com/packages/templates/systems/rucksack-multiplayer-inventory-system-114921)
-
+
diff --git a/docs/General/Integrations/rts-engine.png b/doc/articles/General/Integrations/rts-engine.png
similarity index 100%
rename from docs/General/Integrations/rts-engine.png
rename to doc/articles/General/Integrations/rts-engine.png
diff --git a/docs/General/Migration.md b/doc/articles/General/Migration.md
similarity index 96%
rename from docs/General/Migration.md
rename to doc/articles/General/Migration.md
index 66183af4a..be4c062c5 100644
--- a/docs/General/Migration.md
+++ b/doc/articles/General/Migration.md
@@ -4,7 +4,7 @@
This guide gives you a step by step instruction for migrating your project from HLAP to Mirror. Mirror is a fork of UNet. As such the migration is straight forward for most projects.
-You should review the information on the [Deprecations](Deprecations) page to see if your project will be impacted.
+You should review the information on the [Deprecations](Deprecations.md) page to see if your project will be impacted.
There's also a Migration Tool you can try:
@@ -73,7 +73,7 @@ public class NetStreamer : NetworkBehaviour
}
```
-Please note that the default transport (Telepathy), completely ignores channels, all messages are reliable, sequenced and fragmented. They just work with no fuss. If you want to take advantage of unreliable channels use LLAPITransport instead.
+Please note that the default transport (Telepathy.md), completely ignores channels, all messages are reliable, sequenced and fragmented. They just work with no fuss. If you want to take advantage of unreliable channels use LLAPITransport instead.
### 5. Change SyncListStruct to SyncList
diff --git a/docs/General/MigrationVideo.jpg b/doc/articles/General/MigrationVideo.jpg
similarity index 100%
rename from docs/General/MigrationVideo.jpg
rename to doc/articles/General/MigrationVideo.jpg
diff --git a/docs/General/NetworkHost.png b/doc/articles/General/NetworkHost.png
similarity index 100%
rename from docs/General/NetworkHost.png
rename to doc/articles/General/NetworkHost.png
diff --git a/docs/General/NetworkLayers.jpg b/doc/articles/General/NetworkLayers.jpg
similarity index 100%
rename from docs/General/NetworkLayers.jpg
rename to doc/articles/General/NetworkLayers.jpg
diff --git a/docs/General/Showcase.md b/doc/articles/General/Showcase.md
similarity index 100%
rename from docs/General/Showcase.md
rename to doc/articles/General/Showcase.md
diff --git a/docs/General/ShowcaseImages/Adversator.png b/doc/articles/General/ShowcaseImages/Adversator.png
similarity index 100%
rename from docs/General/ShowcaseImages/Adversator.png
rename to doc/articles/General/ShowcaseImages/Adversator.png
diff --git a/docs/General/ShowcaseImages/Cubica.jpg b/doc/articles/General/ShowcaseImages/Cubica.jpg
similarity index 100%
rename from docs/General/ShowcaseImages/Cubica.jpg
rename to doc/articles/General/ShowcaseImages/Cubica.jpg
diff --git a/docs/General/ShowcaseImages/OneMoreNight.jpg b/doc/articles/General/ShowcaseImages/OneMoreNight.jpg
similarity index 100%
rename from docs/General/ShowcaseImages/OneMoreNight.jpg
rename to doc/articles/General/ShowcaseImages/OneMoreNight.jpg
diff --git a/docs/General/ShowcaseImages/PickupHockey.png b/doc/articles/General/ShowcaseImages/PickupHockey.png
similarity index 100%
rename from docs/General/ShowcaseImages/PickupHockey.png
rename to doc/articles/General/ShowcaseImages/PickupHockey.png
diff --git a/docs/General/ShowcaseImages/PopulationOneVR.jpg b/doc/articles/General/ShowcaseImages/PopulationOneVR.jpg
similarity index 100%
rename from docs/General/ShowcaseImages/PopulationOneVR.jpg
rename to doc/articles/General/ShowcaseImages/PopulationOneVR.jpg
diff --git a/docs/General/ShowcaseImages/ProjectRetrograde.jpg b/doc/articles/General/ShowcaseImages/ProjectRetrograde.jpg
similarity index 100%
rename from docs/General/ShowcaseImages/ProjectRetrograde.jpg
rename to doc/articles/General/ShowcaseImages/ProjectRetrograde.jpg
diff --git a/docs/General/ShowcaseImages/SamuTale.png b/doc/articles/General/ShowcaseImages/SamuTale.png
similarity index 100%
rename from docs/General/ShowcaseImages/SamuTale.png
rename to doc/articles/General/ShowcaseImages/SamuTale.png
diff --git a/docs/General/ShowcaseImages/TheLastIO.png b/doc/articles/General/ShowcaseImages/TheLastIO.png
similarity index 100%
rename from docs/General/ShowcaseImages/TheLastIO.png
rename to doc/articles/General/ShowcaseImages/TheLastIO.png
diff --git a/docs/General/ShowcaseImages/TheWall.jpg b/doc/articles/General/ShowcaseImages/TheWall.jpg
similarity index 100%
rename from docs/General/ShowcaseImages/TheWall.jpg
rename to doc/articles/General/ShowcaseImages/TheWall.jpg
diff --git a/docs/General/ShowcaseImages/uMMORPG.jpg b/doc/articles/General/ShowcaseImages/uMMORPG.jpg
similarity index 100%
rename from docs/General/ShowcaseImages/uMMORPG.jpg
rename to doc/articles/General/ShowcaseImages/uMMORPG.jpg
diff --git a/docs/General/ShowcaseImages/uSurvival.jpg b/doc/articles/General/ShowcaseImages/uSurvival.jpg
similarity index 100%
rename from docs/General/ShowcaseImages/uSurvival.jpg
rename to doc/articles/General/ShowcaseImages/uSurvival.jpg
diff --git a/docs/General/Start.md b/doc/articles/General/Start.md
similarity index 99%
rename from docs/General/Start.md
rename to doc/articles/General/Start.md
index d00683a36..fcb3a422e 100644
--- a/docs/General/Start.md
+++ b/doc/articles/General/Start.md
@@ -8,7 +8,7 @@ This document describes steps to converting a single player game to a multiplaye
- Add the NetworkManager component to the “NetworkManager” game object.
- Add the NetworkManagerHUD component to the game object. This provides the default UI for managing the network game state.
-See [Using the NetworkManager](/Mirror/Components/NetworkManager).
+See [Using the NetworkManager](/Mirror/Components/NetworkManager.md).
## Player Prefab
diff --git a/docs/General/Support.md b/doc/articles/General/Support.md
similarity index 100%
rename from docs/General/Support.md
rename to doc/articles/General/Support.md
diff --git a/docs/General/WhyTCP.md b/doc/articles/General/WhyTCP.md
similarity index 98%
rename from docs/General/WhyTCP.md
rename to doc/articles/General/WhyTCP.md
index 9c45998c4..5dcd5987b 100644
--- a/docs/General/WhyTCP.md
+++ b/doc/articles/General/WhyTCP.md
@@ -60,5 +60,5 @@ That's why we made Telepathy and Mirror. **Life is short. We just need the damn
We acknowledge not everyone will agree with our reasoning. Rather than push our views on users, we made Mirror transport independent. A few months later, Unity did the same thing. You can easily swap out the transport for one of the several RUDP implementations simply by dragging it into your NetworkManager gameobject. Pick whatever works best for you. We recommend you profile your game and collect real world numbers before you make a final decision.
-After we made Mirror transport independent, the community stepped up integrated several RUDP transports with Mirror. While the default is Telepathy (simple "just works" TCP transport) you can choose among several [transports](../Transports) or even write your own.
+After we made Mirror transport independent, the community stepped up integrated several RUDP transports with Mirror. While the default is Telepathy (simple "just works" TCP transport) you can choose among several [transports](../Transports/index.md) or even write your own.
diff --git a/docs/General/index.md b/doc/articles/General/index.md
similarity index 100%
rename from docs/General/index.md
rename to doc/articles/General/index.md
diff --git a/doc/articles/General/toc.yml b/doc/articles/General/toc.yml
new file mode 100644
index 000000000..67aed926b
--- /dev/null
+++ b/doc/articles/General/toc.yml
@@ -0,0 +1,16 @@
+- name: Getting Started
+ href: Start.md
+- name: Migration Guide
+ href: Migration.md
+- name: Deprecations
+ href: Deprecations.md
+- name: ChangeLog
+ href: ChangeLog.md
+- name: Showcase
+ href: Showcase.md
+- name: Integrations
+ href: Integrations/index.md
+- name: Why TCP?
+ href: WhyTCP.md
+- name: Support
+ href: Support.md
\ No newline at end of file
diff --git a/docs/Messages/index.md b/doc/articles/Messages/index.md
similarity index 100%
rename from docs/Messages/index.md
rename to doc/articles/Messages/index.md
diff --git a/docs/Services/Chat.md b/doc/articles/Services/Chat.md
similarity index 100%
rename from docs/Services/Chat.md
rename to doc/articles/Services/Chat.md
diff --git a/docs/Services/Match.md b/doc/articles/Services/Match.md
similarity index 100%
rename from docs/Services/Match.md
rename to doc/articles/Services/Match.md
diff --git a/docs/Services/NAT.md b/doc/articles/Services/NAT.md
similarity index 100%
rename from docs/Services/NAT.md
rename to doc/articles/Services/NAT.md
diff --git a/docs/Services/Relay.md b/doc/articles/Services/Relay.md
similarity index 100%
rename from docs/Services/Relay.md
rename to doc/articles/Services/Relay.md
diff --git a/docs/Services/index.md b/doc/articles/Services/index.md
similarity index 55%
rename from docs/Services/index.md
rename to doc/articles/Services/index.md
index cd3d19fbf..95b766f9d 100644
--- a/docs/Services/index.md
+++ b/doc/articles/Services/index.md
@@ -2,11 +2,11 @@
General description of Services
-- [Match Service](Match)
+- [Match Service](Match.md)
Something about this
-- [Chat Service](Chat)
+- [Chat Service](Chat.md)
Something about this
-- [NAT Service](NAT)
+- [NAT Service](NAT.md)
Something about this
-- [Relay Service](Relay)
+- [Relay Service](Relay.md)
Something about this
diff --git a/doc/articles/Services/toc.yml b/doc/articles/Services/toc.yml
new file mode 100644
index 000000000..2c46b34ca
--- /dev/null
+++ b/doc/articles/Services/toc.yml
@@ -0,0 +1,8 @@
+- name: Match Service
+ href: Match.md
+- name: Chat Service
+ href: Chat.md
+- name: NAT Service
+ href: NAT.md
+- name: Relay Service
+ href: Relay.md
\ No newline at end of file
diff --git a/docs/Transports/Fizzy.md b/doc/articles/Transports/Fizzy.md
similarity index 100%
rename from docs/Transports/Fizzy.md
rename to doc/articles/Transports/Fizzy.md
diff --git a/docs/Transports/Groove.md b/doc/articles/Transports/Groove.md
similarity index 100%
rename from docs/Transports/Groove.md
rename to doc/articles/Transports/Groove.md
diff --git a/docs/Transports/Ignorance.md b/doc/articles/Transports/Ignorance.md
similarity index 96%
rename from docs/Transports/Ignorance.md
rename to doc/articles/Transports/Ignorance.md
index 33c961298..c32996c1c 100644
--- a/docs/Transports/Ignorance.md
+++ b/doc/articles/Transports/Ignorance.md
@@ -51,7 +51,7 @@ Unity LLAPI was also closed source, meaning the Mirror developers could not take
No, it does not. This is due to an issue with the fact that ENET is a C++ packet pumper and the ENET C# wrapper uses native C++ calls to talk to the network stack. Since it is not possible to convert a native ENET binary to WebGL, you will need to look elsewhere for Websockets support.
## Where can I get Ignorance?
-[Grab the latest build from the releases page on the Ignorance repository](https://github.com/SoftwareGuy/Ignorance). Follow the instructions - it's simply a extra line or two of code plus dropping DLLs into your project.
+[Grab the latest build from the releases page on the Ignorance repository](https://github.com/SoftwareGuy/Ignorance.md). Follow the instructions - it's simply a extra line or two of code plus dropping DLLs into your project.
## Where can I get support?
You can get support by opening a issue ticket on the [Ignorance repository issue tracker](https://github.com/SoftwareGuy/Ignorance/issues) or the #ignorance channel in the Mirror Discord server.
diff --git a/docs/Transports/IgnoranceTransport.PNG b/doc/articles/Transports/IgnoranceTransport.PNG
similarity index 100%
rename from docs/Transports/IgnoranceTransport.PNG
rename to doc/articles/Transports/IgnoranceTransport.PNG
diff --git a/docs/Transports/Insight.md b/doc/articles/Transports/Insight.md
similarity index 77%
rename from docs/Transports/Insight.md
rename to doc/articles/Transports/Insight.md
index 2a2df34a5..f7f56b730 100644
--- a/docs/Transports/Insight.md
+++ b/doc/articles/Transports/Insight.md
@@ -1,4 +1,4 @@
# Insight
Insight is a Simple Message Server for Unity based on Mirror. It can operate on its network connection or alongside a NetworkMannager. Inspired by MasterServerFramework it can be expanded with flexible modules.
-Get it now on [GitHub](https://github.com/uweenukr/Insight)!
+Get it now on [GitHub](https://github.com/uweenukr/Insight.md)!
diff --git a/docs/Transports/LiteNetLib4Mirror.md b/doc/articles/Transports/LiteNetLib4Mirror.md
similarity index 100%
rename from docs/Transports/LiteNetLib4Mirror.md
rename to doc/articles/Transports/LiteNetLib4Mirror.md
diff --git a/docs/Transports/LiteNetLibTransport.PNG b/doc/articles/Transports/LiteNetLibTransport.PNG
similarity index 100%
rename from docs/Transports/LiteNetLibTransport.PNG
rename to doc/articles/Transports/LiteNetLibTransport.PNG
diff --git a/docs/Transports/MultiplexSample.png b/doc/articles/Transports/MultiplexSample.png
similarity index 100%
rename from docs/Transports/MultiplexSample.png
rename to doc/articles/Transports/MultiplexSample.png
diff --git a/docs/Transports/Multiplexer.md b/doc/articles/Transports/Multiplexer.md
similarity index 100%
rename from docs/Transports/Multiplexer.md
rename to doc/articles/Transports/Multiplexer.md
diff --git a/docs/Transports/SteamTransport.PNG b/doc/articles/Transports/SteamTransport.PNG
similarity index 100%
rename from docs/Transports/SteamTransport.PNG
rename to doc/articles/Transports/SteamTransport.PNG
diff --git a/docs/Transports/Telepathy.md b/doc/articles/Transports/Telepathy.md
similarity index 99%
rename from docs/Transports/Telepathy.md
rename to doc/articles/Transports/Telepathy.md
index 745956e9d..79a9e2239 100644
--- a/docs/Transports/Telepathy.md
+++ b/doc/articles/Transports/Telepathy.md
@@ -6,7 +6,7 @@ Simple, message based, MMO Scale TCP networking in C\#. And no magic.
- Telepathy is fast and extremely reliable, designed for [MMO](https://assetstore.unity.com/packages/templates/systems/ummorpg-51212) scale Networking.
- Telepathy uses framing, so anything sent will be received the same way.
- Telepathy is raw C\# and can be used in Unity3D too.
-- Telepathy is available on [GitHub](https://github.com/vis2k/Telepathy)
+- Telepathy is available on [GitHub](https://github.com/vis2k/Telepathy.md)
## What makes Telepathy special?
diff --git a/docs/Transports/WebSockets.md b/doc/articles/Transports/WebSockets.md
similarity index 100%
rename from docs/Transports/WebSockets.md
rename to doc/articles/Transports/WebSockets.md
diff --git a/docs/Transports/WebsocketTransport.PNG b/doc/articles/Transports/WebsocketTransport.PNG
similarity index 100%
rename from docs/Transports/WebsocketTransport.PNG
rename to doc/articles/Transports/WebsocketTransport.PNG
diff --git a/docs/Transports/index.md b/doc/articles/Transports/index.md
similarity index 77%
rename from docs/Transports/index.md
rename to doc/articles/Transports/index.md
index c1319f3fa..14fe12a70 100644
--- a/docs/Transports/index.md
+++ b/doc/articles/Transports/index.md
@@ -4,17 +4,17 @@ To use a transport, simply add it as component to the NetworkManager and drag it
# Transports Overview
-- [TCP - Telepathy](Telepathy)
+- [TCP - Telepathy](Telepathy.md)
Simple, message based, MMO Scale TCP networking in C#. And no magic.
-- [UDP - Ignorance](Ignorance)
+- [UDP - Ignorance](Ignorance.md)
Ignorance implements a reliable and unreliable sequenced UDP transport based on ENet.
-- [UDP - LiteNetLib4Mirror](LiteNetLib4Mirror)
+- [UDP - LiteNetLib4Mirror](LiteNetLib4Mirror.md)
LiteNetLib4Mirror implements a UDP transport based on LiteNetLib with Network Discovery and uPnP included.
-- [WebGL - WebSockets](WebSockets)
+- [WebGL - WebSockets](WebSockets.md)
WebSockets transport layer for Mirror that target WebGL clients, without relying on Unity's stodgy old LLAPI.
-- [Steam - Fizzy](Fizzy)
+- [Steam - Fizzy](Fizzy.md)
A complete rebuild utilising Async (Previously SteamNetNetworkTransport) of a Steam P2P network transport layer.
-- [Multiplexer - Multiplexer](Multiplexer)
+- [Multiplexer - Multiplexer](Multiplexer.md)
Multiplexer is a bridging transport to allow a server to handle clients on different transports concurrnently, for example desktop clients using Telepathy together with WebGL clients using Websockets.
-- [Socket Server - Insight](Insight)
+- [Socket Server - Insight](Insight.md)
Insight is a simple Socket Server for Unity and Mirror.
diff --git a/doc/articles/Transports/toc.yml b/doc/articles/Transports/toc.yml
new file mode 100644
index 000000000..146c4849e
--- /dev/null
+++ b/doc/articles/Transports/toc.yml
@@ -0,0 +1,14 @@
+- name: TCP - Telepathy
+ href: Telepathy.md
+- name: UDP - Ignorance
+ href: Ignorance.md
+- name: UDP - LiteNetLib4Mirror
+ href: LiteNetLib4Mirror.md
+- name: WebGL - WebSockets
+ href: WebSockets.md
+- name: Steam - Fizzy
+ href: Fizzy.md
+- name: Multiplexer - Multiplexer
+ href: Multiplexer.md
+- name: Socket - Insight
+ href: Insight.md
diff --git a/doc/articles/intro.md b/doc/articles/intro.md
new file mode 100644
index 000000000..c0478cede
--- /dev/null
+++ b/doc/articles/intro.md
@@ -0,0 +1 @@
+# Add your introductions here!
diff --git a/doc/articles/toc.yml b/doc/articles/toc.yml
new file mode 100644
index 000000000..411c71f7d
--- /dev/null
+++ b/doc/articles/toc.yml
@@ -0,0 +1,26 @@
+- name: General
+ href: General/toc.yml
+ topicHref: General/index.md
+- name: Concepts
+ href: Concepts/toc.yml
+ topicHref: Concepts/index.md
+- name: Components
+ href: Components/toc.yml
+ topicHref: Components/index.md
+- name: Classes
+ href: Classes/toc.yml
+ topicHref: Classes/index.md
+- name: Events
+ href: Events/toc.yml
+ topicHref: Events/Application.md
+- name: Messages
+ href: Messages/index.md
+- name: Transports
+ href: Transports/toc.yml
+ topicHref: Transports/index.md
+- name: Examples
+ href: Examples/toc.yml
+ topicHref: Examples/index.md
+- name: Services
+ href: Services/toc.yml
+ topicHref: Services/index.md
diff --git a/doc/docfx.json b/doc/docfx.json
new file mode 100644
index 000000000..6a073e135
--- /dev/null
+++ b/doc/docfx.json
@@ -0,0 +1,69 @@
+{
+ "metadata": [
+ {
+ "src": [
+ {
+ "files": [
+ "doc.csproj"
+ ],
+ "src": "../Assets/Mirror/Runtime"
+ }
+ ],
+ "dest": "api",
+ "disableGitFeatures": false,
+ "disableDefaultFilter": false,
+ "filter": "filterConfig.yml"
+ }
+ ],
+ "build": {
+ "content": [
+ {
+ "files": [
+ "api/**.yml",
+ "api/index.md"
+ ]
+ },
+ {
+ "files": [
+ "articles/**.md",
+ "articles/**/toc.yml",
+ "toc.yml",
+ "*.md"
+ ]
+ }
+ ],
+ "resource": [
+ {
+ "files": [
+ "images/**",
+ "articles/**.png",
+ "articles/**.jpg"
+ ]
+ }
+ ],
+ "overwrite": [
+ {
+ "files": [
+ "apidoc/**.md"
+ ],
+ "exclude": [
+ "obj/**",
+ "_site/**"
+ ]
+ }
+ ],
+ "dest": "_site",
+ "globalMetadataFiles": [],
+ "fileMetadataFiles": [],
+ "template": [
+ "default",
+ "templates/material"
+ ],
+ "postProcessors": [],
+ "markdownEngineName": "markdig",
+ "noLangKeyword": false,
+ "keepFileLink": false,
+ "cleanupCacheHistory": false,
+ "disableGitFeatures": false
+ }
+}
\ No newline at end of file
diff --git a/doc/filterConfig.yml b/doc/filterConfig.yml
new file mode 100644
index 000000000..879400dca
--- /dev/null
+++ b/doc/filterConfig.yml
@@ -0,0 +1,3 @@
+apiRules:
+- exclude:
+ uidRegex: ^Ninja\.WebSockets.*$
diff --git a/docs/index.md b/doc/index.md
similarity index 63%
rename from docs/index.md
rename to doc/index.md
index c57298246..45a1f9cf7 100644
--- a/docs/index.md
+++ b/doc/index.md
@@ -2,9 +2,9 @@
**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](General/Migration) to do most of the work for you!
+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!
-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://vis2k.github.io/Mirror/General/Showcase)!
+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](articles/General/Showcase.md)!
uMMORPG was possible with \<6000 lines of code. We needed a networking library that allows us to launch our games, period!
@@ -20,13 +20,13 @@ uMMORPG was possible with \<6000 lines of code. We needed a networking library t
**Multiple Transports Available:**
-- **TCP** ([Telepathy](Transports/Telepathy))
+- **TCP** ([Telepathy](articles/Transports/Telepathy.md))
-- **UDP** ([ENet](Transports/Ignorance) and [LiteNetLib](Transports/LiteNetLib4Mirror))
+- **UDP** ([ENet](articles/Transports/Ignorance.md) and [LiteNetLib](articles/Transports/LiteNetLib4Mirror.md))
-- **Steam** ([Steamworks.Net](Transports/Fizzy))
+- **Steam** ([Steamworks.Net](articles/Transports/Fizzy.md))
-- **WebGL** ([Web Sockets](Transports/WebSockets))
+- **WebGL** ([Web Sockets](articles/Transports/WebSockets.md))
**List Server**
@@ -34,25 +34,25 @@ We've developed a [List Server](https://mirror-networking.com/list-server/) wher
**Key Features & Components:**
-- [Transports](Transports) are interchangeable components
+- [Transports](articles/Transports/index.md) are interchangeable components
- Additive Scene Loading
- Single and separated Unity projects supported
-- Network [Manager](Components/NetworkManager) and [HUD](Components/NetworkManagerHUD)
+- Network [Manager](articles/Components/NetworkManager.md) and [HUD](articles/Components/NetworkManagerHUD.md)
-- Network [Lobby Manager](Components/NetworkLobbyManager) and [Lobby Player](Components/NetworkLobbyPlayer)
+- Network [Lobby Manager](articles/Components/NetworkLobbyManager.md) and [Lobby Player](articles/Components/NetworkLobbyPlayer.md)
-- Network [Identity](Components/NetworkIdentity)
+- Network [Identity](articles/Components/NetworkIdentity.md)
-- Network [Transform](Components/NetworkTransform)
+- Network [Transform](articles/Components/NetworkTransform.md)
-- Network [Animator](Components/NetworkAnimator) with 64 parameters
+- Network [Animator](articles/Components/NetworkAnimator.md) with 64 parameters
-- Network [Proximity Checker](Components/NetworkProximityChecker)
+- Network [Proximity Checker](articles/Components/NetworkProximityChecker.md)
-- [SyncVar](Classes/SyncVars), [SyncList](Classes/SyncLists), [SyncEvent](Classes/SyncEvent), [SyncDictionary](Classes/SyncDictionary), and [SyncHashSet](Classes/SyncHashSet)
+- [SyncVar](articles/Classes/SyncVars.md), [SyncList](articles/Classes/SyncLists.md), [SyncEvent](articles/Classes/SyncEvent.md), [SyncDictionary](articles/Classes/SyncDictionary.md), and [SyncHashSet](articles/Classes/SyncHashSet.md)
**Integrations**
diff --git a/doc/templates/material/partials/head.tmpl.partial b/doc/templates/material/partials/head.tmpl.partial
new file mode 100755
index 000000000..c05e8c1b0
--- /dev/null
+++ b/doc/templates/material/partials/head.tmpl.partial
@@ -0,0 +1,21 @@
+{{!Copyright (c) Oscar Vasquez. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
+
+
+
+
+ {{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}
+
+
+
+ {{#_description}}{{/_description}}
+
+
+
+
+
+
+
+ {{#_noindex}}{{/_noindex}}
+ {{#_enableSearch}}{{/_enableSearch}}
+ {{#_enableNewTab}}{{/_enableNewTab}}
+
\ No newline at end of file
diff --git a/doc/templates/material/styles/main.css b/doc/templates/material/styles/main.css
new file mode 100755
index 000000000..c64cc7f9a
--- /dev/null
+++ b/doc/templates/material/styles/main.css
@@ -0,0 +1,202 @@
+body {
+ color: #34393e;
+ font-family: 'Roboto', sans-serif;
+ line-height: 1.5;
+ font-size: 16px;
+ -ms-text-size-adjust: 100%;
+ -webkit-text-size-adjust: 100%;
+ word-wrap: break-word
+}
+
+/* HEADINGS */
+
+h1 {
+ font-weight: 600;
+ font-size: 32px;
+}
+
+h2 {
+ font-weight: 600;
+ font-size: 24px;
+ line-height: 1.8;
+}
+
+h3 {
+ font-weight: 600;
+ font-size: 20px;
+ line-height: 1.8;
+}
+
+h5 {
+ font-size: 14px;
+ padding: 10px 0px;
+}
+
+article h1,
+article h2,
+article h3,
+article h4 {
+ margin-top: 35px;
+ margin-bottom: 15px;
+}
+
+article h4 {
+ padding-bottom: 8px;
+ border-bottom: 2px solid #ddd;
+}
+
+/* NAVBAR */
+
+.navbar-brand>img {
+ color: #fff;
+}
+
+.navbar {
+ border: none;
+ /* Both navbars use box-shadow */
+ -webkit-box-shadow: 0px 1px 3px 0px rgba(100, 100, 100, 0.5);
+ -moz-box-shadow: 0px 1px 3px 0px rgba(100, 100, 100, 0.5);
+ box-shadow: 0px 1px 3px 0px rgba(100, 100, 100, 0.5);
+}
+
+.subnav {
+ border-top: 1px solid #ddd;
+ background-color: #fff;
+}
+
+.navbar-inverse {
+ background-color: #0d47a1;
+ z-index: 100;
+}
+
+.navbar-inverse .navbar-nav>li>a,
+.navbar-inverse .navbar-text {
+ color: #fff;
+ background-color: #0d47a1;
+ border-bottom: 3px solid transparent;
+ padding-bottom: 12px;
+}
+
+.navbar-inverse .navbar-nav>li>a:focus,
+.navbar-inverse .navbar-nav>li>a:hover {
+ color: #fff;
+ background-color: #0d47a1;
+ border-bottom: 3px solid white;
+}
+
+.navbar-inverse .navbar-nav>.active>a,
+.navbar-inverse .navbar-nav>.active>a:focus,
+.navbar-inverse .navbar-nav>.active>a:hover {
+ color: #fff;
+ background-color: #0d47a1;
+ border-bottom: 3px solid white;
+}
+
+.navbar-form .form-control {
+ border: none;
+ border-radius: 20px;
+}
+
+/* SIDEBAR */
+
+.toc .level1>li {
+ font-weight: 400;
+}
+
+.toc .nav>li>a {
+ color: #34393e;
+}
+
+.sidefilter {
+ background-color: #fff;
+ border-left: none;
+ border-right: none;
+}
+
+.sidefilter {
+ background-color: #fff;
+ border-left: none;
+ border-right: none;
+}
+
+.toc-filter {
+ padding: 10px;
+ margin: 0;
+}
+
+.toc-filter>input {
+ border: 2px solid #ddd;
+ border-radius: 20px;
+}
+
+.toc-filter>.filter-icon {
+ display: none;
+}
+
+.sidetoc>.toc {
+ background-color: #fff;
+ overflow-x: hidden;
+}
+
+.sidetoc {
+ background-color: #fff;
+ border: none;
+}
+
+/* ALERTS */
+
+.alert {
+ padding: 0px 0px 5px 0px;
+ color: inherit;
+ background-color: inherit;
+ border: none;
+ box-shadow: 0px 2px 2px 0px rgba(100, 100, 100, 0.4);
+}
+
+.alert>p {
+ margin-bottom: 0;
+ padding: 5px 10px;
+}
+
+.alert>ul {
+ margin-bottom: 0;
+ padding: 5px 40px;
+}
+
+.alert>h5 {
+ padding: 10px 15px;
+ margin-top: 0;
+ text-transform: uppercase;
+ font-weight: bold;
+ border-radius: 4px 4px 0 0;
+}
+
+.alert-info>h5 {
+ color: #1976d2;
+ border-bottom: 4px solid #1976d2;
+ background-color: #e3f2fd;
+}
+
+.alert-warning>h5 {
+ color: #f57f17;
+ border-bottom: 4px solid #f57f17;
+ background-color: #fff3e0;
+}
+
+.alert-danger>h5 {
+ color: #d32f2f;
+ border-bottom: 4px solid #d32f2f;
+ background-color: #ffebee;
+}
+
+/* CODE HIGHLIGHT */
+pre {
+ padding: 9.5px;
+ margin: 0 0 10px;
+ font-size: 13px;
+ word-break: break-all;
+ word-wrap: break-word;
+ background-color: #fffaef;
+ border-radius: 4px;
+ box-shadow: 0px 1px 4px 1px rgba(100, 100, 100, 0.4);
+}
\ No newline at end of file
diff --git a/doc/toc.yml b/doc/toc.yml
new file mode 100644
index 000000000..60d815fcf
--- /dev/null
+++ b/doc/toc.yml
@@ -0,0 +1,7 @@
+- name: Articles
+ href: articles/General/index.md
+- name: Api Documentation
+ href: api/
+ homepage: api/index.md
+- name: Github
+ href: https://github.com/vis2k/Mirror
diff --git a/docs/404.md b/docs/404.md
deleted file mode 100644
index cc7fa210b..000000000
--- a/docs/404.md
+++ /dev/null
@@ -1,2 +0,0 @@
-# Page not found :(
-The requested page could not be found.
diff --git a/docs/Gemfile b/docs/Gemfile
deleted file mode 100644
index dcf998fcd..000000000
--- a/docs/Gemfile
+++ /dev/null
@@ -1,20 +0,0 @@
-source "https://rubygems.org"
-
-# Hello! This is where you manage which Jekyll version is used to run.
-# When you want to use a different version, change it below, save the
-# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
-#
-# bundle exec jekyll serve
-#
-# This will help ensure the proper Jekyll version is running.
-# Happy Jekylling!
-#gem "jekyll", "~> 3.7.3"
-
-
-# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
-# uncomment the line below. To upgrade, run `bundle update github-pages`.
-gem "github-pages"
-gem "jekyll-feed"
-gem "jekyll-sitemap"
-gem "html-proofer"
-
diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
deleted file mode 100644
index b43847ec1..000000000
--- a/docs/Gemfile.lock
+++ /dev/null
@@ -1,263 +0,0 @@
-GEM
- remote: https://rubygems.org/
- specs:
- activesupport (4.2.10)
- i18n (~> 0.7)
- minitest (~> 5.1)
- thread_safe (~> 0.3, >= 0.3.4)
- tzinfo (~> 1.1)
- addressable (2.5.2)
- public_suffix (>= 2.0.2, < 4.0)
- coffee-script (2.4.1)
- coffee-script-source
- execjs
- coffee-script-source (1.11.1)
- colorator (1.1.0)
- colorize (0.8.1)
- commonmarker (0.17.13)
- ruby-enum (~> 0.5)
- concurrent-ruby (1.1.4)
- dnsruby (1.61.2)
- addressable (~> 2.5)
- em-websocket (0.5.1)
- eventmachine (>= 0.12.9)
- http_parser.rb (~> 0.6.0)
- ethon (0.11.0)
- ffi (>= 1.3.0)
- eventmachine (1.2.7)
- execjs (2.7.0)
- faraday (0.15.4)
- multipart-post (>= 1.2, < 3)
- ffi (1.9.25)
- forwardable-extended (2.6.0)
- gemoji (3.0.0)
- github-pages (193)
- activesupport (= 4.2.10)
- github-pages-health-check (= 1.8.1)
- jekyll (= 3.7.4)
- jekyll-avatar (= 0.6.0)
- jekyll-coffeescript (= 1.1.1)
- jekyll-commonmark-ghpages (= 0.1.5)
- jekyll-default-layout (= 0.1.4)
- jekyll-feed (= 0.11.0)
- jekyll-gist (= 1.5.0)
- jekyll-github-metadata (= 2.9.4)
- jekyll-mentions (= 1.4.1)
- jekyll-optional-front-matter (= 0.3.0)
- jekyll-paginate (= 1.1.0)
- jekyll-readme-index (= 0.2.0)
- jekyll-redirect-from (= 0.14.0)
- jekyll-relative-links (= 0.5.3)
- jekyll-remote-theme (= 0.3.1)
- jekyll-sass-converter (= 1.5.2)
- jekyll-seo-tag (= 2.5.0)
- jekyll-sitemap (= 1.2.0)
- jekyll-swiss (= 0.4.0)
- jekyll-theme-architect (= 0.1.1)
- jekyll-theme-cayman (= 0.1.1)
- jekyll-theme-dinky (= 0.1.1)
- jekyll-theme-hacker (= 0.1.1)
- jekyll-theme-leap-day (= 0.1.1)
- jekyll-theme-merlot (= 0.1.1)
- jekyll-theme-midnight (= 0.1.1)
- jekyll-theme-minimal (= 0.1.1)
- jekyll-theme-modernist (= 0.1.1)
- jekyll-theme-primer (= 0.5.3)
- jekyll-theme-slate (= 0.1.1)
- jekyll-theme-tactile (= 0.1.1)
- jekyll-theme-time-machine (= 0.1.1)
- jekyll-titles-from-headings (= 0.5.1)
- jemoji (= 0.10.1)
- kramdown (= 1.17.0)
- liquid (= 4.0.0)
- listen (= 3.1.5)
- mercenary (~> 0.3)
- minima (= 2.5.0)
- nokogiri (>= 1.8.2, < 2.0)
- rouge (= 2.2.1)
- terminal-table (~> 1.4)
- github-pages-health-check (1.8.1)
- addressable (~> 2.3)
- dnsruby (~> 1.60)
- octokit (~> 4.0)
- public_suffix (~> 2.0)
- typhoeus (~> 1.3)
- html-pipeline (2.9.1)
- activesupport (>= 2)
- nokogiri (>= 1.4)
- html-proofer (3.9.3)
- activesupport (>= 4.2, < 6.0)
- addressable (~> 2.3)
- colorize (~> 0.8)
- mercenary (~> 0.3.2)
- nokogiri (~> 1.8.1)
- parallel (~> 1.3)
- typhoeus (~> 1.3)
- yell (~> 2.0)
- http_parser.rb (0.6.0)
- i18n (0.9.5)
- concurrent-ruby (~> 1.0)
- jekyll (3.7.4)
- addressable (~> 2.4)
- colorator (~> 1.0)
- em-websocket (~> 0.5)
- i18n (~> 0.7)
- jekyll-sass-converter (~> 1.0)
- jekyll-watch (~> 2.0)
- kramdown (~> 1.14)
- liquid (~> 4.0)
- mercenary (~> 0.3.3)
- pathutil (~> 0.9)
- rouge (>= 1.7, < 4)
- safe_yaml (~> 1.0)
- jekyll-avatar (0.6.0)
- jekyll (~> 3.0)
- jekyll-coffeescript (1.1.1)
- coffee-script (~> 2.2)
- coffee-script-source (~> 1.11.1)
- jekyll-commonmark (1.2.0)
- commonmarker (~> 0.14)
- jekyll (>= 3.0, < 4.0)
- jekyll-commonmark-ghpages (0.1.5)
- commonmarker (~> 0.17.6)
- jekyll-commonmark (~> 1)
- rouge (~> 2)
- jekyll-default-layout (0.1.4)
- jekyll (~> 3.0)
- jekyll-feed (0.11.0)
- jekyll (~> 3.3)
- jekyll-gist (1.5.0)
- octokit (~> 4.2)
- jekyll-github-metadata (2.9.4)
- jekyll (~> 3.1)
- octokit (~> 4.0, != 4.4.0)
- jekyll-mentions (1.4.1)
- html-pipeline (~> 2.3)
- jekyll (~> 3.0)
- jekyll-optional-front-matter (0.3.0)
- jekyll (~> 3.0)
- jekyll-paginate (1.1.0)
- jekyll-readme-index (0.2.0)
- jekyll (~> 3.0)
- jekyll-redirect-from (0.14.0)
- jekyll (~> 3.3)
- jekyll-relative-links (0.5.3)
- jekyll (~> 3.3)
- jekyll-remote-theme (0.3.1)
- jekyll (~> 3.5)
- rubyzip (>= 1.2.1, < 3.0)
- jekyll-sass-converter (1.5.2)
- sass (~> 3.4)
- jekyll-seo-tag (2.5.0)
- jekyll (~> 3.3)
- jekyll-sitemap (1.2.0)
- jekyll (~> 3.3)
- jekyll-swiss (0.4.0)
- jekyll-theme-architect (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-cayman (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-dinky (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-hacker (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-leap-day (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-merlot (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-midnight (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-minimal (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-modernist (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-primer (0.5.3)
- jekyll (~> 3.5)
- jekyll-github-metadata (~> 2.9)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-slate (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-tactile (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-theme-time-machine (0.1.1)
- jekyll (~> 3.5)
- jekyll-seo-tag (~> 2.0)
- jekyll-titles-from-headings (0.5.1)
- jekyll (~> 3.3)
- jekyll-watch (2.1.2)
- listen (~> 3.0)
- jemoji (0.10.1)
- gemoji (~> 3.0)
- html-pipeline (~> 2.2)
- jekyll (~> 3.0)
- kramdown (1.17.0)
- liquid (4.0.0)
- listen (3.1.5)
- rb-fsevent (~> 0.9, >= 0.9.4)
- rb-inotify (~> 0.9, >= 0.9.7)
- ruby_dep (~> 1.2)
- mercenary (0.3.6)
- mini_portile2 (2.3.0)
- minima (2.5.0)
- jekyll (~> 3.5)
- jekyll-feed (~> 0.9)
- jekyll-seo-tag (~> 2.1)
- minitest (5.11.3)
- multipart-post (2.0.0)
- nokogiri (1.8.5)
- mini_portile2 (~> 2.3.0)
- octokit (4.13.0)
- sawyer (~> 0.8.0, >= 0.5.3)
- parallel (1.12.1)
- pathutil (0.16.2)
- forwardable-extended (~> 2.6)
- public_suffix (2.0.5)
- rb-fsevent (0.10.3)
- rb-inotify (0.10.0)
- ffi (~> 1.0)
- rouge (2.2.1)
- ruby-enum (0.7.2)
- i18n
- ruby_dep (1.5.0)
- rubyzip (1.2.2)
- safe_yaml (1.0.4)
- sass (3.7.2)
- sass-listen (~> 4.0.0)
- sass-listen (4.0.0)
- rb-fsevent (~> 0.9, >= 0.9.4)
- rb-inotify (~> 0.9, >= 0.9.7)
- sawyer (0.8.1)
- addressable (>= 2.3.5, < 2.6)
- faraday (~> 0.8, < 1.0)
- terminal-table (1.8.0)
- unicode-display_width (~> 1.1, >= 1.1.1)
- thread_safe (0.3.6)
- typhoeus (1.3.1)
- ethon (>= 0.9.0)
- tzinfo (1.2.5)
- thread_safe (~> 0.1)
- unicode-display_width (1.4.1)
- yell (2.0.7)
-
-PLATFORMS
- ruby
-
-DEPENDENCIES
- github-pages
- html-proofer
- jekyll-feed
- jekyll-sitemap
-
-BUNDLED WITH
- 1.17.3
diff --git a/docs/LICENSE.md b/docs/LICENSE.md
deleted file mode 100644
index d28231d06..000000000
--- a/docs/LICENSE.md
+++ /dev/null
@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2018 Nicolas Vanhoren
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
diff --git a/docs/_config.yml b/docs/_config.yml
deleted file mode 100644
index f9b896ebd..000000000
--- a/docs/_config.yml
+++ /dev/null
@@ -1,44 +0,0 @@
-# Welcome to Jekyll!
-#
-# This config file is meant for settings that affect your whole blog, values
-# which you are expected to set up once and rarely edit after that. If you find
-# yourself editing this file very often, consider using Jekyll's data files
-# feature for the data you need to update frequently.
-#
-# For technical reasons, this file is *NOT* reloaded automatically when you use
-# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
-
-# Site settings
-# These are used to personalize your new site. If you look in the HTML files,
-# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
-# You can create any custom variable you would like, and they will be accessible
-# in the templates via {{ site.myvariable }}.
-title: Mirror
-email: ""
-description: >-
- Documentation for Mirror, a high level networking library for Unity
-#baseurl: "" # the subpath of your site, e.g. /blog
-#url: "" # the base hostname & protocol for your site, e.g. http://example.com
-#twitter_username: jekyllrb
-#github_username: jekyll
-
-repository: "vis2k/Mirror"
-
-# Build settings
-plugins:
- - jekyll-feed
- - jekyll-sitemap
-
-# A list of the pages to display in the navigation bar
-header_pages:
-
-# Exclude from processing.
-# The following items will not be processed, by default. Create a custom list
-# to override the default setting.
-exclude:
- - Gemfile
- - Gemfile.lock
- - node_modules
- - update_boostrap.sh
- - vendor
-
\ No newline at end of file
diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml
deleted file mode 100644
index 22c84aa83..000000000
--- a/docs/_data/navigation.yml
+++ /dev/null
@@ -1,176 +0,0 @@
-- title: "General"
- children:
- - title: "Overview"
- url: "/General"
- - title: "Getting Started"
- url: "/General/Start"
- - title: "Migration Guide"
- url: "/General/Migration"
- - title: "Deprecations"
- url: "/General/Deprecations"
- - title: "ChangeLog"
- url: "/General/ChangeLog"
- - title: "Showcase"
- url: "/General/Showcase"
- - title: "Integrations"
- url: "/General/Integrations"
- - title: "Why TCP?"
- url: "/General/WhyTCP"
- - 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"
- - title: "Authentication"
- url: "/Concepts/Authentication"
- - title: "Conversion"
- url: "/Concepts/Conversion"
- - title: "Clock Synchronization"
- url: "/Concepts/ClockSync"
- - title: "State Syncronization"
- url: "/Concepts/StateSync"
- - 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"
- - title: "NetworkLobbyManager"
- url: "/Components/NetworkLobbyManager"
- - title: "NetworkLobbyPlayer"
- url: "/Components/NetworkLobbyPlayer"
- - 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"
-- title: "Classes"
- children:
- - title: "Overview"
- url: "/Classes"
- - title: "NetworkServer"
- url: "/Classes/NetworkServer"
- - title: "NetworkConnection"
- url: "/Classes/NetworkConnection"
- - title: "NetworkClient"
- url: "/Classes/NetworkClient"
- - title: "NetworkBehaviour"
- url: "/Classes/NetworkBehaviour"
- - title: "Attributes"
- url: "/Classes/Attributes"
- - title: "SyncVars"
- url: "/Classes/SyncVars"
- - title: "SyncVar Hooks"
- url: "/Classes/SyncVarHook"
- - title: "SyncEvents"
- url: "/Classes/SyncEvent"
- - title: "SyncLists"
- url: "/Classes/SyncLists"
- - title: "SyncDictionary"
- url: "/Classes/SyncDictionary"
- - title: "SyncHashSet"
- url: "/Classes/SyncHashSet"
- - title: "SyncSortedSet"
- url: "/Classes/SyncSortedSet"
-- 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"
- - title: "UDP - LiteNetLib4Mirror"
- url: "/Transports/LiteNetLib4Mirror"
- - title: "WebGL - WebSockets"
- url: "/Transports/WebSockets"
- - title: "Steam - Fizzy"
- url: "/Transports/Fizzy"
- - title: "Multiplexer - Multiplexer"
- url: "/Transports/Multiplexer"
- - title: "Socket - Insight"
- url: "/Transports/Insight"
-- title: "Example Projects"
- children:
- - title: "Overview"
- url: "/Examples"
- - title: "Pong"
- url: "/Examples/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"
diff --git a/docs/_includes/disqus.html b/docs/_includes/disqus.html
deleted file mode 100644
index c7d4ed7d9..000000000
--- a/docs/_includes/disqus.html
+++ /dev/null
@@ -1,21 +0,0 @@
-
-
-
-
\ No newline at end of file
diff --git a/docs/_includes/f_sidebar_nav.html b/docs/_includes/f_sidebar_nav.html
deleted file mode 100644
index ab1752ff4..000000000
--- a/docs/_includes/f_sidebar_nav.html
+++ /dev/null
@@ -1,36 +0,0 @@
-
-{% if include.item.children %}
-
- {{include.item.title}}
-
- {% assign pageurl = page.url | remove: '.html' %}
-
- {% capture capturechild %}
- {% for child in include.item.children %}
-
- {% assign active = "" %}
- {% assign childurlfolder = child.url | append: '/' %}
- {% if child.url and (pageurl == child.url or pageurl == childurlfolder) %}
- {% assign active = "active bd-sidenav-active" %}
- {% endif %}
-
-
-
-
\ No newline at end of file
diff --git a/docs/_includes/sidebar.html b/docs/_includes/sidebar.html
deleted file mode 100644
index c52d76f49..000000000
--- a/docs/_includes/sidebar.html
+++ /dev/null
@@ -1,11 +0,0 @@
-
-
-
-
\ No newline at end of file
diff --git a/docs/_includes/toc.html b/docs/_includes/toc.html
deleted file mode 100644
index bb45d1b3a..000000000
--- a/docs/_includes/toc.html
+++ /dev/null
@@ -1,87 +0,0 @@
-{% capture tocWorkspace %}
- {% comment %}
- Version 1.0.6
- https://github.com/allejo/jekyll-toc
-
- "...like all things liquid - where there's a will, and ~36 hours to spare, there's usually a/some way" ~jaybe
-
- Usage:
- {% include toc.html html=content sanitize=true class="inline_toc" id="my_toc" h_min=2 h_max=3 %}
-
- Parameters:
- * html (string) - the HTML of compiled markdown generated by kramdown in Jekyll
-
- Optional Parameters:
- * sanitize (bool) : false - when set to true, the headers will be stripped of any HTML in the TOC
- * class (string) : '' - a CSS class assigned to the TOC
- * id (string) : '' - an ID to assigned to the TOC
- * h_min (int) : 1 - the minimum TOC header level to use; any header lower than this value will be ignored
- * h_max (int) : 6 - the maximum TOC header level to use; any header greater than this value will be ignored
- * ordered (bool) : false - when set to true, an ordered list will be outputted instead of an unordered list
- * item_class (string) : '' - add custom class(es) for each list item; has support for '%level%' placeholder, which is the current heading level
- * baseurl (string) : '' - add a base url to the TOC links for when your TOC is on another page than the actual content
- * anchor_class (string) : '' - add custom class(es) for each anchor element
-
- Output:
- An ordered or unordered list representing the table of contents of a markdown block. This snippet will only
- generate the table of contents and will NOT output the markdown given to it
- {% endcomment %}
-
- {% capture my_toc %}{% endcapture %}
- {% assign orderedList = include.ordered | default: false %}
- {% assign minHeader = include.h_min | default: 1 %}
- {% assign maxHeader = include.h_max | default: 6 %}
- {% assign nodes = include.html | split: ' maxHeader %}
- {% continue %}
- {% endif %}
-
- {% if firstHeader %}
- {% assign firstHeader = false %}
- {% assign minHeader = headerLevel %}
- {% endif %}
-
- {% assign indentAmount = headerLevel | minus: minHeader | add: 1 %}
- {% assign _workspace = node | split: '' | first }}>{% endcapture %}
- {% assign header = _workspace[0] | replace: _hAttrToStrip, '' %}
-
- {% assign space = '' %}
- {% for i in (1..indentAmount) %}
- {% assign space = space | prepend: ' ' %}
- {% endfor %}
-
- {% unless include.item_class == blank %}
- {% capture listItemClass %}{:.{{ include.item_class | replace: '%level%', headerLevel }}}{% endcapture %}
- {% endunless %}
-
- {% capture my_toc %}{{ my_toc }}
-{{ space }}{{ listModifier }} {{ listItemClass }} [{% if include.sanitize %}{{ header | strip_html }}{% else %}{{ header }}{% endif %}]({% if include.baseurl %}{{ include.baseurl }}{% endif %}#{{ html_id }}){% if include.anchor_class %}{:.{{ include.anchor_class }}}{% endif %}{% endcapture %}
- {% endfor %}
-
- {% if include.class %}
- {% capture my_toc %}{:.{{ include.class }}}
-{{ my_toc | lstrip }}{% endcapture %}
- {% endif %}
-
- {% if include.id %}
- {% capture my_toc %}{: #{{ include.id }}}
-{{ my_toc | lstrip }}{% endcapture %}
- {% endif %}
-{% endcapture %}{% assign tocWorkspace = '' %}{{ my_toc | markdownify | strip }}
\ No newline at end of file
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
deleted file mode 100644
index eb2318f9c..000000000
--- a/docs/_layouts/default.html
+++ /dev/null
@@ -1,33 +0,0 @@
-
-
-
- {%- include head.html -%}
-
-
- {%- include header.html -%}
-
-
-
-
- {%- include sidebar.html -%}
-
-
- {%- include toc.html html=content class="section-nav" item_class="toc-entry" -%}
-
-
-
-
- {{ content }}
-
- {%- include disqus.html -%}
-
- {%- include footer.html -%}
-