Requirements

For the GDK system requirements, see the GDK for Unreal and GDK for Unity documentation.

SpatialOS

Outside of China

Sign up to SpatialOS and make sure you're logged in to improbable.io. If you are logged in, you should see your picture in the top right of this page. If you are not logged in, select Login at the top of this page and follow the instructions.

In China

In-China instructions

Only follow the in-China instructions if you are located in China and deploying your game to server nodes hosted in China. You can only deploy to server nodes hosted in China if you're located in China. Note that in the documentation, "China" refers to mainland China only.

For more information, contact your account manager or get in touch.

Sign up to SpatialOS China (contact your account manager or get in touch) and make sure you're logged in to spatialoschina.com. If you are logged in, you should see your picture in the top right of this page. If you are not logged in, select Login at the top of this page and follow the instructions.

Software

Windows requirements

Up-to-date versions of Windows 7 and 10 are supported.

Required for
All SpatialOS development the SpatialOS CLI
PowerShell 3.0 and later / Windows Command Prompt / Git BASH (For local deployments, you must use PowerShell or Command Prompt.)
Visual C++ Redistributable for Visual Studio 2015
Worker SDK: C# Mono --- required for the generated build scripts only.
Worker SDK: C++ A C++11-compliant compiler: Visual Studio 2015 or later
Worker SDK: Java Gradle version 2.10
Worker SDK: C Microsoft Visual Studio 2015 Update 3 and above.

You can find installation instructions for the basic requirements in the tools installation guide for Windows.

macOS requirements

We support up-to-date versions of macOS Sierra, El Capitan, High Sierra, Mojave, and Catalina.

Required for
All SpatialOS development the SpatialOS CLI
Any Bash terminal
Worker SDK: C# Mono
Worker SDK: C++ A C++11-compliant compiler: Tested with Xcode 8.
You'll need to use the -std=c++11 flag when compiling your worker
Worker SDK: Java version 2.10
Worker SDK: C OS X Yosemite (10.10) and above

You can find installation instructions for the basic requirements in the tools installation guide for macOS.

Linux requirements

All major distributions (e.g,. Ubuntu, Fedora, CentOS) on machines with an AMD64 processor are supported for use with the Worker SDK in C++, C# and Java. The Launcher is not supported, and the SpatialOS CLI is in beta.

Required for
All SpatialOS development the SpatialOS CLI
Any Bash terminal
Worker SDK: C# Mono
Worker SDK: C++ A C++11-compliant compiler: Tested with GCC 5.4.0.
You'll need to use the -std=c++11 flag when compiling your worker
Worker SDK: Java Gradle version 2.10 or later
Worker SDK: C gcc 5.4.0 with GLIBCXX_3.4.21 and above.

You can find installation instructions for the basic requirements in the tools installation guide for Linux.

Browsers

To access the Console and Inspector, you'll need one of the following:

spatial worker build and spatial worker codegen include an authentication step that opens a browser tab.
This authentication won't work if your default browser is Microsoft Edge or Internet Explorer.
It's most reliable when your default browser is Chrome or Firefox.

Hardware

Hardware requirements apply to all currently supported operating systems.

Recommended
Processor i7
Memory 16GB RAM
Network High-speed broadband internet connection
Storage 12GB available space

Network settings

  • Your firewall settings must allow outbound TCP connections on ports 443 and 444 in order to authenticate on the
    SpatialOS platform, download SDKs and contact other cloud services.

  • You must not filter inbound and outbound connections to localhost (IP: 127.0.0.1) or submit such connections to
    proxy rules.

    You must also not block the opening of ports bound to localhost. This is required to run local
    deployments via the spatial local command.

  • If the client is using the Modular KCP network type you must allow UDP outbound connections on 8018. Otherwise, you must allow TCP and UDP outbound connections on the 8000-8999 port range for connecting clients to a
    cloud deployment. This is also a requirement for any third-party users who want to connect to your deployments (when you share a game).

  • You must keep the following ports free:
    • 7777 for the Receptionist (one way of connecting to a SpatialOS deployment).
    • 12000 for authenticating using spatial auth login.
    • 21000 and 22000 for local deployments launched using the SpatialOS CLI.
      (21000 is where you can find the local Inspector for deployments launched using the CLI.)
    • 31000 and 9876 for the local API service.
      (31000 is where you can find the local Inspector for deployments launched using the local API service. The local API service defaults to running on 9876, but you can change this.

VPN

Some VPN providers might not work properly with the SpatialOS CLI. If you experience issues, try an alternative provider. If issues continue, raise a support request (for customers with a service agreement) or ask on our forums.

Supported deployment environments

When you build workers to be deployed, the only supported deployment platform for server-workers is Linux.

Windows, macOS and Linux are also supported for running client-workers and unmanaged workers.

2019-08-22 Page updated with editorial review: added more ports that you need to keep free

Updated about a year ago


Requirements


Suggested Edits are limited on API Reference Pages

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