Setting up a project
- You’ve gone through the SDK setup guide for Windows or Mac and have everything installed.
- You have a project. You can use one of the examples at the SpatialOS GitHub repository.
1. Configure project name
- In the project’s root directory, open
spatialos.json. This file holds your project’s global configuration.
namefield, make sure the value is your assigned SpatialOS project name.
You can find your project name in the Console. It’ll be something like
2. Initialize the project
Before you can do any development on your project, you need to initialize it:
To set up a project on your local machine:
- Make sure the Unity Editor is closed. If it’s not, it’ll cause build errors.
- Open a terminal and navigate (
cd) to the root directory of the project.
- Build the project by running the
spatial worker build.
Even if you’re going to use Unity or an IDE and not the command line to build, you must build your project first, since this will properly initialize it (e.g. obtain relevant dependencies).