3. Add schema

By default, the GDK finds and compiles schema found within .schema/ folders of packages referenced in your project's manifest.json.

To compile schema from directories outside of referenced packages, you must add your schema source directories to the GDK tools configuration.

1. Create a folder for schema

First, create the folder in which you will be writing schema files. We recommend adding a schema/ folder at the root of your SpatialOS project.

<project_root>
  ├── schema/
  ├── snapshots/
  ├── workers/

2. Open Spatial OS Project Settings in Unity Editor

In the Unity Editor, select Edit > Project Settings... to open the Unity Project Settings window. Select Spatial OS from the sidebar to view the Spatial OS project settings.

3. Add a schema source directory

If you are setting up the blank project for the first time, you will find that there are no directories listed under the Schema sources section.

To add an entry, select the ➕ icon and enter the path to the schema directory you created earlier. Note that the path must be relative to your Unity project directory.

Note: The GDK tools configuration window will display an error if the source directory does not exist.

Updated about a year ago


3. Add schema


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.