Specifies the version of the configuration file itself. This documentation is for configuration version 0.1 and this field should always be set to this value if you intend to use features described here.

projectName

Required

The name of the project assigned to you by Improbable. It’s used in the Console and for deployments. It should be between 3 and 32 characters long and contain letters, numbers and underscores. See Project name for more information.

schemaDescriptor

Required

A relative (to the location of this file) or absolute path to the schema descriptor file to start deplopyments with. The schema descriptor is a binary file that allows the SpatialOS Runtime to interpret your project’s schema and is necessary for starting a SpatialOS deployment both locally and in the cloud. You can create a schema descriptor using the schema compiler tool. You can find an example on how to generate this file here.

launchConfiguration

Optional

A relative (to the location of this file) or absolute path to the default launch configuration to start deployments with. You can overwrite the launch configuration to use with the --launch_config flag when starting a deployment with the spatial CLI.

clientWorkers

Optional

A list of relative (to the location of this file) or absolute paths to the client-worker configuration files of this project. See the client-worker configuration page for more details.

serverWorkers

Optional

A list of relative (to the location of this file) or absolute paths to the server-worker configuration files of this project. See the server-worker configuration page for more details.