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

Commit 8af0038

Browse files
authored
Update README.md
1 parent de6df5f commit 8af0038

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,13 @@ The MLAPI.Relay is a relay designed for the UNET Transport to relay traffic betw
1616
* Receive
1717
* ReceiveFromHost
1818

19+
## Features
20+
* Written in .NET Core for Cross platform
21+
* Allows you to limit bandwidth (optional)
22+
* Update checking (optional). _This will check for updates and inform you of new updates._
23+
* Deploy and forget Auto-update (optional). _The auto update feature allows you to deploy the relay and it will auto update whenever needed._
24+
* Disable home calling. _The MLAPI will only do connections to external sources for update checking purposes. This can be disabled._
25+
1926
## Special setup
2027
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.
2128

@@ -38,6 +45,8 @@ Relay config contains many different fields.
3845
**THIS HAS TO BE THE SAME ON THE GAME INSTANCE. SEE NOTES**
3946
* port is the relay port
4047
* bufferSize is the size of the buffer that will be allocated for messages
48+
* updateChecking toggles wheter or not the relay should do web requests to check for updates. This will not by itself enable auto update.
49+
* autoUpdate toggles wheter or not the relay will automatically download and deploy the latest updates. This requires updateChecking to be turned on.
4150
* licenceKey is the licence key you got when purchasing your licence. If this is empty or invalid, a trial licence will be used
4251
* channels is the list of channelTypes that should be used. In the order they are added
4352
* bandwidthGracePeriodLength is the length of the bandwidth grace peridod from the point where a client connects

0 commit comments

Comments
 (0)