Get SpatialOS

Sites

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

Alternative setup steps for Windows

If you don’t want to use the installer to set up your Windows machine for development with SpatialOS using the worker SDK, you can either:

This guide will prepare your Windows machine for local development with the SpatialOS worker SDK which is available in C++, C#, Java, and as an even lower-level C API.

  • To use Unity to make SpatialOS games, see the GDK for Unity documentation.
  • To use Unreal to make SpatialOS games, see the GDK for Unreal documentation.

You need to have access to SpatialOS to download the worker SDK.

Set up your machine using Chocolatey

1. System requirements

We support up-to-date versions of Windows 7 and 10.

Before following the setup guide check that your machine meets the hardware requirements.

If you’re using a corporate network with a strict firewall, raise a support request (for customers with a service agreement) or ask on our forums and we’ll take you through some custom setup steps.

2. Set up the spatial CLI

To set up the spatial CLI (spatial):

  1. Install chocolatey, the package manager, following the instructions at chocolatey.org/install.

  2. Open a terminal (PowerShell or cmd) and run:

    choco install spatial --yes
    

    This will install the CLI and put it in your PATH. By installing it, you agree to the SpatialOS EULA.

    1. Close and re-open your console, then check the install succeeded by running spatial update in your terminal. You should get the output:

    Current version of the 'spatial' command-line tool: <version number>

    Attempting to download the latest version...

    Set up your machine manually

    1. System requirements

    We support up-to-date versions of Windows 7 and 10.

    Before following the setup guide check that your machine meets the hardware requirements.

    If you’re using a corporate network with a strict firewall, raise a support request (for customers with a service agreement) or ask on our forums and we’ll take you through some custom setup steps.

    2. Set up the spatial CLI

    To set up the spatial CLI (spatial):

    1. Download spatial for Windows (64bit): Download.

    By downloading spatial, you agree to the SpatialOS EULA. 0. Put spatial.exe in a directory where you have administrator privileges. 0. Add the directory containing spatial.exe to your PATH by following these instructions.

    1. Check this succeeded by running spatial update in your terminal. You should get the output:

    Current version of the 'spatial' command-line tool: <version number>

    Attempting to download the latest version...

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums