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 →

SpatialOS Linux support is experimental, and is intended for use with the language worker SDKs (C++, C#, Java, JavaScript). The Launcher is not supported on Linux.

Setup guide for Linux

This guide will prepare your 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

To set up the SpatialOS CLI (spatial):

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

    By downloading spatial, you agree to the SpatialOS EULA.

  2. Put spatial in a directory.

    For example, bin in your home directory: mkdir -p $HOME/bin && mv $HOME/Downloads/spatial $HOME/bin.

  3. Add the directory to your PATH.

  4. Make sure spatial is executable: run chmod +x <path_to_spatial_here>.

Check it worked by running: spatial update

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 (Unsupported)

Unity is not supported for use with SpatialOS on Linux. It’s possible you can work with it, but we don’t test it at all. Note that Unity only ‘experimentally’ supports Linux too, so you’re in a real den of dragons if you decide to play around with this!

Install Unity version 5.6.0:

  1. Go to the experimental Unity build for 5.6.0.
  2. Download the installer of your choice.
  3. Run the installer.
  4. Install Unity into the default installation directory.

    Alternatively, you can set the environment variable UNITY_HOME to your customized Unity installation folder. For example, if you installed Unity to %HOME/Unity5.6.0, then set UNITY_HOME to %HOME/Unity5.6.0. This path cannot have spaces in it.

  5. Launch Unity and complete the registration process.

3.2. Java Development Kit (JDK)

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

  2. Install the downloaded JDK.

  3. Add the <jdk_installation_directory>/bin folder to your PATH.

    Check it worked by running: javac -version

    Expected output: javac 1.8.0_x

  4. Set the JAVA_HOME system environment variable by running:

    Check it worked by running: echo $JAVA_HOME

    Expected output: <jdk_installation_directory>/bin

4. Next steps

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

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums