ViZDoom 1.3.0 Release Notes

Highlights of this release

• Farama General Standards compliance - ViZDoom now meets Farama General Standards for projects
• Original Doom levels - added as Gymnasium environments
• New methods for setting rewards for common actions like kill/item pickup/secret discovery/frag/death/level etc.
• Audio buffer and notification buffer - access in-game audio and messages and notifications in both original and Gymnasium APIs
• Python 3.13 & 3.14 support
• Better docstrings and type hints via .pyi file
• Semantic segmentation - category labels now available for objects in labels buffer

What's Changed (since 1.2.4)

Core

• Remove signal trapping by ViZDoom thread by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/599
• Add kill/item/secret/frag etc. reward methods by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/611
• Add notification buffer to a state (text that contains in-game messages and notifications, available both in original and Gymnasium API) by @mwydmuch and @melnimr in https://github.com/Farama-Foundation/ViZDoom/pull/636, https://github.com/Farama-Foundation/ViZDoom/pull/654, https://github.com/Farama-Foundation/ViZDoom/pull/655, https://github.com/Farama-Foundation/ViZDoom/pull/657, https://github.com/Farama-Foundation/ViZDoom/pull/674, https://github.com/Farama-Foundation/ViZDoom/pull/675, and https://github.com/Farama-Foundation/ViZDoom/pull/658
• Add ViZDoom Python interface file to aid an IDE for hinting by @Trenza1ore in https://github.com/Farama-Foundation/ViZDoom/pull/620, https://github.com/Farama-Foundation/ViZDoom/pull/625, and https://github.com/Farama-Foundation/ViZDoom/pull/667
• Add category as label attribute that can be used for semantic segmentation by @Trenza1ore in https://github.com/Farama-Foundation/ViZDoom/pull/626
• Add option to set configuration using config string or dict (DoomGame.set_config) by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/664
• Add getters for some DoomGame attributes by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/665
• Rename ViZDoomOpenALSoundException to ViZDoomNoOpenALSoundException by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/646
• Refactor and make ServerState more efficient by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/646

Gymnasium

• Add support for truncation in Gymnasium wrapper based on episode timeout by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/587, and https://github.com/Farama-Foundation/ViZDoom/pull/614
• Binary buttons now use MultiBinary action space by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/615
• Add the audio buffer to the observation state in Gymnasium wrapper by @melnimr in https://github.com/Farama-Foundation/ViZDoom/pull/623

OpenAI Gym

• Remove the original OpenAI Gym wrapper by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/594

Scenarios and environments

• Add original Doom levels as Gymnasium environments by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/662 and https://github.com/Farama-Foundation/ViZDoom/pull/676
• Unified configurations (resolution, rendering, etc) for all default environments and bump their version from v0 to v1 by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/662
• Update freedoom to version 0.13 by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/613

Determinism improvements

• Make animated textures to reset at the beginning of each episode to ensure screen buffer determinism (make envs with animated textures deterministic) by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/672
• Make audio backend to restart at the beginning of each episode to ensure audio buffer determinism by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/673

Audio buffer

• Add OpenAL init check when using AudioBuffer and other improvments by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/645 and https://github.com/Farama-Foundation/ViZDoom/pull/651
• Add basic_audio.wad by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/648

Automap buffer

• Add an option to use sprites with automap (DoomGame.set_automap_render_objects_as_sprites) by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/671
• Fix automap rendering issues by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/672

Documentation

• Add the HASARD benchmark to the third-party projects list by @TTomilin in https://github.com/Farama-Foundation/ViZDoom/pull/639
• Add gifs presenting each default environment by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/677, and https://github.com/Farama-Foundation/ViZDoom/pull/679
• Add docs page about SLADE - Doom map editor - configuration with ViZDoom by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/669
• Fix numerous typos and small issues with documentation by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/612, https://github.com/Farama-Foundation/ViZDoom/pull/646, https://github.com/Farama-Foundation/ViZDoom/pull/667, https://github.com/Farama-Foundation/ViZDoom/pull/679, https://github.com/Farama-Foundation/ViZDoom/pull/681, https://github.com/Farama-Foundation/ViZDoom/pull/682

Examples

• Add example benchmarking the VizDoom as Gymnasium vectorized env by @melnimr in https://github.com/Farama-Foundation/ViZDoom/pull/616
• Update learning_stable_baselines3.py to support audio and notifications buffers by @melnimr and @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/638, and github.com/Farama-Foundation/ViZDoom/pull/674

Building, tests, CI/CD, and dependencies

• Pre-commit fixes and workflow updates by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/603, https://github.com/Farama-Foundation/ViZDoom/pull/604, https://github.com/Farama-Foundation/ViZDoom/pull/605, https://github.com/Farama-Foundation/ViZDoom/pull/593, https://github.com/Farama-Foundation/ViZDoom/pull/594, https://github.com/Farama-Foundation/ViZDoom/pull/596, https://github.com/Farama-Foundation/ViZDoom/pull/597, https://github.com/Farama-Foundation/ViZDoom/pull/598
• Add support for version suffixes by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/609, and https://github.com/Farama-Foundation/ViZDoom/pull/610
• Misc Boost related fixes by @Trenza1ore and @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/631, https://github.com/Farama-Foundation/ViZDoom/pull/641, https://github.com/Farama-Foundation/ViZDoom/pull/642, https://github.com/Farama-Foundation/ViZDoom/pull/643 and https://github.com/Farama-Foundation/ViZDoom/pull/644
• Add tests for exceptions by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/646
• Update workflows to use trusted-publishing by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/650
• Windows workflow fixes by @mwydmuch and @Trenza1ore in https://github.com/Farama-Foundation/ViZDoom/pull/628, https://github.com/Farama-Foundation/ViZDoom/pull/629 and https://github.com/Farama-Foundation/ViZDoom/pull/652
• Run apt-get update before building docs by @Trenza1ore in https://github.com/Farama-Foundation/ViZDoom/pull/630
• Drop wheels building for Intel macOS by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/660
• Switch to pygame-ce by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/653
• Update pybind11 and workflows to include Python 3.13 and Python 3.14 by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/608, and https://github.com/Farama-Foundation/ViZDoom/pull/666
• Parallel tests via pytest-xdist by @Trenza1ore in https://github.com/Farama-Foundation/ViZDoom/pull/668
• Add support for editable mode (pip install -e) by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/670
• Add test for a basic processing loop by @mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/672

New Contributors

• @melnimr made their first contribution in https://github.com/Farama-Foundation/ViZDoom/pull/616
• @Trenza1ore made their first contribution in https://github.com/Farama-Foundation/ViZDoom/pull/620

Full Changelog: https://github.com/Farama-Foundation/ViZDoom/compare/1.2.4...1.3.0