The Worker SDK in C# will no longer be public from SpatialOS v15.0.0, but remains available to commercial SpatialOS partners.
If you want to benefit from SpatialOS in C#, we recommend you use the Worker SDK C# bindings for a performant and flexible integration. To see the kinds of things you can do with C# bindings, take a look at the SpatialOS GDK for Unity.
We continue to support the Worker SDK in C# in 14.x as outlined in our release policy. From 14.6.0 onwards, we will only add new features to the Worker SDK in C# at our discretion.
The SDK provides functionality to write a worker that:
- connects to a SpatialOS simulated world
(see Connect to SpatialOS)
- can subscribe to information for a part of the world
(see Handle data received from SpatialOS)
- can send and receive component updates
(see Send data to SpatialOS)
The C# API closely mirrors the C++ API.
The most important units of functionality in the C# API are:
which is responsible for querying for and connecting to remote cloud
which represents a worker's connection to a SpatialOS simulated world.
which is responsible for invoking user-provided callbacks based on
data received from SpatialOS via the
which is a container for the component data associated with a single entity.
For more, see either the C# API reference documentation, or
the pages under "Using" in this section.
You can use the C# blank project
as a starting point for a project using the Worker SDK in C#, or to add a C# worker to an existing SpatialOS project.
The APIs are lower-level than the a game engine integration like the
If you're using a game engine we don't have an integration with, you can use this SDK to integrate that
game engine with SpatialOS. See Integrating an engine for details.
Updated about a month ago