System requirements
Software
Windows requirements
Up-to-date versions of Windows 7 and 10 are supported.
To use the Unreal SDK, you’ll need a development machine that meets the required criteria for Unreal Engine 4. We also recommend having around 100GB of space - the Unreal source alone takes up at least 50GB.
Required for | |
---|---|
All SpatialOS development | spatial CLI (Install via chocolatey, or download directly) JDK 8 for Windows 64-bit, versions 1.8.0_65 and later PowerShell 3.0 and above / Windows Command Prompt / Git BASH Visual C++ Redistributable for Visual Studio 2015 |
Unity SDK | Unity 5.6.0, including Linux Build Support and Mac Build Support |
Unreal SDK | Visual Studio 2015 Windows SDK 8.1 (this is a requirement for Unreal itself) |
C# SDK | Mono — required for the generated build scripts only. |
C++ SDK | A C++11-compliant compiler: Visual Studio 2015 or later |
Java SDK | Gradle version 2.10 |
JavaScript SDK | npm 3.10.10 or later |
You can find installation instructions for the basic requirements in the setup guide for Windows.
macOS requirements
Up-to-date versions of macOS Sierra and El Capitan are supported.
Required for | |
---|---|
All SpatialOS development | spatial CLI (Install via homebrew, or download directly) JDK 8 for OS X 64-bit, versions 1.8.0_65 and later Any Bash terminal |
Unity SDK | Unity 5.6.0, including Linux Build Support and Windows Build Support |
Unreal SDK | Not supported |
C# SDK | Mono |
C++ SDK | A C++11-compliant compiler: Tested with Xcode 8. You’ll need to use the -std=c++11 flag when compiling your worker |
Java SDK | Gradle version 2.10 |
JavaScript SDK | npm 3.10.10 or later |
You can find installation instructions for the basic requirements in the setup guide for macOS.
Linux requirements
All major distributions (e.g,. Ubuntu, Fedora, CentOS) on machines with an AMD64 processor are experimentally supported for use with the language worker SDKs (C++, C#, Java, JavaScript). The Launcher is not supported.
Required for | |
---|---|
All SpatialOS development | spatial CLI (download directly) JDK 8 for Linux 64-bit, versions 1.8.0_65 and later Any Bash terminal |
Unity SDK | Not supported, but you can try experimental Unity 5.6.0 Mono latest |
Unreal SDK | Not supported |
C# SDK | Mono |
C++ SDK | 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 |
Java SDK | Gradle version 2.10 or later |
JavaScript SDK | npm 3.10.10 or later |
You can find installation instructions for the basic requirements in the setup guide for Linux.
Browsers
To access the Console and Inspector, you’ll need one of the following:
spatial worker build
andspatial 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 thespatial local
command.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 port
22000
free for local deployments.
Supported deployment environments
When you build workers to be deployed, the only supported deployment platform for managed workers is Linux.
Windows, macOS and Linux (experimental) are also supported for running external workers (like clients).