Get SpatialOS

Sites

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

SpatialOS Linux support is experimental, and is intended for use with the C++, C# and Java SDKs. 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>.

  5. Check this succeeded by running spatial update in your terminal. You should get the output:

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

    Attempting to download the latest version...

3. Set up Unity (optional, 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 2017.3.0:

  1. Go to the experimental Unity build for 2017.3.0.
  2. Download the installer of your choice.
  3. Run the installer.

  4. Install Unity into the directory /opt/Unity.

    spatial worker build expects to find Unity in this directory.

  5. Set the environment variable UNITY_HOME to /opt/Unity.

  6. Launch Unity and complete the registration process.

Some users have found, to get Unity to work, they need to install Postgres (sudo apt-get install libpq5).

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