SpatialOS Online Services provide examples of complementary infrastructure around your game's SpatialOS game server software and hosting; services such as authentication and matchmaking. Online Services work with SpatialOS game projects created using Unreal Engine with the GDK for Unreal, or Unity with the GDK for Unity, or your own engine.

The Online Services repository provides a suite of example gRPC (with additional HTTP support) services, packages and images. It gives you everything you need to start building online services to support your SpatialOS game. The Services are as unopinionated and generic as possible because you know best what your game requires. The primary language is C#, but we provide our protocol buffer files too so you can re-implement the services in whichever language you choose, meaning that you can customize them for your game if you need to. The services support gRPC and HTTP.

SpatialOS Online Services are provided as example implementations to help you to get started. They are not hosted or maintained by Improbable.


Matchmaking Service - the Gateway

For matchmaking, you can use the Gateway Service.

To find out about the Gateway, see:

You can also check out the Improbable blogpost on Matchmaking with SpatialOS; it describes how you can use the Gateway as a matchmaking service.

Authentication Service - PlayFab Auth

For authentication, you can use the PlayFab Auth Service.

To find out about PlayFab Auth, see:

Deployment Pool

Maintains game deployments in a ready-to-go state. It is useful if you want players to be able to jump into a game or between levels with minimal wait times.

To find out about the Deployment Pool, see:

Analytics Pipeline

A REST endpoint to capture analytics events stemming from either Online Services or a game, see:

The Online Services repository

The Online Services, packages and configuration examples are all on GitHub.

Repository on GitHub: github.com/spatialos/online-services

We recommend you create a fork of the repository so that you can make whatever customizations you want; use this as a base, rather than a comprehensive one-size-fits-all solution.

Where to start

  • Find out what's included in the Online Services repository:

  • Find out more about the Gateway.

Read the Gateway guide. This describes how the Gateway system works, and includes best practices for using it with your game.

2019-07-16 Page added with editorial review

Updated 4 months ago


Suggested Edits are limited on API Reference Pages

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