Launch configuration file

A launch configuration file contains the information that spatial local launch and spatial cloud launch use to run a deployment.

Reference format

A launch configuration is a *.json file with the following sections:

• template - specified the template this launch configuration is based on. The value can be any of the available templates.
• world - configuration for the simulated world.
  • chunk_edge_length_meters - the size of the grid squares that the world is divided into, in “world units” (an arbitrary unit that workers can interpret as they choose. Unity workers interpret one world unit as one meter in the Unity coordinate space)
  • streaming_query_interval - the time between streaming query updates (in seconds).
  • snapshots
    • snapshot_write_period_seconds - the frequency in seconds to write snapshots of your simulated world. Defaults to 600 seconds (i.e., 10 minutes). Set to 0 to disable automatic snapshots.
  • legacy_flags - legacy non-worker flag configurations.
  • legacy_javaparams - legacy JVM configurations.
  • dimensions - configure the size of your SpatialOS simulation in meters. Note: all values must be divisible by the value specified in chunk_edge_length_meters.
• workers - worker-specific configuration parameters regarding flags, load balancing, and permissions. The worker_type is defined in filename of the worker’s spatialos.<worker_type>.worker.json file.

{
    "template": "small",
    "world": {
        "chunk_edge_length_meters": 50,
        "streaming_query_interval": 4,
        "snapshots": {
            "snapshot_write_period_seconds": 600
        },
        "legacy_flags": [
          {
            "name": "load_snapshot_at_startup",
            "value": "false"
          }
        ],
        "legacy_javaparams": [
            {
                "name": "-DCLOUD_LAUNCH_CONFIG",
                "value": "your.project.GameSettings"
            }
        ],
        "dimensions": {
            "x_meters": 1000,
            "z_meters": 1000
        }
    },
    "workers": [
        {
            "worker_type": "my_worker",
            "flags": [
                {
                    "name": "a_custom_flag",
                    "value": "true"
                },
                {
                    "name": "another_flag",
                    "value": "500"
                }
            ],
            "load_balancing": {
                "auto_hex_grid": {
                    "num_workers": 16
                }
            },
            "permissions": [{
                "entity_creation": {
                    "allow": true
                },
                "entity_deletion": {
                    "allow": true
                },
                "entity_query": {
                    "allow": true,
                    "components": [
                        "your.project.SomeComponent",
                        "your.project.OtherComponent"
                    ]
                }
            }],
        }
    ]
}

For information about creating custom flags for workers to use, see Worker flags.

Example

A minimal launch config:

 {
    "template": "small",
    "world": {
        "chunk_edge_length_meters": 50,
        "streaming_query_interval": 4,
        "dimensions": {
            "x_meters": 1000,
            "z_meters": 1000
        }
    }
 }

Further examples are available in the Wizards, Pirates, and Blank Project repositories.

Templates

A template defines the compute resources your deployment needs (i.e., its ‘topology’). There are three templates:

By default, you only have access to the small template.

If you want to use one of the bigger templates, or if you need something custom, get in touch with Improbable.

Legacy flags

You can add the following flags to the legacy_flags section: