You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Aug 8, 2018. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+1-10Lines changed: 1 addition & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2

3
3
4
4
## Introduction
5
-
The documentation and the relay itself is currently WIP. This is subject to change.
5
+
_The documentation and the relay itself is currently WIP. This is subject to change._
6
6
7
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:
8
8
* Connect
@@ -48,7 +48,6 @@ This is the NetworkTransport GlobalConfig. This instructs the NetworkTransport h
48
48
Relay config contains many different fields.
49
49
50
50
* maxConnections is the maximum amount of connections the relay can support.
51
-
**THIS HAS TO BE THE SAME ON THE GAME INSTANCE. SEE NOTES**
52
51
* port is the relay port
53
52
* bufferSize is the size of the buffer that will be allocated for messages
54
53
* updateChecking toggles wheter or not the relay should do web requests to check for updates. This will not by itself enable auto update.
@@ -59,13 +58,5 @@ Relay config contains many different fields.
59
58
* 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.
60
59
* 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.
61
60
62
-
## Important notes
63
-
#### MaxConnections
64
-
The relay uses the UNET Transport under the hood.
65
-
The MaxConnections setting is a part of the CRC check that happens during the initial handshake.
66
-
By the default the Relay will be setup to handle 4 for the HLAPI config, 100 for the MALPI config and 65534 for Empty.
67
-
This means that if for example you want more than 4 players on the relay and you are using the HLAPI config.
68
-
You HAVE to set the MaxConnections to a larger value on the game instance AND the relay.
69
-
They need to match up. (I think this might be a bug, it's been reported)
70
61
## Trial licence
71
62
The trial licence has no limitations except that only 20 concurrent connections are allowed. This is to allow for endless evaluation and development.
0 commit comments