FishyUnityTransport

A UnityTransport implementation for Fish-Net.

If you have further questions, come find me as ooonush in the FirstGearGames Discord!

The FishyUnityTransport library API is close to UnityTransport for NGO and uses some of its code.

Setting Up

1. Install Fish-Net from the official repo or Asset Store.
2. Install UnityTransport package (1.3.1 or newer).
3. Install FishyUnityTransport unitypackage from the release section or using the Git URL:

   https://github.com/ooonush/FishyUnityTransport.git?path=Assets/FishNet/Plugins/FishyUnityTransport
   

4. Add UnityTransport component to NetworkManager GameObject.
5. Set Transport variable on the TransportManager component to UnityTransport.

Relay

With FishyUnityTransport, you can use an IP address and port to connect to a Dedicated Server. However, if you want to use a player device as a server (host), using an IP address to establish a connection does not always work. For example, the device's firewall may prohibit these kinds of connections because they are not secure. Instead, use Unity Relay to successfully initiate a connection between multiple clients and a host.

Many factors impact how you connect to the remote host. To connect to a remote host, use one of the following methods:

• Perform a NAT punchthrough: This advanced technique directly connects to the host computer, even if it's on another network.
• Use a Relay server: A Relay server exists on the internet with a public-facing IP that you and the host can access. After the client and the host connect to a relay server, they can send data to each other through the Relay server.

FishNet doesn't offer tools to help you punch through a NAT. However, you can use the Relay service provided by Unity Services.

Unity Relay support

FishyUnityTransport supports Unity Relay, and since its API is similar to the UnityTransport for NGO API,

Installation and configuration

1. In the Unity Editor's Package Manager, select Unity Registry.
2. Search for the following package:
   • For Unity 2022 LTS and later: com.unity.services.multiplayer
   • For earlier versions of Unity: com.unity.services.relay
3. Select the package, then Install. Refer to Package Manager.

Note: For most users, the unified Multiplayer Services package replaces the Relay standalone package, which is deprecated in Unity 6. Consider migrating to the unified package to facilitate a smooth transition. Visit the migration guide for a step-by-step transition process.

You must first configure your Unity project for Unity before using Relay with FishNet. Check out Get started with Relay to learn how to link your project in the project settings.

How to use Relay

To access a Relay server, do the following:

• As the host, request an allocation on the relay server.
• As a client, use the join code that the host creates to connect to the relay server. This code allows the host and clients to communicate through the Relay server without disclosing their IP addresses and ports directly.

Create allocation on a Relay server

To create an allocation on a Relay server, make an authenticated call to the Unity backend using the SDK. To do this, call the CreateAllocationAsync method on the host with the maximum number of expected peers. For example, a host that requests a maximum of three peer connections reserves four slots for a four player game. This function can throw exceptions, which you can catch to learn about the error that caused them.

//Ask Unity Services to allocate a Relay server that will handle up to eight players: seven peers and the host.
Allocation allocation = await Unity.Services.Relay.RelayService.Instance.CreateAllocationAsync(7);

The Allocation class represents all the necessary data for a host player to start hosting using the specific Relay server allocated. You don't need to understand each part of this allocation; you only need to feed them to your chosen transport that handles the Relay communication on its own. For the more curious (and for reference), here's a simple overview of those parameters:

• A RelayServer class containing the IP and port of your allocation's server.
• The allocation ID in a Base64 form and GUID form referred to as AllocationIdBytes and AllocationId.
• A blob of encrypted bytes representing the connection data (known as ConnectionData) allows users to connect to this host.
• A Base64 encoded Key for message signature.

Each allocation creates a unique join code suitable for sharing over instant messages or other means. This join code allows your clients to join your game. You can retrieve it by calling the Relay SDK like so:

string joinCode = await Unity.Services.Relay.RelayService.Instance.GetJoinCodeAsync(allocation.AllocationId);

With those two calls, you now have your Relay allocation ready and the associated join code. Pass the allocation parameters to your host transport and send the join code (a simple string) over the Internet by the mean of your choice to your clients.

Remember to authenticate your users before using SDK methods. The easiest way is the anonymous one (shown in the following code snippet), but you can use more advanced techniques.

//Initialize the Unity Services engine
await UnityServices.InitializeAsync();
if (!AuthenticationService.Instance.IsSignedIn)
{
    //If not already logged, log the user in
    await AuthenticationService.Instance.SignInAnonymouslyAsync();
}

Join an allocation on a Relay server

To join an allocation on a Relay server, the following must be true:

• The host of the game has created a Relay allocation.
• The client has received a join code.

To join a relay, a client requests all the allocation parameters from the join code to join the game. To do this, use the join code to call the JoinAllocationAsync method as the following code snippet demonstrates:

//Ask Unity Services to join a Relay allocation based on our join code
JoinAllocation allocation = await Unity.Services.Relay.RelayService.Instance.JoinAllocationAsync(joinCode);

For more information about the join code connection process, refer to Connection flow.

Pass allocation data to a transport component

When an allocation exists, you need to make all traffic that comes from FishNet go through the Relay. To do this, perform the following actions to pass the allocation parameters to UnityTransport:

1. Retrieve UnityTransport from your NetworkManager:

//Retrieve the UnityTransport used by the NetworkManager
UnityTransport transport = NetworkManager.TransportManager.GetTransport<UnityTransport>();

2. Call the SetRelayServerData method on the retrieved transport by passing the allocation data that you retrieved, as well as the connection type (here set to dtls). For example:

transport.SetRelayServerData(new RelayServerData(allocation, connectionType:"dtls"));

3. Call NetworkManager.ServerManager.StartConnection() to start server or NetworkManager.ClientManager.StartConnection() to start client.

Code samples

Use the following code to work with the Relay server. For more information, refer to Unity Relay.

Host player

The StartHostWithRelay function shows how to create a Relay allocation, and request a join code. This function requires the maximum number of connections the allocation is expecting and the host player connection type.

The connection type must be one of the following options:

• udp
• dtls
• wss

Refer to DTLS to learn more about DTLS encryption, and to Web Platform Support to learn about using wss.

Using the Multiplayer Services SDK (com.unity.services.multiplayer)

[SerializeField] private NetworkManager _networkManager;

public async Task<string> StartHostWithRelay(int maxConnections, string connectionType)
{
    await UnityServices.InitializeAsync();
    if (!AuthenticationService.Instance.IsSignedIn)
    {
        await AuthenticationService.Instance.SignInAnonymouslyAsync();
    }

    // Request allocation and join code
    Allocation allocation = await RelayService.Instance.CreateAllocationAsync(maxConnections);
    var joinCode = await RelayService.Instance.GetJoinCodeAsync(allocation.AllocationId);
    // Configure transport
    var unityTransport = _networkManager.TransportManager.GetTransport<UnityTransport>();
    unityTransport.SetRelayServerData(AllocationUtils.ToRelayServerData(allocation, connectionType));

    // Start host
    if (_networkManager.ServerManager.StartConnection()) // Server is successfully started.
    {
        _networkManager.ClientManager.StartConnection(); // You can choose not to call this method. Then only the server will start.
        return joinCode;
    }
    return null;
}

This code should be adapted to your needs to use a different authentication mechanism, a different error handling, or to use a different connection type. Similarly, you can start only the server instead of the host, to start a server instead of a host.

Using the Relay standalone SDK (com.unity.services.relay)

[SerializeField] private NetworkManager _networkManager;

public async Task<string> StartHostWithRelay(int maxConnections, string connectionType)
{
    await UnityServices.InitializeAsync();
    if (!AuthenticationService.Instance.IsSignedIn)
    {
        await AuthenticationService.Instance.SignInAnonymouslyAsync();
    }

    // Request allocation and join code
    Allocation allocation = await RelayService.Instance.CreateAllocationAsync(maxConnections);
    var joinCode = await RelayService.Instance.GetJoinCodeAsync(allocation.AllocationId);
    // Configure transport
    var unityTransport = _networkManager.TransportManager.GetTransport<UnityTransport>();
    unityTransport.SetRelayServerData(new RelayServerData(allocation, connectionType));

    // Start host
    if (_networkManager.ServerManager.StartConnection()) // Server is successfully started.
    {
        _networkManager.ClientManager.StartConnection(); // You can choose not to call this method. Then only the server will start.
        return joinCode;
    }
    return null;
}

Joining player

When your game client functions as a joining player, the relay join code, retrieved in the previous step when the host created the allocation, must be passed to find the allocation. The following code samples show how to join an allocation with a join code and configure the connection type.

The connection type must be one of the following options:

• udp
• dtls
• wss

Refer to DTLS to learn more about DTLS encryption, and to Web Platform Support to learn about using wss.

Using the Multiplayer Services SDK (com.unity.services.multiplayer)

Using the Multiplayer Services SDK (com.unity.services.multiplayer)

public async Task<bool> StartClientWithRelay(string joinCode, string connectionType)
{
    await UnityServices.InitializeAsync();
    if (!AuthenticationService.Instance.IsSignedIn)
    {
        await AuthenticationService.Instance.SignInAnonymouslyAsync();
    }

    var allocation = await RelayService.Instance.JoinAllocationAsync(joinCode: joinCode);
    NetworkManager.Singleton.GetComponent<UnityTransport>().SetRelayServerData(AllocationUtils.ToRelayServerData(allocation, connectionType));
    return !string.IsNullOrEmpty(joinCode) && NetworkManager.Singleton.StartClient();
}

Using the Relay standalone SDK (com.unity.services.relay)

public async Task<bool> StartClientWithRelay(string joinCode, string connectionType)
{
    await UnityServices.InitializeAsync();
    if (!AuthenticationService.Instance.IsSignedIn)
    {
        await AuthenticationService.Instance.SignInAnonymouslyAsync();
    }

    var allocation = await RelayService.Instance.JoinAllocationAsync(joinCode);
    NetworkManager.Singleton.GetComponent<UnityTransport>().SetRelayServerData(new RelayServerData(allocation, connectionType));
    return !string.IsNullOrEmpty(joinCode) && NetworkManager.Singleton.StartClient();
}

Note about WebGL support

To use Relay with FishNet in WebGL, you must upgrade the Unity Transport Package to 2.0.0 or later and configure the FishyUnityTransport component to use Web Sockets.

Using the above code snippets, pass wss as connectionType and use the following to SetRelayServerData:

Using the Multiplayer Services SDK (com.unity.services.multiplayer)

var unityTransport = _networkManager.TransportManager.GetTransport<UnityTransport>();
unityTransport.SetRelayServerData(new RelayServerData(allocation, "wss"));
unityTransport.UseWebSockets = true;

Using the Multiplayer Services SDK (com.unity.services.multiplayer)

var unityTransport = _networkManager.TransportManager.GetTransport<UnityTransport>();
unityTransport.SetRelayServerData(AllocationUtils.ToRelayServerData(allocation, "wss"));
unityTransport.UseWebSockets = true;

Other Unity Services support

In addition, FishyUnityTransport supports other Unity Services. You can explore them yourself and use them in your project:

• Unity Lobby
• Game Server Hosting (Multiplay)