Example Project quick-start

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 tutorials: Example Project quick-start

This tutorial takes you through setting up the Example Project; you will start a single-server local SpatialOS deployment to test the project on your development machine, and, if you are developing on a Windows machine, you will start a single-server SpatialOS deployment in the cloud to test and share the project. (Note that you cannot start a SpatialOS deployment in the cloud if you are developing on a macOS machine.)

The project contains gameplay and assets that are representative of a basic first-person shooter running on SpatialOS.

If you want to make your own project from scratch, use the Starter Template quick-start tutorial, however, if you are new to SpatialOS and the GDK for Unreal, we recommend following this Example Project quick-start tutorial.

Before starting this tutorial you must follow the Get started guides:

Image: Gameplay screenshot of the Example Project


2020-08-11 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-21 Page added with editorial review.

Updated about a year ago



Example Project quick-start


Suggested Edits are limited on API Reference Pages

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