Get SpatialOS

Sites

Menu

SpatialOS setup guide for Windows (64-bit)

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

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

1. System requirements

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

2. Set up the SpatialOS CLI and external development tools

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 --version 1.1.6 --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. 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...

  4. In the same window, run:

    spatial setup install-dependencies --sdk-version=11.0.2
    

    This will install all the necessary dependencies to develop and build your projects. By running this command you agree with the individual terms of each separate dependency.

  5. Restart your computer to complete the install process.

  6. Configure the newly installed dependencies:

    • If you didn’t have Unity installed before, run it and register or activate your license.

3. (optional) Install the launcher

The Launcher is a tool that lets you run a game client to connect to a SpatialOS game running in the cloud.

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

4. Next steps

You’ve now set up your development environment with SpatialOS!

To find out more about what SpatialOS is, try our product tour.

To get started coding on the platform, start with the Pirates tutorial.

(We really recommend starting from a tutorial, but if you want to start from scratch, use the Blank Project as your project outline.)

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums