Module containing high level interface for loading environments.


GL_VERSION OpenGL Version enum.


make([scenario_name, scenario_cfg, …]) Creates a Holodeck environment
class holodeck.holodeck.GL_VERSION

OpenGL Version enum.


The value for OpenGL3.


The value for OpenGL4.

holodeck.holodeck.make(scenario_name='', scenario_cfg=None, gl_version=4, window_res=None, verbose=False, show_viewport=True, ticks_per_sec=30, copy_state=True)

Creates a Holodeck environment

  • world_name (str) – The name of the world to load as an environment. Must match the name of a world in an installed package.
  • scenario_cfg (dict) – Dictionary containing scenario configuration, instead of loading a scenario from the installed packages. Dictionary should match the format of the JSON configuration files
  • gl_version (int, optional) – The OpenGL version to use (Linux only). Defaults to GL_VERSION.OPENGL4.
  • window_res ((int, int), optional) – The (height, width) to load the engine window at. Overrides the (optional) resolution in the scenario config file
  • verbose (bool, optional) – Whether to run in verbose mode. Defaults to False.
  • show_viewport (bool, optional) – If the viewport window should be shown on-screen (Linux only). Defaults to True
  • ticks_per_sec (int, optional) – The number of frame ticks per unreal seconds. Defaults to 30.
  • copy_state (bool, optional) – If the state should be copied or passed as a reference when returned. Defaults to True

A holodeck environment instantiated

with all the settings necessary for the specified world, and other supplied arguments.

Return type: