This page starts one server on the Free plan. You need a Linux build of your game’s server, zipped. If you use Unreal Engine, see Unreal Engine first.

With the dashboard

1

Make an account and a project

Sign up at app.simpl.gg. Click New project, type a name, and click Create. Simpl shows your two keys once. Copy both somewhere safe, then click I’ve saved my keys.
2

Upload your build

Open the Builds tab and click Upload build. Choose your ZIP file. Pick your engine, set Executable to the file that starts your server, and give the build a name, such as 0.1.0. Click Upload build.Wait until the build’s status is ready. See Upload a ZIP for what goes in the ZIP.
3

Start a server

Next to your ready build, click Start server. Choose region iad and size 1x-1g, which are the ones the Free plan allows, then click Start.
4

Connect to it

Open the Servers tab. Your server shows the address to connect to, in the form host:port. Connect your game to that address.
On the Free plan a server stops by itself after 30 minutes. You can stop it sooner with Stop.

With the API

The same thing with one request, using your server key (sk_live_...) in the api-key header. Run this on your own computer, never in your game.
  • version_tag is the name you gave your build.
  • region and tier (the size) must be iad and 1x-1g on the Free plan. Anything else fails with PLAN_LIMIT_EXCEEDED.
The answer (status 201) describes your new server. Its instance_id is the server’s ID. Its network_ports list says where to connect: each entry has a name, a host and an external_port. Players connect to host:external_port of the port named game.

Inside your server

When your server starts, a file is waiting for it at /simpl/its_simpl.json with details about the match. See its_simpl.json.

Next steps