Sites

Menu
These are the docs for 13.7, an old version of SpatialOS. The docs for this version are frozen: we do not correct, update or republish them. 14.0 is the newest →

Platform SDK

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 locally, you need to run the local API service.

Supported languages

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

Services

There are currently four services available:

  • Deployment service
  • Snapshot service
  • Service account service
  • Player authentication 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
    An example of an automated script that would run on a regular cadence and reset the live deployment of your game.

  • Replicate local state to cloud
    An example of a debugging tool that captures a snapshot in a local deployment and uploads it to the cloud in order to reproduce game behavior.

  • Service account maintenance
    An example of an automated script that extends the duration of service accounts which are close to expiry.

  • Player authentication
    An example of connecting a user to a SpatialOS cloud deployment.

  • Capacity limit
    An example of limiting the number of workers that can connect to a given deployment.

We’ll add more example scenarios in future.

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums