How to Add Dedicated Game Server to Godot Engine - Edgegap Plugin
This tutorial covers how to deploy and host a dedicated game server for any Godot multiplayer game, and make it playable online worldwide, directly from the Godot editor using the Edgegap plugin.
Alongside it, we recommend following our documentation.
Let's get to it.
Part 1 - Setup
There are a few requirements before we start.
First, download and install Docker, which is used to containerize the game server. Docker is used by millions of developers and by the world's largest companies.
Second, use a version of Godot compatible with the plugin, preferably Godot 4 and up.
Third, use a project or netcode already set up for dedicated servers. For this tutorial we're using "Forest Brawl", a multiplayer sample from the "netfox" netcode, which is already set up for dedicated servers. Any Godot project set up for a dedicated server will work with the plugin.
Part 2 - Edgegap: Game Server Hosting & Orchestration
With your project open in Godot, the first step is to add the Edgegap plugin.
We recommend installing it from the Godot Asset Store:
Select "AssetLib" at the top.
Search for "Edgegap Servers Quickstart".
Select "Download", then "Install".
You can also install it manually: download the plugin from GitHub and move its folder into the addons subfolder of your project.
Then enable it. Under "Project", "Project Settings", "Plugins", find Edgegap and activate it. A new "Edgegap" tab appears next to the Inspector. If it doesn't, select "Project", then under "Tools" select "Edgegap Game Server Hosting".
Connect your account. In the plugin, select "Get token". A browser opens to Edgegap's platform. Sign in using your SSO provider of choice, and create an organization if prompted. The Edgegap dashboard then appears, which we invite you to explore, and it automatically provides your unique token. Copy it, return to the Godot editor, and paste it; the plugin validates it automatically. If it doesn't, select "Validate Token".
Install the export templates. Before building, the plugin needs Godot's Linux export templates. Select "Validate Export Templates"; if they're missing, select "Open Export Presets" and choose "Download & Install". You only need the Linux server template, as Edgegap's servers run on 64-bit Linux; on platforms that don't offer a per-item choice, installing the full template pack is fine.
Build your game server. In the "Build Your Game Server" section, select "Export server". After a few seconds, the export succeeds.
Containerize your server. In the "Containerize Your Server" section, confirm Docker is running by selecting "Validate Docker". We'll skip all optional parameters for this tutorial, but details for power users are available in our documentation. Select "Containerize with Docker"; after a short moment, containerization is successful. You can test the server locally here, but for this tutorial we'll go straight to testing online.
Upload to Edgegap. Select "Upload image and create App version". This pushes your server image to Edgegap and creates its application version. You can edit the resource usage on the version page, but we'll keep the defaults and select "Submit". On the "Create Port" step, keep the port set to 7777 and the protocol to UDP for this netcode. This may be different with other netcodes; make sure to review your netcode's documentation for the accurate port for your use case.
Deploy to the cloud. In the final section, confirm the correct application and version are selected, and choose "Deploy to Cloud". After a few seconds of loading, your game server is ready.
Congratulations, your game server is now live on Edgegap for the world to play!
Part 3 - Testing
Naturally, test things first.
Open your deployment's detail page. It includes plenty of information, but what you need is the server's "Host" address and its external "Port". Copy them.
Back in Godot, launch the game, and from the main menu select "Play on LAN". Replace the address with your deployment's Host, and the port with the external port from the detail page. Select "Connect". You are now connected to your dedicated game server running in the cloud.
Multiplayer usually has more than one player, which you'll need to simulate. Godot has this built in. Head to "Debug", then "Customize Run Instances", enable multiple instances, set the count to two, and confirm. When you launch, two game windows open. Have the first window connect as before, then the second.
Congratulations, you now have two players playing your game online, their movements replicated in each other's game.
Once you're done, remember to stop your deployment from the plugin or the dashboard.
Part 4 - Next Steps
That is all for Edgegap's plugin for Godot, which empowers game developers with automated game servers and simple hosting.
The likely next step in your game development will be to automatically start and stop servers, and to connect players. For more information on Edgegap's free, simple, and fully automated matchmaker, check out our tutorial.
If you have any questions, join our Discord.
