Windows

Tools installation guide for Windows (64-bit)

You can install the SpatialOS Tools with the SpatialOS installer or, alternatively, with a package manager.

In China

Only follow the instructions for China if you are located in China and deploying your game to server nodes hosted in China. If you’re planning to deploy to server nodes hosted in China, you need to follow the alternative installation steps. You can only deploy to server nodes hosted in China if you're located in China. For more information, contact your account manager or get in touch.

Installing the SpatialOS tools is a prerequisite for using the Worker SDK and the GDKs for Unreal and Unity. The installer gives you the CLI and the Launcher (you get access to the Console when you sign up to SpatialOS).

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. Install the SpatialOS tools

Download the installer and follow the steps.

This installs:

  • the SpatialOS CLI
  • the SpatialOS Launcher
  • the x86 Visual C++ Redistributable
  • the x64 Visual C++ Redistributable

If you don't want to set up SpatialOS using the installer, see the alternative installation steps for Windows below.

Next steps

Follow the language-specific Worker SDK setup guide in C, C# bindings, or C++.

Alternative installation 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:

Installing the SpatialOS tools is a prerequisite for using the Worker SDK and the GDKs for Unreal and Unity.

Set up your machine using Chocolatey

1. System requirements

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

Before following the installation 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. Download the Visual C++ Redistributables

Download the x64 and x86 Visual C++ Redistributables: see The latest supported Visual C++ downloads.

3. Set up the SpatialOS CLI

To set up the SpatialOS CLI:

  1. Install chocolatey, the package manager, following the instructions at
    chocolatey.org/install.
  2. Run the installation command.

Outside China
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.

Close and re-open your console, then check the install succeeded. To do this, run:

spatial update

You should get the output:

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

Attempting to download the latest version...

In China

Open a terminal (PowerShell or cmd) and run:

choco install spatial --yes --params "'/region:china'"

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

Close and re-open your console, then check the install succeeded. To do this, run:

spatial update --environment=cn-production

You should get the output:

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

Attempting to download the latest version…

4. Install the Launcher

To install the Launcher:

  1. Download the Launcher installer:

  2. Follow the instructions in the installation wizard.

Set up your machine manually

1. System requirements

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

Before following the installation 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. Download the Visual C++ Redistributables

Download the x64 and x86 Visual C++ Redistributables: see The latest supported Visual C++ downloads.

3. Set up the SpatialOS CLI

To set up the SpatialOS CLI:

  1. Download the SpatialOS CLI for Windows (64bit): outside China/in China.
    By downloading the CLI, you agree to the SpatialOS EULA: outside China/in China.
  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.
  4. Check this succeeded.

Outside China
Open a terminal window and run:

spatial update

You should get the output:

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

Attempting to download the latest version...

In China

Open a terminal window and run:

spatial update --environment=cn-production

You should get the output:

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

Attempting to download the latest version…

4. Install the Launcher

To install the Launcher:

  1. Download the Launcher installer:

  2. Follow the instructions in the installation wizard.

Next steps

Follow the language-specific Worker SDK setup guide in C, C# bindings, or C++.


2020-07-29 Page updated with editorial review: added Launcher installation details for China.

Updated about a year ago


Windows


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.