4. Play the game

This tutorial is for developers located outside China, using hosting outside China

If you are located in China and using hosting inside China, see the [CN] Example Project quick-start tutorial.

Example Project quick-start: 4 - Play the game

To get playing, you use the SpatialOS Launcher to share the game clients with users via a dedicated URL.

The Launcher is a distribution tool which downloads and starts game clients for a cloud deployment. You installed the Launcher when you installed SpatialOS on your machine. You access the Launcher from the Console; use it to create a URL to give end-users access to a game client for your game.

Find out more in the glossary.


Play the game from the Unreal Editor.
Alternatively, you can use Unreal’s Play In Editor (PIE) to connect clients to your game.
For more information, see the connection workflows documentation.
(See also the Unreal documentation for more information on PIE.)

Step 1: Set up a game client using the Launcher

  1. Open the SpatialOS Console at console.improbable.io to see a list of your SpatialOS cloud projects.

The Console is a web-based tool which you can use to find out about the internal state of your game's SpatialOS world. You can manage, report on, and explore the game world.
You also access the Launcher from the Console. Find out more about the Console in the glossary.

  1. Select your SpatialOS cloud project name to see a list of deployments associated with that cloud project. (In this example, the cloud project name is unreal_gdk.)
    The list looks something like this:

Image: The Console's cloud project deployment list

  1. Select your deployment name to see the deployment's overview screen. (In this example, the deployment name is mydeployment.)
    The overview screen looks something like this.

Image: The Console's deployment overview screen

  1. Use the Launcher to get a game client.
    To do this:
    a. In the deployment overview screen, select the blue Launch button.
    This displays the Launch a Client dialog box.
    b. Select Launch.

Image: The Launch a Client dialog box

  1. Once the game client has launched, you see the game's lobby. Create and enter a name for your player character and select Start to start playing.

Image: The Example Project lobby screen

Step 2: Share your game

To share your cloud deployment:

  1. In the Console, go to the deployment overview screen.
  2. Select the white Share button to open the Share Application dialog box. Accept the terms.

Image: The terms in the Share Application dialog box

  1. You can now see a URL; this contains a token to download a game client. You can share this with game testers so they can try out your game.

Image: The Share Token URL in the Share Application dialog box


You've successfully set up and played the Example Project. You are now ready to start developing your own games with SpatialOS.

Next steps

  • Continue with the Example Project:
    • Find out more about the key SpatialOS concepts you need for your game development in the In-game tutorial. The In-game tutorial consists of several maps in the Example Project, one for each main concept it covers. It has an accompanying written tutorial and a short video for each map.
    • Follow the Offloading tutorial: in this you set up the Example Project to run on multiple server-worker instances.
  • If you have an existing Unreal multiplayer project, you can follow the detailed porting guide to get it onto the GDK.
  • If you want to start a project from scratch, follow the setup tutorial for the Starter Template to set up a blank project using the GDK.
  • To set up your project for mobile game-client development, see the documentation on mobile set up for Android or iOS.

2020-08-10 Page updated with editorial review: added new tutorial links.
2020-06-23 Page updated with editorial review: updated tutorial names.
2020-06-23 Page updated with editorial review: added MacOS, mobile, UI and deployment workflow changes.
2019-05-23 Page added with editorial review.

Updated about a year ago

4. Play the game

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.