Package Structure¶
A holodeck package is a .zip
file containing a build of holodeck-engine
that contains worlds and Scenarios for those worlds.
A package file is platform specific, since it contains a compiled binary of Holodeck.
Package Contents¶
The .zip
file must contain the following elements
A build of holodeck-engine
A
config.json
file that defines the worlds present in the packageScenario configs for those worlds
Package Structure¶
The package.zip contains a config.json
file at the root of the archive, as
well as all of the scenarios for every world included in the package. The
scenario files must follow the format {WorldName}-{ScenarioName}.json
.
+package.zip
+-- config.json
+-- WorldName-ScenarioName.json
+-- LinuxNoEditor
+ UE4 build output
config.json¶
This configuration file contains the package-level configuration. Below is the format the config file is expected to follow:
config.json
:
{
"name": "{package_name}",
"platform": "{Linux | Windows}",
"version": "{package_version}",
"path" : "{path to binary within the archive}",
"worlds": [
{
"name": "{world_name}",
"pre_start_steps": 2,
}
]
}
The "pre_start_steps"
attribute for a world defines how many ticks should
occur before starting the simulation, to work around world idiosyncrasies.