[Standalone UNET Relay] MLAPI.Relay

Hello!

I have created a UNET standalone relay that I want to share with you.

Issues & Support
Bugs should be reported on the GitHub Issue Tracker. Questions can be asked on this thread or in the MLAPI Discord server.

Compatibility
The relay is tested on the HLAPI and the MLAPI but works on all UNET projects. The Relay requires .NET Core to be installed on the target machine.

Usage
Using the relay is really straight forward. First, download the RelayTransport class.
Then replace NetworkTransport with RelayTransport everywhere where these methods are used:

• Connect
• ConnectEndPoint
• ConnectWithSimulator
• AddHost
• AddHostWithSimulator
• AddWebsocketHost
• Disconnect
• Send
• QueueMessageForSending
• SendQueuedMessages
• Receive
• ReceiveFromHost

Example: NetworkTransport.Connect(signatureGoesHere) => RelayTransport.Connect(sameSignature);


Even if you do this, you can still use connect without relay by setting the RelayTransport.Enabled to false. Setting the RelayTransport.Enabled to false will make the relay transport act exactly like the NetworkTransport with no changes.
And that's it!

I really hope you find this useful. More documentation about configuration etc and the RelayTransport class can be found on GitHub. Note that the RelayTransport class is open source and is licenced as "public domain". For the exact licence. See the licence file. This licence is for the RelayTransport only and does not cover the Relay itself, any documentation or external libraries.


GitHub

 

Ok, setup Ubuntu 18.04 LTS, installed .NET via Microsoft's docs, and got the 0.0.0.2v of the app. Ran the ./start-relay.sh and got this error - https://www.dropbox.com/s/imnf45wfuab3tl3/Screenshot 2018-06-28 14.02.45.png?dl=0

 

What .NET version?

 

Resolved in v0.0.0.3

 

The relay has now been made open source.
https://github.com/MidLevel/MLAPI.Relay

 

It looks like if your game currently uses Unity's relay service, that this is probably the most viable solution to keep your game running if you intend to keep it alive after Unity shuts down their relays in a few years.

 

Yea, now that it's open source it will be free with no limits. Since it's so easy to actually enable (not much code change), it should make a switch super smooth. The only thing that might be a bit offputting is the licence. It's AGPL, meaning if you change the code and use it in some way (even self host), you have to publish your source. (Ex via PR or fork)

 

Actually, after rethinking my choice of licence, I realized that AGPL was a mistake. It has been switched to GPL. This is to allow private modified versions of the software which is useful for things like custom authentication. I always want the licence to encourage creativity and collaboration, not be a limiting factor of what you can do.

However, the RelayTransport will continue to be public domain.

 

Hey, this is great, thanks for doing this!

 

this great,thanks @TwoTen