Get SpatialOS

Sites

Menu
These are the docs for 13.0, an old version of SpatialOS. The docs for this version are frozen: we do not correct, update or republish them. 13.6 is the newest →

Format of spatialos_worker_packages.json

Example

An example of the C# worker package file:

{
          "targets": [
            {
              "path": "improbable/dependencies/managed",
              "type": "worker_sdk",
              "packages": [
                {
                  "name": "csharp"
                }
              ]
            },
            {
              "path": "improbable/dependencies/native",
              "type": "worker_sdk",
              "packages": [
                {
                  "name": "core-dynamic-x86_64-win32"
                },
                {
                  "name": "core-dynamic-x86_64-macos"
                },
                {
                  "name": "core-dynamic-x86_64-linux"
                }
              ]
            }
          ]
        }
        

Root object

  • Field targets: contains a list of Package target structures.

Package target structure

  • Field path: A string pointing to a directory that packages will be unpacked to. Relative paths are interpreted relative to the directory the spatialos_worker_packages.json is in.
  • Field type: A string that indicates the type of the package.
  • Field packages: A list of worker Package structures.

Worker package structure

  • Field name: A string representing the name of the package.
  • Field version: (Optional) A string representing the version of the package to acquire. If empty, uses the version of the SDK in the project’s spatialos.json.
  • Field platform: (Optional) A string representing the name of the platform to acquire. This is compared to the current platform. If empty, the package is always acquired.
    • Available values: windows, linux, macos.

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums