SDKs and Data

Worker SDK

The Worker SDK is a low-level integration, available in several programming languages.
Use the Worker SDK to create the server-workers and client-workers which make your game run as a SpatialOS deployment.

You can either:

  • extend the functionality of the GDKs for Unreal or Unity.
  • create low-level workers for game logic that does not require a game engine; these could work without any game engine or with a game engine, complementing the functionality of workers in that game engine.

The Worker SDK is available in C++, C# and Java, all of which have a very similar structure, and in C, which is lower-level and doesn’t include code generation.

Note: We recommend evaluating SpatialOS with the GDK for Unreal's Example Project tutorial before using the Worker SDK.

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.

The Platform SDK is currently only available in C#.

Data: Schema

The schema is where you define all the components in your world. It is defined in .schema files, written in schemalang. SpatialOS uses schema to generate code in various languages, which you can then use to interact with entities in the world.

For more information, see the schema documentation.

Data: Snapshots

A snapshot is a representation of the state of a world at some point in time. It stores each persistent entity and the values of the entity's
components' properties. You use a snapshot as the starting point (an initial snapshot) for your world when you deploy, locally or in the cloud.

For more information, see the snapshots documentation.

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.