Skip to content
This repository was archived by the owner on Aug 8, 2018. It is now read-only.

Commit 9395ed0

Browse files
authored
Update README.md
1 parent 6a05483 commit 9395ed0

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,20 @@
44
## Introduction
55
The documentation and the relay itself is currently WIP. This is subject to change.
66

7+
The MLAPI.Relay is a relay designed for the UNET Transport to relay traffic between peers that are hidden behind a NAT. Relaying traffic can be expensive but will allow you to communicate no matter what NAT type the host is behind. The MLAPI.Relay works just like the NetworkTransport. To use the relay simply replace the NetworkTransport with the RelayTransport where the following methods are used:
8+
* Connect
9+
* AddHost
10+
* AddHostWithSimulator
11+
* AddWebsocketHost
12+
* Disconnect
13+
* Send
14+
* QueueMessageForSending
15+
* SendQueuedMessages
16+
* Receive
17+
18+
## Special setup
19+
The MLAPI.Relay REQUIRES there to be at least ONE reliable channel type. If it is plain reliable or has sequencing or fragmenting support does not matter.
20+
721
## Configuration
822
The relay has a config file called config.json. The config contains 3 parts
923

0 commit comments

Comments
 (0)