Get SpatialOS

Sites

Menu

Get started: 1 - Set up

There are four parts to this step:

  • Sign up for a SpatialOS account (or make sure you are logged in)
  • Set up your machine
  • Get the GDK and the FPS Starter Project source code
  • Open the FPS Starter Project in your Unity Editor

(This page is the longest of the get started guide - the others are much quicker.)

Sign up for a SpatialOS account, or make sure you are logged in

If you have already signed up, make sure you are logged into Improbable.io. If you are logged in, you should see your picture in the top right of this page; if you are not logged in, select Sign in at the top of this page and follow the instructions.

If you have not signed up before, you can do this here.

Set up your machine

Make sure you have chosen the right build support

  • You need Linux build support. This is because server-workers in a cloud deployment run in a Linux environment.
  • You need Mac build support if you are developing on a Windows PC and want to share your game with Mac users.
  • You need Windows build support if you are developing on a Mac and want to share your game with Windows PC users.
  • Unity gives you build support for your development machine (Windows or Mac) by default.

Android and iOS support

Mobile support is in pre-alpha. If you are developing a game for Android or iOS, refer to our GDK for Unity mobile support documentation

Need some help?

If you need help using the GDK, come and talk to us about the software and the documentation via:

  • The SpatialOS forums - Visit the support section in our forums and use the unity-gdk tag.
  • Discord - Find us in the #unity channel. You may need to grab Discord here.
  • Github issues - Create an issue in this repository.

Get the GDK and the FPS Starter Project source code

To run the GDK and the FPS Starter project, you need to download the source code. There are two ways you can do this: either get both sets of source code as one zip file download or clone the two repositories separately using Git. (To find out more about Git, see github.io).

NOTE: We recommend using Git, as Git’s version control makes it easier for you to get updates in the future.

Zip file download

While we recommend using Git, if you prefer to, you can get the source code for both the GDK and FPS Starter Project by downloading one zip file here. Please download the latest release, the file should be called something like gdk-for-unity-fps-starter-project-x.y.z.zip.

NOTE: If you have downloaded the source code via a zip file, skip the rest of this page and move on to the next section of this page: Open the FPS Starter Project in your Unity Editor.

Clone the two repositories using Git

If you haven’t downloaded the zip file, you need to clone two repositories; the FPS Starter Project and the GDK for Unity.

1. Clone the FPS Starter Project repository

Clone the FPS Starter Project using one of the following commands:

HTTPS git clone https://github.com/spatialos/gdk-for-unity-fps-starter-project.git
SSH git clone git@github.com:spatialos/gdk-for-unity-fps-starter-project.git

NOTE: You can only clone via SSH if you have already set up SSH keys (GitHub help) with your GitHub account.

2. Clone the GDK for Unity repository and checkout the latest release

You can use scripts to automatically do this or follow manual instructions.

  • To use the scripts:
    From the root of the gdk-for-unity-fps-starter-project repository:
    • If you are using Windows run: powershell scripts/powershell/setup.ps1
    • If you are using Mac run: bash scripts/shell/setup.sh
  • To follow manual instructions, see below:

Open the FPS Starter Project in your Unity Editor

Launch your Unity Editor. It should automatically detect the project but if it doesn’t, select Open and then select gdk-for-unity-fps-starter-project/workers/unity.

TIP: The first time you open the Starter Project in your Unity Editor, It takes about 10 minutes; it’s much quicker to open after this. (While you are waiting, you could look at our Games Blog.)


Next: Build your workers

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums