OakEmu-RL v0.1.0

Appearance

GameConfiguration ​

python
GameConfiguration(game_configuration_path: str | PathLike) -> None

Python wrapper over the OakEmu C# game configuration.

Load a game configuration from a YAML file.

Parameters:

  • game_configuration_path (str | PathLike) – The path of the game configuration YAML file.

Source

Properties ​

action_names ​

python
action_names: list[str]

Get the game's action names, index-aligned with the action space.

Returns:

  • list[str] – The action names as Python strings.

Source

name ​

python
name: str

Get the game's name.

Returns:

  • str – The game name.

Source

path ​

python
path: Path

Get the path the configuration was loaded from.

Returns:

  • Path – The configuration file path.

Source