Linux

Tools installation guide for Linux

Installing the SpatialOS CLI is a prerequisite for using the Worker SDK. (The Launcher isn't supported on Linux, and you get access to the Console when you sign up to SpatialOS.)

In China

Only follow the instructions for China 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. For more information, contact your account manager or get in touch.

Note that for Linux, the CLI is in beta.

1. System requirements

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. Set up the SpatialOS CLI

To set up the SpatialOS CLI:

  1. Download the CLI for Linux (64bit): outside China/in China
    By downloading the CLI, you agree to the SpatialOS EULA: outside China/in China.

  2. Put the CLI 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 the CLI is executable: run chmod +x <path_to_spatial_here>.
  5. Check this succeeded.

Outside China

In a terminal window, 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

In a terminal window, 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...

Next steps

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

Updated about a year ago


Linux


Suggested Edits are limited on API Reference Pages

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