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

Setting up a project


1. Configure project name

Make sure your project name is set correctly in your project’s spatialos.json:

  1. In the project’s root directory, open spatialos.json. This file holds your project’s global configuration.
  2. In the name field, make sure the value is your assigned SpatialOS project name.

    You can find your project name in the Console. It’ll be something like beta_someword_anotherword_000.

In our example projects, the project name is set to your_project_name_here.

You must change this. If you don’t:

  • spatial upload will fail with the error code = PermissionDenied desc = No permission to create assembly...
  • deployments will fail with the error Encountered an error during command execution. no permissions to access Project...

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:

  1. Make sure the Unity Editor is closed. If it’s not, it’ll cause build errors.
  2. Open a terminal and navigate (cd) to the root directory of the project.
  3. Build the project by running the command 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).

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums