Converting project configuration files

This page explains how to convert the various configuration files of the structured project layout (SPL) to equivalent configuration files in the flexible project layout (FPL).

This guide only addresses parts of the process of migrating an existing SpatialOS project from the SPL to the FPL. Please refer to our Migration guide for a summary of all migration steps.

Converting the worker configuration file

Reference documentation for the SPL format
Reference documentation for the FPL format (client-workers)
Reference documentation for the FPL format (server-workers)

In the FPL, we use different types of worker configuration files to describe client-workers and server-workers. This is different from the SPL where you described all workers using a shared worker configuration format. Before you convert a worker configuration file from SPL to FPL, you need to decide whether your worker is a client-worker or a server-worker.

Below is a summary of how to populate the fields of an FPL worker configuration file based on the state of your existing SPL project:

FPL format	SPL format
`workerType`	Part of the name of your worker configuration file, i.e. `spatialos.<my-worker-type>.worker.json`
`layer`	`bridge.worker_attribute_set.attributes` field in your worker configuration file
`entityInterest`	`bridge.entity_interest` field in your worker configuration file
`streamingQuery`	`bridge.streaming_query` field in your worker configuration file
`componentDelivery`	`bridge.component_delivery` field in your worker configuration file
`componentSettings`	`bridge.component_settings` field in your worker configuration file
`permissions`	Similar to the `workers.<my-worker-type>.permissions` field in your launch configuration file, with the difference that the FPL `permissions` field here is a single permission object rather than an array
`flags`	`workers.<my-worker-type>.flags` field in your launch configuration file
`loginRateLimit` (client-worker only)	`workers.<my-worker-type>.login_rate_limit` field in your launch configuration file
`connectionCapacityLimit` (client-worker only)	`workers.<my-worker-type>.connection_capacity_limit` field in your launch configuration file
`uploadConfiguration` (client-worker only)	No equivalent - refer to the documentation for information on how to populate this field
`launchConfiguration.<platform>.localBuildDirectory` (server-worker only)	No equivalent - refer to the documentation for information on how to populate this field
`launchConfiguration.<localDeployment, cloudDeployment>.<platform>.<command, arguments>` (server-worker only)	`managed.<platform>.<command, arguments>` field in your worker configuration file

The build field in the SPL worker configuration file is obsolete and does not have an equivalent in the FPL. In the FPL, you fully manage the build process of a worker. For more information, see Building a worker executable in the FPL.
The external field in the SPL worker configuration file is obsolete and does not have an equivalent in the FPL. In the FPL, you need to start a worker manually instead of using spatial local worker launch.

Converting the launch configuration file

Reference documentation for the SPL format
Reference documentation for the FPL format

If you want to use the Platform SDK, you should not convert your launch configuration file into FPL format. The Platform SDK currently only supports SPL format launch configurations. We will provide an improved workflow in the future.

Below is a summary of how to populate the fields of an FPL launch configuration file based on the state of your existing SPL project:

FPL format	SPL format
`template`	`template` field in your launch configuration file
`dimensionsInWorldUnits.<x, z>`	`world.dimensions.<xMeters, zMeters>` field in your launch configuration file
`loadBalancing`	`load_balancing` field in your launch configuration file
`snapshot.takeSnapshotIntervalSeconds`	Similar to the `world.snapshots.snapshot_write_period_seconds` field in your launch configuration file, with the difference that `snapshot.takeSnapshotIntervalSeconds` defaults to 0, not 600, if not set
`snapshot.startDeploymentFromSnapshotFile`	No equivalent - refer to the documentation for information on how to populate this field
`streamingQueryInterval`	`world.streaming_query_interval` field in your launch configuration file
`runtimeFlags`	`world.legacy_flag` field in your launch configuration file

The world.legacy_javaparams field in the SPL launch configuration file is obsolete and does not have an equivalent in the FPL.
The world.chunk_edge_length_meters field in SPL launch configuration file is obsolete and does not have an equivalent in the FPL. In the FPL, this parameter has a fixed value of 100. You might need to adapt the entity interest configuration of your workers to account for the change in this value when you migrate a project from the SPL to the FPL.

Converting the project definition file

Reference documentation for the SPL format
Reference documentation for the FPL format

The project definition file is called “project configuration file” in the FPL.

Below is a summary of how to populate the fields of an FPL project configuration file based on the state of your existing SPL project:

FPL format	SPL format
`configurationVersion`	No equivalent - refer to the documentation for information on how to populate this field
`projectName`	`name` field in your project definition file
`schemaDescriptor`	No equivalent - refer to the documentation for information on how to populate this field
`launchConfiguration`	No equivalent - refer to the documentation for information on how to populate this field
`clientWorkers`	No equivalent - refer to the documentation for information on how to populate this field
`serverWorkers`	No equivalent - refer to the documentation for information on how to populate this field

The project_version field in the SPL project definition file is obsolete and does not have an equivalent in the FPL. Please keep track of your project/built versions separately.
The sdk_version field in the SPL project definition file is obsolete and does not have an equivalent in the FPL. There is no clearly defined SDK version for an FPL project anymore. For more information, please see Choose an SDK version.
The dependencies field in the SPL project definition file is obsolete and does not have an equivalent in the FPL. You need to manage your dependencies manually as part of your build process. For more information, please see Download the relevant worker SDK libraries.

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums