diff --git a/doc/Transports/Fallback.PNG b/doc/Transports/Fallback.PNG new file mode 100644 index 000000000..460bca30a Binary files /dev/null and b/doc/Transports/Fallback.PNG differ diff --git a/doc/Transports/Fallback.md b/doc/Transports/Fallback.md index 1d6d63200..1c76a5207 100644 --- a/doc/Transports/Fallback.md +++ b/doc/Transports/Fallback.md @@ -1,4 +1,4 @@ -# FallbackTransport +# Fallback Transport The FallbackTransport can be used to work around transport platform limits. @@ -15,4 +15,6 @@ Usage: 5. Add a ApathyTransport component to the gameobject 6. Add both ApathyTransport and TelepathyTransport to the FallbackTransport's transport property. -Important: all fallback transport need to be binary compatible with each other. For example, it might happen that the server runs Apathy and a client connects to it with Telepathy. \ No newline at end of file +Important: all fallback transport need to be binary compatible with each other. For example, it might happen that the server runs Apathy and a client connects to it with Telepathy. + +![The Fallback Transport](Fallback.PNG) diff --git a/doc/Transports/Fizzy.md b/doc/Transports/Fizzy.md index 14ce3bc2b..d3ff06bfc 100644 --- a/doc/Transports/Fizzy.md +++ b/doc/Transports/Fizzy.md @@ -1,8 +1,8 @@ -# FizzySteam +# FizzySteam Transport Fizzy Steam is a Steam P2P transport for Mirror, it utilizes Steam's P2P service to directly connect or relay your connection to another player. Fizzy Steam is based of [Steamworks.Net](https://github.com/rlabrecque/Steamworks.NET) wrapper. -You can get the release **[Here](https://github.com/Raystorms/FizzySteamyMirror/releases)** with the latest version of Steamworks.Net included or you can clone the repo **[Here](https://github.com/Raystorms/FizzySteamyMirror)**. +You can get the release **[Here](https://github.com/Chykary/FizzySteamyMirror/releases)** with the latest version of Steamworks.Net included or you can clone the repo **[Here](https://github.com/Chykary/FizzySteamyMirror)**. ## Features @@ -14,7 +14,7 @@ You can get the release **[Here](https://github.com/Raystorms/FizzySteamyMirror/ ## Credits * [Fizz Cube](https://github.com/FizzCube) : Original author for this Transport. -* [Raystorms](https://github.com/Raystorms) : The current maintainer for this Transport. +* [Chykary](https://github.com/Chykary/FizzySteamyMirror) : The current maintainer for this Transport. * [rlabrecque](https://github.com/rlabrecque) : Creator of Steamworks.Net. * [vis2k](https://github.com/vis2k) : Creator of Mirror. * Valve : Steam diff --git a/doc/Transports/LiteNetLib4Mirror.md b/doc/Transports/LiteNetLib4Mirror.md index f6a3e357d..6a4001acf 100644 --- a/doc/Transports/LiteNetLib4Mirror.md +++ b/doc/Transports/LiteNetLib4Mirror.md @@ -1,4 +1,4 @@ -# LiteNetLib4Mirror +# LiteNetLib4Mirror Transport General description of LiteNetLib4Mirror diff --git a/doc/Transports/Multiplexer.md b/doc/Transports/Multiplexer.md index 7d90e7e1e..d3091c5b4 100644 --- a/doc/Transports/Multiplexer.md +++ b/doc/Transports/Multiplexer.md @@ -1,4 +1,4 @@ -# MultiplexTransport +# Multiplex Transport The MultiplexTransport is not a transport itself, but it allows you to combine other transports so that your clients can connect to your servers via either one of them. diff --git a/doc/Transports/Telepathy.md b/doc/Transports/Telepathy.md index 2194afb6b..1c8cb0aa7 100644 --- a/doc/Transports/Telepathy.md +++ b/doc/Transports/Telepathy.md @@ -1,4 +1,4 @@ -# Telepathy +# Telepathy Transport Simple, message based, MMO Scale TCP networking in C\#. And no magic. - Telepathy was designed with the [KISS Principle](https://en.wikipedia.org/wiki/KISS_principle) in mind. diff --git a/doc/Transports/WebSockets.md b/doc/Transports/WebSockets.md index e089df80a..55aef6a50 100644 --- a/doc/Transports/WebSockets.md +++ b/doc/Transports/WebSockets.md @@ -1,4 +1,4 @@ -# WebSockets +# WebSockets Transport General description of WebSockets diff --git a/doc/Transports/index.md b/doc/Transports/index.md index dd7949b64..405e4ec62 100644 --- a/doc/Transports/index.md +++ b/doc/Transports/index.md @@ -12,7 +12,7 @@ Mirror is a high level Networking Library that can use several different low lev - [Fallback](Fallback.md) Fallback is a compatibility transport for transports that don't run on all platforms and need fallback options to cover all other platforms. -- [Discord - Discord-Mirror](DiscordMirror.md) Discord-Mirror is a networking transport that enables sending networking packets via [Discord's Game SDK](https://discordapp.com/developers/docs/game-sdk/sdk-starter-guide). +- [Discord](DiscordMirror.md) Discord-Mirror is a networking transport that enables sending networking packets via [Discord's Game SDK](https://discordapp.com/developers/docs/game-sdk/sdk-starter-guide). - [UDP - Ignorance](Ignorance.md) Ignorance implements a reliable and unreliable sequenced UDP transport based on ENet.