Skip to content

environment

Module environment

The world of bugs environment API. For most usecases make is sufficient.

all_registered

def all_registered()

Find all worldofbugs environments that have been registered with gym.

Returns:

  • List[EnvSpec] - environments

make

def make(env_id: str,
         worker: int = 0,
         time_scale: float = 1.0,
         log_folder: str = None,
         debug: bool = True)

Make a worldofbugs environment. This is different from the default gym.make function as it hooks directly into the underlying Unity environments. This allows one to connect to the a Unity Editor as well as any worldofbugs build that may or may not be registered with gym. Any builds that exist in the default builds directory for the worldofbugs package may be loaded using gym.make.

Arguments:

  • env_id str - unique environment ID, follows the gym format e.g. WOB/World-v1. A value of None will attempt to connect to a Unity Editor instance.
  • worker int, optional - Worker process to run the environment. This allows multiple environments to run in parallel. Defaults to 0.
  • time_scale float, optional - Simulation speed. WARNING: this can break the game physics, only change if you know what you are doing. Defaults to 1.0.
  • log_folder str, optional - directoy to log to. Defaults to None.
  • debug bool, optional - Get logging messages from unity program and write them to Python stdout. Defaults to True.

Returns:

  • gym.Env - the worldofbugs environment.