The Platform SDK lets you build tools, workflows and services that integrate with the SpatialOS platform.

You can use its APIs to integrate SpatialOS into your continuous integration process, create debugging tools as game engine plugins, or build matchmaking and inventory systems that utilize player identity. You can also manage deployments, snapshots and other parts of a project locally or in the cloud.

To use the Platform SDK for local deployments, you need to run the local API service.

Supported languages

We currently provide the Platform SDK only in C#. For more information, see the setup guide.


Currently, the following services are available:

  • Deployment service
  • Player authentication service
  • Remote interaction service
  • Service account service
  • Snapshot service

Example scenarios

We've created some example scenarios that demonstrate the benefits of incorporating the Platform SDK into your project. You can find the full code examples on GitHub.

  • Game maintenance: Write an automated script that runs on a regular cadence and resets the live deployment.

  • Replicate local state to cloud: Take a snapshot of the local deployment and upload it to the cloud to reproduce game behaviour for debugging.

  • Service account maintenance: Write an automated script that extends the duration of service accounts close to expiry.

  • Player authentication: Generate authentication tokens and connect a user to a SpatialOS cloud deployment.

  • Capacity limit: Limit the number of worker instances per worker type that can connect to a given deployment.

  • Remote interactions: Interact with the world state of a running deployment, including creating and deleting entities, invoking entity commands and running one-off queries.

Updated about a year ago


Suggested Edits are limited on API Reference Pages

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