Z-Machine

class textworld.envs.zmachine.jericho.JerichoEnv(*args, **kwargs)

Bases: Environment

Parameters:

request_infos – Information to be included in the game state. By default, only the game’s narrative is included.

close()

Ends the game.

copy()

Return a copy of this environment at the same state.

Return type:

JerichoEnv

load(z_file)

Loads a new text-based game.

Parameters:

path – Path to the game file to load.

Return type:

None

reset()

Starts game from the beginning.

Returns:

Initial state of the game.

seed(seed=None)

Sets the seed for the random number generator.

step(command)

Performs a given command.

Parameters:

command – Text command to send to the interpreter.

Returns:

A tuple containing the new game state, a reward for performing that command and reaching this new state, and whether the game is finished or not.

property game_running: bool

Determines if the game is still running.

Return type:

bool