Get SpatialOS

Sites

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

Alternative setup steps for macOS

If you don’t want to use the installer to set up your Mac for development with the SpatialOS worker SDK, you can either:

This guide will prepare your Mac for local development wwith the SpatialOS worker SDK which is available in C++, C#, Java, and as an even lower-level C API.

  • To use Unity to make SpatialOS games, see the GDK for Unity documentation.
  • To use Unreal to make SpatialOS games, see the GDK for Unreal documentation.

You need to have access to SpatialOS to download the worker SDK.

Set up your machine using Homebrew

1. System requirements

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

Before following the setup 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, and other prerequisites for the next step:

  1. Install the Homebrew package manager.

    /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
    
    1. In a terminal, run:
    brew tap caskroom/cask
    brew tap improbable-io/spatialos
    brew update
    brew cask install spatial
    

    By installing the CLI, you agree to the SpatialOS EULA.

  2. 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...

Set up your machine manually

1. System requirements

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

Before following the setup 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 SpatialOS CLI for macOS (64bit): Download.

    By downloading the CLI, you agree to the SpatialOS EULA.

  2. Put the SpatialOS 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. To do so:

    1. Open a terminal window.
    2. Move into home directory: run cd.
    3. Determine which configuration file to use (you will need to know your configuration file again in later steps): run ls -a ~

      • If you have a .bash_profile, that’s your configuration file.
      • Otherwise, if you have a .bash_login, that’s your configuration file.
      • Otherwise, if you have a .profile, that’s your configuration file.
      • If you don’t have any of these files, you can use .bash_profile (which you’ll create in the next step).
    4. Add the location of spatial to the PATH variable: run echo 'export PATH=$PATH:/path_to_spatial_here' >> ~/your_config_file_here

      For example: echo 'export PATH=$PATH:$HOME/bin' >> ~/.bash_profile

  4. Make sure the SpatialOS CLI is executable: run chmod +x /path_to_spatial_here.

  5. Restart your terminal window to register the changes made to the path.

  6. 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...

Next steps

Follow the worker setup guide in C++, C#, Java, or C.

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums