soulsgym.games

soulsgym.games#

This module contains the game interfaces for the Souls games.

soulsgym.games.game_factory(game_id: str) → Game#

Factory function for creating game interfaces.

Parameters:

game_id – The name of the game.

Returns:

The game interface.

Games#

The soulsgym.games module contains one game class for each supported game. The idea is to use games just like Python objects, where changes to the game object are translated into the necessary memory reads and writes.

Example of using games to reset the player HP.#
    from soulsgym.games import DarkSoulsIII

     game = DarkSoulsIII()  # Game needs to be running at this point
     game.player_hp = game.player_max_hp  # Resets the HP in the actual game

Currently, the following games have been added to soulsgym:

Note

The games are not feature complete. DarkSoulsIII only supports a limited number of bosses so far, and EldenRing lacks all boss support.

Contents