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

Commit 2a6b759

Browse files
authored
Update README.md
1 parent 73ac762 commit 2a6b759

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
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:
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. Despite the naming, the MLAPI.Relay does not have to be used with the MLAPI library. It can be used with any game built on the NetworkTransport, including the HLAPI. The MLAPI.Relay includes default configurations for use with the MLAPI, HLAPI and an empty template for custom setups. To use the relay simply replace the NetworkTransport with the RelayTransport where the following methods are used:
88
* Connect
99
* AddHost
1010
* AddHostWithSimulator
@@ -52,7 +52,7 @@ Relay config contains many different fields.
5252
* updateChecking toggles wheter or not the relay should do web requests to check for updates. This will not by itself enable auto update.
5353
* autoUpdate toggles wheter or not the relay will automatically download and deploy the latest updates. This requires updateChecking to be turned on.
5454
* licenceKey is the licence key you got when purchasing your licence. If this is empty or invalid, a trial licence will be used
55-
* channels is the list of channelTypes that should be used. In the order they are added
55+
* channels is the list of channelTypes that should be used. In the order they are added. Note that some high level libraries have default channels that are added in addition to the user channels. Therefor the relay has templates for the MLAPI default channels and the HLAPI channels. When using these templates, the channels added are only the library channels. User channels have to be added additionaly.
5656
* bandwidthGracePeriodLength is the length of the bandwidth grace peridod from the point where a client connects
5757
* gracePeriodBandwidthLimit is the amount of bytes per second that is allowed during the bandwidth grace period for each client. If this 0 or less. No limit will be used during the grace period.
5858
* bandwidthLimit is the amount of bytes per second that is allowed to be used for each client outside of the grace period. If this is 0 or less, no limit will be used.

0 commit comments

Comments
 (0)