Get SpatialOS

Sites

Menu

Format of spatialos_worker_packages.json

Example

An example of the Unreal package file:

{
  "targets": [
    {
      "path": "Game/Source/SpatialOS",
      "type": "unreal",
      "packages": [
        {
          "name": "improbable_sdk_plugin"
        }
      ]
    },
    {
      "path": "Game/Binaries/ThirdParty/Improbable/Linux",
      "type": "worker_sdk",
      "packages": [
        {
          "name": "core-dynamic-x86_64-linux"
        }
      ]
    },
    {
      "path": "Game/Binaries/ThirdParty/Improbable/Win32",
      "type": "worker_sdk",
      "packages": [
        {
          "name": "core-dynamic-x86-win32"
        }
      ]
    },
    {
      "path": "Game/Binaries/ThirdParty/Improbable/Win64",
      "type": "worker_sdk",
      "packages": [
        {
          "name": "core-dynamic-x86_64-win32"
        }
      ]
    },
    {
      "path": "Game/Binaries/ThirdParty/Improbable/CodeGeneration",
      "type": "code_generation",
      "packages": [
        {
          "name": "Improbable.CodeGeneration"
        }
      ]
    }
  ]
}

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. Allowed values are:
    • unity: Packages intended for use with Unity.
  • 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, darwin.

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums