soulsgym

The soulsgym package is a collection of Gymnasium environments for Dark Souls III.

It contains two main components. The first module soulsgym.envs includes a core environment as well as an individual environment for each available boss fight. SoulsGym uses Dark Souls III as the underlying engine that is modified at runtime by reading and writing into the game memory to create the environments.

Note

The environments only cover one phase of the boss fights so far. For further explanations see envs.

We do however provide a demo environment. This environment is meant to test the agent on a single episode of the full boss fight.

The second main module is the soulsgym.core module. It contains all necessary functionalities for the environments to interact with the game. Unless you want to develop your own environment for envs or are trying to contribute, this module can safely be ignored.

soulsgym registers its environments with the gymnasium module on import. In order to use the environments you follow the usual pattern of gymnasium.make. A list of all available environments is available at soulsgym.available_envs.