Get started

We recommend you start by following the FPS Starter Project tutorial to become familiar with the SpatialOS workflow.

Note: Whichever route you choose to get started, you need basic proficiency in programming in Unity, version control systems (such as Git), and command-line interfaces (CLI) to use the SpatialOS GDK for Unity.

The FPS Starter Project

  • Sign in to SpatialOS and install dependencies and the GDK.
  • Launch the FPS Starter Project game to the cloud.
  • Find out about the SpatialOS workflows and tooling.
  • Run your game on test servers on your development machine (a local deployment).
  • Run the FPS Starter Project game at scale, with up to 200 simulated player-clients running in the cloud.

Get started with the FPS Starter Project tutorial.

Other guides

Use these guides once you have followed the FPS Starter Project tutorial.

Setup and install

A quick reference for:

  • Sign up or log in to SpatialOS
  • Check your hardware and network
  • Install the GDK dependencies

See the Setup and install guide.

Blank Project

  • An empty Unity project set up to work with the GDK for Unity.
  • Find out about fundamental SpatialOS concepts, and how they relate to the GDK.
  • Explore the structure and contents of the project.
  • Explore the Player Lifecycle Module.
  • Run the game on test servers on your development machine (a local deployment).

See the Blank Project overview.

Your Unity project with SpatialOS

  • Set up the SpatialOS project structure in your existing Unity project.
  • Add the GDK packages to your Unity project.

See Your Unity project with SpatialOS.

Updated about a year ago


Get started


Suggested Edits are limited on API Reference Pages

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