README.md

The SpatialOS GDK for Unity Blank Starter Project

This is a blank project that you can use to build your own game with the SpatialOS GDK for Unity.

Prerequisites

Before using this project, make sure to follow the machine setup guide.

Setup

To use the blank project, you need to clone the GDK for Unity repository alongside the Blank Project so that they sit side-by-side:

  <common_parent_directory>
      ├── gdk-for-unity-blank-project
      ├── gdk-for-unity

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

Automatic set up

From the root of the gdk-for-unity-blank-project repository:

• If you are using Windows run: powershell scripts/powershell/setup.ps1
• If you are using Mac run: bash scripts/shell/setup.sh

Manual set up

1. Clone the GDK for Unity repository alongside the Blank Project so that they sit side-by-side:

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

2. Navigate to the gdk-for-unity directory and checkout the pinned version which you can find in the gdk.pinned file, in the root of the gdk-for-unity-blank-project directory.

   • git checkout <pinned_version>

© 2019 Improbable