Reinforcement Learning environments based on the 1993 game Doom :godmode:
The aim of this release is mainly to add support for Python 3.12 and fix a serious bug in the Gymnasium wrapper (thanks @caozhenxiang-kouji for reporting).
int
type but not for np.int
types, when action_space = Discrete
(reported in #574) by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/575
set/getGameArgs
/set/get_game_args
methods by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/569
Full Changelog: https://github.com/Farama-Foundation/ViZDoom/compare/1.2.2...1.2.3
The aim of this release is mainly to fix some issues with installing ViZDoom on configurations that cannot use binary wheels.
load_config
/loadConfig
fix by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/565
Full Changelog: https://github.com/Farama-Foundation/ViZDoom/compare/1.2.1...1.2.2
This release focuses on improving the user experience by adding support for docstrings and argument names in the Python module, a new documentation website, and, finally, improvements to the building process that allows for prebuilding manylinux wheels. This release does not introduce any changes to the API and is 100% compatible with the previous version.
Full Changelog: https://github.com/Farama-Foundation/ViZDoom/compare/1.2.0...1.2.1
This release adds official Gymnasium support, support for serialization using Pickle, and ARM compatibility. Besides that, it improves and modernizes the codebase to simply further maintenance of the library.
ViZDoom core API and Gym wrapper remain unchanged in this release. The code using the 1.1.X version should be fully compatible with this release.
GameState
object and its subobjects, which are returned from C++ by DoomGame.get_state()
method in core Python API, now also support serialization. However, DoomGame
object that wraps the game engine cannot be serialized.The default configurations for all build-in scenarios/environments were unified to use 320x240 resolution (original DOS Doom resolution) as default.
This release introduces numerous improvements to the codebase that will simplify further maintenance:
Full Changelog: https://github.com/Farama-Foundation/ViZDoom/compare/1.1.14...1.2.0
DEFAULT_FPS
(= DEFAULT_TICRATE
), DEFAULT_FRAMETIME_S
(= 1.0 / DEFAULT_TICRATE
), DEFAULT_FRAMETIME_MS
(= DEFAULT_FRAMETIME_S * 1000
);audio_buffer
to State
and related methods is/setAudioBufferEnabled
, get/setAudioSamplingRate
, get/setAudioBufferSize
.save
and load
methods that allow saving/loading game to/from a file.viz_bots_path
CVAR that allows specifying path to custom bots configuration.