Skip to content
This repository has been archived by the owner. It is now read-only.
[Deprecated] SpatialOS SDK for Unity Starter Project
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.

SpatialOS SDK for Unity Starter Project

New from October 2018: The SpatialOS GDK for Unity
Check out the alpha release of our SpatialOS Game Development Kit (GDK) for Unity. Using the Unity Entity Component System (ECS), the GDK is the next evolution in developing SpatialOS games in Unity. The SpatialOS GDK for Unity is designed to replace the SpatialOS SDK for Unity and we recommend using it over using the SDK for new game projects. See our blog post anouncement for more information.


This is a SpatialOS starter project to use with the SDK for Unity with useful core features that you can extend to build your own SpatialOS application.

It contains:

  • A Player spawned on client connection as per the Unity Client Lifecycle Guide.
  • A Cube spawned through a snapshot via an entity template method and an Unity prefab.
  • The rest of the features included in the BlankProject.

If you run into problems, or want to give us feedback, please visit the SpatialOS forums.

Running the project

To run the project locally, first build it by running spatial worker build, then start the server with spatial local start. You can connect a client by opening the Unity project and pressing the play button, or by running spatial local worker launch UnityClient default. See the documentation for more details.

To deploy the project to the cloud, first build it by running spatial worker build -t=deployment, then upload the assembly with spatial cloud upload <assembly name>, and finally deploy it with spatial cloud launch <assembly name> <launch configuration file> <deployment name> --snapshot=<snapshot file>. You can obtain and share links to connect to the deployment from the console. See the documentation for more details.

Copyright (C) 2017 Improbable Worlds Limited. All rights reserved.

You can’t perform that action at this time.