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).
Converting the worker configuration file
- SPL format reference documentation
- FPL format (client-workers) reference documentation
- FPL format (server-workers) reference documentation
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 |
Converting the launch configuration file
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 |
Converting the project definition file
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 |