Try SpatialOS

Sites

Menu
These are the docs for 12.2, an old version of SpatialOS. 13.0 is the newest →

Setup guide for Windows (64-bit)

This guide will prepare your Windows machine for local development with the SpatialOS SDK.

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

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 or ask on our forums and we’ll take you through some custom setup steps.

2. Set up the SpatialOS CLI

To set up the SpatialOS 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.

    Having trouble with Chocolatey? Try setting the SpatialOS SDK up manually instead.

  3. 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...

3. (optional) Set up Unity or Unreal

You only need to complete this step if you’re planning to use the Unity SDK or the Unreal SDK with SpatialOS.

4. (optional) Install the Launcher

If you want to run a game client to connect to a SpatialOS game running in the cloud, you must install the Launcher.

  1. Download the Launcher.
  2. Follow the instructions in the installation wizard.

5. Next steps

You’ve now set up your machine for development with SpatialOS!

Recommended: To learn how to use SpatialOS and experiment with its main APIs, try our tutorials:

If you’d just like to find out about what SpatialOS is:

To get started building something of your own, go to github.com/spatialos and use one of the repositories there as a starting point.

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums