Overview

Use this guide when you want to set up a multiplayer server, but do not have the ability (or don't want) to set up a port forwarding on your router. Without going into it too much, ZeroTier is a software-based mesh network management system. When clients connect to a ZeroTier network they can communicate with each other as if they were on the same network.

Page Navigation

<aside> 📔 TABLE OF CONTENTS

• General
• Multiplayer
• Windows
• Steam Deck
• Android
• Help Center

</aside>

Is this the Right Choice?

Pros:

• Allows you to connect and spin up a room without needing to port forward your router.
• Aside from the initial connection, it establishes a direct connection between the clients without needing a server.
• You need a solution that allows connections from Android clients.

Cons:

• While you can publicly announce the room, it will not successfully connect as the announce will not reference the ZeroTier IP.
• You need to install an additional program on your machine.
• You need to sign up for an account*.
  • *Only the host needs an account

Configuring a ZeroTier Network

1. Start by going to the ZeroTier website and signing up for a free account.

2. Upon Successful account creation, you will be guided to setup your first network. Name it whatever you want and hit Save & Continue → to proceed to the next screen.

   

3. Here you will be prompted to download a client to connect your first device to your network. Select the appropriate option for your platform and download it.

   

4. You will now be shown your unique Network ID, using this ID allows users to join your network.

   

   <aside> 🚨

   INFO: While there is a secondary step to authorize a client, it is still general best practice to keep this ID safe and not disclose it online or to those you do not trust.

   </aside>

5. Run the installer you downloaded and it should install ZeroTier onto your system.

6. Open ZeroTier's panel to access it's configuration, here Windows is shown. You can look at ZeroTier's documentation for help with other platforms.

   

7. Select Join New Network... to connect to the network you created earlier.  You will need to enter the Network ID that you copied earlier.

   

8. Your first client is now pending acceptance onto your network.  Go back to the Web Browser you created the network in and see that it is now prompting you to authorize the device.  Click Authorize this device to grant it access.

   

9. It will now prompt you to add a second client to your network. Download the installer and put it on your second client, repeating steps 6 & 7 for the second device. You will be prompted to authorize the second device as well. If you need to add additional clients, the instructions are in the next section.

   <aside> ✅

   TIP: If you do not have your second client available (e.g. whoever you want to play with), you can set up the second client on your phone to get past this screen.

   </aside>

10. All clients are now successfully connected to the network and can talk to each other.

    

11. You are now ready to create a multiplayer room.

Adding Additional Clients to Your Network

After creating the initial network and joining 2 clients to it, you will not be guided through on adding any more. Follow these steps to add more clients to your network. If you do not need to configure additional clients, this section can be skipped.

<aside> <img src="/icons/info-alternate_blue.svg" alt="/icons/info-alternate_blue.svg" width="40px" />

INFO: On the free tier, you are limited to 3 networks and 10 clients (Nodes).  These are 10 total, not 10 per network.

</aside>

1. Log into your ZeroTier account through your web browser of choice, if you are not already logged in.

2. You should see your network(s) displayed. Click on it to open the network details.

3. You need to add the user to your network and can either:

   • Enter the email address of the person you want to join the network and an email with instructions will be sent to them.
   • Enter the Member ID of the user to automatically add them when they connect. This would require that they already have ZeroTier installed and is found under My Address: XXXXXXXXXX.

4. Have the user connect to your network through one of the above methods. You will see the user's connection attempt appear in the web browser with a 🚫 icon indicating it is unauthorized.

   

5. Click the Edit button to open the client's information.

   

6. You can enter a custom Name and Description, which will help you identify it in the ZeroTier page, but this is optional. Click the checkbox next to Authorized and then hit Save to save the authorization.

7. The client is now authorized to connect to the network.

Resources

Citron Website

Download Citron

Citron Source Code

Citron Discord