Files and directories guide

This page describes the directory structure of a SpatialOS project using the structured project layout (SPL).

There are examples of all configuration files in the Blank Project repository.

There is also a flexible project layout (FPL); for more information, see its introduction.

spatialos.json

Specifies the basic details of a project, including its name, and the SpatialOS version the project uses.

For more information about this file see project definition specification page.

Example spatialos.json (from Blank Project)

.json

A launch config file. You can have multiple launch config files in a project, and specify which
one you want to use when you deploy using spatial local launch or spatial cloud launch.

spatial local launch defaults to using the file with the name default_launch.json. For spatial cloud launch, you need to specify a file to use.

A project needs at least one launch config file.

For more information about these config files, including the file format, see the
Launch config file page.

Example default_launch.json (from Blank Project)

.gitignore

If you are using Git, you will have a .gitignore file in the root of your project. For more information about this file, see the GitHub help on ignoring files.

schema/

This directory contains your schema, written in schemalang.

For details on writing a schema, see the schema documentation.

workers/

This directory contains the code for the workers used by your simulated world. Its contents will depend on the types of workers you decide to use in your project.

Worker directories

The code for any worker types you build should be placed in a directory with the same name as the worker type, for example workers/pathfinding_worker/.

This directory must contain a spatialos.<worker_type>.worker.json file, which tells SpatialOS how to build, launch, and interact with the worker. The label you use as the worker_type will be used to identify this worker elsewhere in your project (for example, in the launch configuration file).

For details on the file format, see the Configuring a worker section.

build/

Contains files generated by spatial worker build.

Updated 2 months ago


Files and directories guide


Suggested Edits are limited on API Reference Pages

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