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

Updated Transport docs

Browse Source
This commit is contained in:
Chris Langsenkamp 2020-02-11 19:15:39 -05:00
parent 3277fce728
commit 22c8d3da5f
8 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/Transports/Fallback.PNG Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 82 KiB

4
doc/Transports/Fallback.md
View File

@ -1,4 +1,4 @@
# FallbackTransport # Fallback Transport
The FallbackTransport can be used to work around transport platform limits. The FallbackTransport can be used to work around transport platform limits.
@ -16,3 +16,5 @@ Usage:
6. Add both ApathyTransport and TelepathyTransport to the FallbackTransport's transport property. 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. 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)

6
doc/Transports/Fizzy.md
View File

@ -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. 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 ## Features
@ -14,7 +14,7 @@ You can get the release **[Here](https://github.com/Raystorms/FizzySteamyMirror/
## Credits ## Credits
* [Fizz Cube](https://github.com/FizzCube) : Original author for this Transport. * [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. * [rlabrecque](https://github.com/rlabrecque) : Creator of Steamworks.Net.
* [vis2k](https://github.com/vis2k) : Creator of Mirror. * [vis2k](https://github.com/vis2k) : Creator of Mirror.
* Valve : Steam * Valve : Steam

2
doc/Transports/LiteNetLib4Mirror.md
View File

@ -1,4 +1,4 @@
# LiteNetLib4Mirror # LiteNetLib4Mirror Transport
General description of LiteNetLib4Mirror General description of LiteNetLib4Mirror

2
doc/Transports/Multiplexer.md
View File

@ -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. 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.

2
doc/Transports/Telepathy.md
View File

@ -1,4 +1,4 @@
# Telepathy # Telepathy Transport
Simple, message based, MMO Scale TCP networking in C\#. And no magic. 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. - Telepathy was designed with the [KISS Principle](https://en.wikipedia.org/wiki/KISS_principle) in mind.

2
doc/Transports/WebSockets.md
View File

@ -1,4 +1,4 @@
# WebSockets # WebSockets Transport
General description of WebSockets General description of WebSockets

2
doc/Transports/index.md
View File

@ -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. - [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. - [UDP - Ignorance](Ignorance.md) Ignorance implements a reliable and unreliable sequenced UDP transport based on ENet.