Overview

Use this guide when you want to host a multiplayer server on your PC.  This is the fastest and easiest method for getting a server running.

Page Navigation

<aside> 📔 TABLE OF CONTENTS

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

</aside>

Is this the Right Choice?

Pros:

• The easiest method by far, everything is done in the GUI and does not require any additional configuration.
• The server is only open as long as Citron is running, once it closes - the server stops.

Cons:

• Not as fine grained control over the settings of the server.
• Log files are not separate from Citron's normal logging, making debugging a challenge if needed.
• The server is only open as long as Citron is running, once it closes - the server stops.
  • This can be undesired behavior in some situations, such as in the event of a crash.

Steps

<aside> ✅

TIP: The instructions are the same for anything that uses the Citron Desktop Interface (Windows/Linux), Android being the only notable exclusion.

</aside>

1. Open Citron and go to Multiplayer > Create Room.

   

2. The configuration windows will now appear, prompting you for the server information.

   • Server Address: This will be your Private IP address - this tells Citron what interface to listen on.
     • If you are using ZeroTier, you would use that IP Address, see the page for more information.
   • Room Name: The name you want the room at appear as.
   • Username: What do you want your user to be called?
   • Preferred Game: A dropdown selection of the games you have in Citron, select the one you want to host a game for.
     • You don't have to play the game you select here, but it's best practice to do so for people in the Public Game Lobby.
   • Password: An optional password if you want to secure access to your server.
   • Max Players: The maximum number of players you want to be in your server at a time.
   • Port: What port do you want to have the server listen on, default is 24872.
   • Room Description: An optional description of the server.
   • Load Previous Ban List: (Checked/Not) - Determines if you want to load a list of banned users from a previous session.
   • Public/Unlisted: Dropdown indicating whether you want your server to be viewable/connectable in the Public Game Lobby or not.

3. Select Host Room to start the server and connect to it.

   • You may get a Windows Firewall pop up, this is normal for the first time launching the program. Accept it to allow the program through the firewall for both Public/Private networks. If you don't want to do this, you will need to open the firewall ports manually, which is out of the scope of this guide.

4. A server window should now appear with your username and stating Connected*.***

   

5. Your server is now able to be connected to by other people.

Common Issues

See the Troubleshooting page for Common Issues and solutions if the above does not work for you.

Resources

Citron Website

Download Citron

Citron Source Code

Citron Discord