Get SpatialOS

Sites

Menu

Setup guide for macOS

This guide will prepare your Mac for local development with the SpatialOS SDK.

Note: You need to have access to SpatialOS to download the SDK.

1. System requirements

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

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. Install the Homebrew package manager.

    /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
    
  2. In a terminal, run:

    brew tap caskroom/cask
    brew tap improbable-io/spatialos
    brew update
    brew cask install spatial
    

    Note: If you have trouble with Homebrew, try setting the SpatialOS SDK up manually instead.

    By installing spatial, you agree to the SpatialOS EULA.

  3. 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 external development tools

You need some external software in order to develop a SpatialOS application.

3.1. Java Runtime Environment (JRE)

Download and install the 64-bit JRE 8 for macOS. You’ll need to install the 1.8.0_65 version or newer.

We don’t support Java 9 yet.

3.2. (optional) Unity

To use the Unity SDK, even if you’ve already got Unity installed, you must follow these steps, because SpatialOS only supports specific versions of Unity, and requires specific build support.

Unity versions 5.5.3 and 5.6.0 have been tested with SpatialOS. Later versions may work fine, but have not been extensively tested.

We haven’t tested SpatialOS with High Sierra yet. If you want to use High Sierra anyway, you’ll need to follow the manual setup guide for macOS choosing Unity version 5.6.3 from the Unity Download Archive (because of a known issue with Unity 5.6.0 and High Sierra).

  1. Choose one of the options below:

    • If you already have Unity 5.6.0 installed:

      In a terminal, run the following:

      brew cask install unity-ios-support-for-editor@5.6.0
      brew cask install unity-linux-support-for-editor@5.6.0
      brew cask install unity-windows-support-for-editor@5.6.0
      
    • If you have another version of Unity, or don’t have it installed at all:

      In a terminal, run the following:

      brew cask install unity@5.6.0
      brew cask install unity-ios-support-for-editor@5.6.0
      brew cask install unity-linux-support-for-editor@5.6.0
      brew cask install unity-standard-assets@5.6.0
      brew cask install unity-windows-support-for-editor@5.6.0
      

      This installs Unity in the default installation directory, /Applications/Unity.

      If you want to use more than one version of Unity, you must:

      1. Rename this directory (for example, mv /Applications/Unity /Applications/Unity5.6.0). This path cannot have spaces in it.
      2. Set the UNITY_HOME environment variable to point at your chosen Unity installation.
  2. Launch Unity and complete the registration process.

4. (optional) Install the Launcher

If you want to run a game client to connect to a SpatialOS game running in the cloud, you must install the Launcher.

  1. Download the Launcher.
  2. Follow the instructions in the installation wizard.

5. Next steps

You’ve now set up your machine for development with SpatialOS!

Recommended: To learn how to use SpatialOS and experiment with its main APIs, try the Pirates tutorial (Unity).

If you’d just like to find out about what SpatialOS is:

To get started building something of your own, go to github.com/spatialos and use one of the repositories there as a starting point.

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums