Get SpatialOS



Build your workers

Before running a deployment of your game locally or in the cloud, you need to:

  1. Build the bridge configuration and launch configuration of your workers.
  2. Prepare the build configuration of your workers.
  3. Build your workers.

Building the bridge and launch configurations of your workers

A SpatialOS deployment requires bridge and launch configurations (commonly referred to as “worker configs”) to be built for all of its server-workers and client-workers.

Worker configs are built using information contained within worker configuration files. You can find examples of worker configurations for client-workers and server-workers in the Unity project in this repository.

To build the worker configs, you can either:

  • With your project open in the Unity Editor, select SpatialOS > Build worker configs.


  • In a terminal window, from the root of your project, run: spatial build build-config via the spatial CLI.

It’s finished building when: there is a message stating 'spatial build build-config' succeeded.

If you encounter build errors, you might not have selected the build supports your game needs during your Unity setup.

* You need Linux build support. This is because server-workers in a cloud deployment run in a Linux environment. In the Assets/Fps/Config/BuildConfiguration, do not change the UnityGameLogic Cloud Environment from Linux.

* You need Mac build support if you are developing on a Windows PC and want to share your game with Mac users.
* You need Windows build support if you are developing on a Mac and want to share your game with Windows PC users.
Unity gives you build support for your development machine (Windows or Mac) by default.

Preparing the build configuration of your workers

To prepare the build of your server-workers and client-workers you can create a new scriptable object (Unity documentation) containing the information needed to build your workers correctly.

To do this:

  1. With your project open in the Unity Editor, go to the Project window and select Assets > Create > SpatialOS > Build Configuration. This creates a Unity Asset called SpatialOS Build Configuration.
  2. Select this Asset to view it in the Unity Editor Inspector. Here you can configure each server-worker and client-worker for both local and cloud deployments. You can configure:
    • Which scenes each worker should contain in its build.
    • Which platforms you want to build it for.
    • Which build options you want enabled. You can select the following build options:
      • Development Build
      • Headless Mode: This is only available for Linux builds. If you want to reproduce the same behaviour for Windows or OSX, start your built-out workers with the following parameters: -batchmode -nographics. This can be configured in the launch configuration.

Building your workers

To build your workers:

  • With your project open in the Unity Editor, select SpatialOS > Build for local > <WorkerType> or SpatialOS > Build for cloud > <WorkerType>, where <WorkerType> is the type of worker you want to build.

This starts the build process for the worker and deployment type (cloud or local) you selected.

It’s finished building when: there is a message stating Completed build for Local/Cloud target.

You can now find the built-out workers in build/assembly/worker in the root of the SpatialOS GDK for Unity project.

TIP: Speed up development iteration with worker quick-run

When you are developing with the GDK, you don’t need to build out workers all the time, you can use quick-run to run multiple workers in your Unity Editor using Ctrl+L (Windows) or Cmd+L (Mac).

During development you use a local deployment rather than a cloud deployment. In a local deployment, you can either build your workers to run locally or use quick-run. With quick-run you can run multiple workers in your Unity Editor, so you don’t have to keep building out workers during development iteration.

To use quick-run:

  1. With your project open in the Unity Editor, on your computer’s keyboard, select Ctrl+L (Windows) or Cmd+L (Mac).
  2. Wait until you see a message in the Editor’s Console window that SpatialOS is ready. The message is: SpatialOS ready. Access the inspector at http://localhost:21000/inspector.
  3. In your Unity Editor, play your game’s Scene.

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums