Get started: Introduction

To get started with the SpatialOS GDK for Unreal, you download and install the GDK’s Unreal Engine fork and plugin, and then set up a project. You can set up either or both of the following sample projects:

  • The Example Project is a session-based FPS game for multiple players. The Example Project is the basis for most GDK tutorials which give you an overview of the GDK. The Example Project tutorial explains how to use SpatialOS to deploy the game locally on your development machine and in the cloud.
    You get this project from its own Example Project repository when you run the install script for the GDK’s Unreal Engine fork, as part of the Get Started guide.

  • The Starter Template is a template project you can use as a base to create your own new project running on SpatialOS.
    You get this project as part of the GDK’s Unreal Engine fork download, as part of the Get Started guide.

Before you do any of this, you need to get the dependencies and set up the fork and plugin.

Development platforms: Windows or macOS

The GDK for Unreal only supports macOS for the development and testing of game clients on iOS. If you are using macOS, you can only set up and run SpatialOS on your development machine, not in the cloud, which you need to do to fully test a game and run it in production.

To set up and run SpatialOS games in the cloud, you need to use a Windows machine for development. We recommend using a Windows machine as your main development environment and macOS for developing and testing game clients on iOS.

Start with: Get started: 1. Get the dependencies.

More about the GDK

Tutorials and guides

After you set up the GDK and the Example Project, you can check out the following tutorials and guides:

  • Multiserver offloading: Learn how to offload groups of Actors so Unreal server functionality is split between multiple servers, using the Example Project.
  • The porting guide: Port your existing Unreal project to SpatialOS.

Your feedback and ideas

We'd love to hear from you - drop into our forums or Discord to give us feedback on your getting started experience, our documentation, our development roadmap on GitHub, or anything else!

Find us on the SpatialOS Discord in the #unreal channel.
You can get Discord here.

The SpatialOS forums
Visit the feedback section in our forums and use the unreal-gdk tag. Here is a link to give us feedback directly on the forum, which takes you there and pre-fills the category and tag.

GitHub issues
Create an issue in the UnrealGDK repository within

2020-06-23 Page updated with editorial review: added MacOS, mobile, UI and deployment workflow changes.

Updated 15 days ago


Suggested Edits are limited on API Reference Pages

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