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

Manual setup guide for Windows

Note: For a simpler setup experience, try the SpatialOS setup guide that uses chocolatey.

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

1. System requirements

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

2. Set up the SpatialOS CLI

To set up the SpatialOS CLI (spatial):

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

    By downloading spatial, you agree to the SpatialOS EULA.

  2. Put spatial.exe in a directory where you have administrator privileges.

  3. Add the directory containing spatial.exe to your PATH by following these instructions.

    Check it worked by opening a terminal (PowerShell or cmd) and running spatial update.

    The printed URL link should open in your browser for authentication with your SpatialOS account. If the link does not open automatically in your browser click it or copy-paste it to visit the page.

    Expected output:

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

    Attempting to download the latest version...

    Did not update 'spatial'. Latest version is already installed.

3. Set up external development tools

You need some external software in order to develop a SpatialOS application. All of it is listed below, and all of it is free!

3.1. Unity

Unity versions 5.5.3 and 5.6.0 have been tested with SpatialOS. Later versions will probably work fine, but have not been extensively tested.

You MUST include Linux Build Support and Mac Build Support when you install Unity.

Install Unity version 5.6.0:

  1. Go to the Unity Download Archive.
  2. Next to version 5.6.0, from the “Downloads (Win)” dropdown, click “Unity Installer” (which downloads the installer).
  3. Run the installer.

    IMPORTANT: In addition to the defaults, select Linux Build Support and Mac Build Support:

    Unity screenshot

  4. Install Unity into the default installation directory: %PROGRAMFILES%\Unity.

    Alternatively, you can set the environment variable UNITY_HOME to your customized Unity installation folder. For example, if you installed Unity to C:\Unity 5.6.0, then set UNITY_HOME to C:\Unity 5.6.0.

  5. Launch Unity and complete the registration process.

3.2. Java Development Kit (JDK)

  1. Download and install the 64-bit JDK 8 for Windows. You’ll need to install the 1.8.0_65 version or newer.

    Check it worked by running in a terminal: java -version

    Expected output: java version "1.8.0_x"

  2. Add javac to your PATH by following these instructions. This binary is located in the bin directory inside the JDK installation directory.

    Check it worked by running in a terminal: javac -version

    Expected output: javac 1.8.0_x

  3. Set the JAVA_HOME system environment variable by following these instructions.

3.3 Visual C++ Redistributable for Visual Studio 2015

If you haven’t got it installed already, download and install Visual C++ Redistributable for Visual Studio 2015.

4. (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.

5. 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.)

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums