Vizdoom

This is a maintenance release that fixes some bugs and adds support for NumPy 2.0+.

What's Changed
* Update learning_stable_baselines3.py and other examples by mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/581 and https://github.com/Farama-Foundation/ViZDoom/pull/583
* Fix the ongoing recording not being saved when close() method was called by mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/584
* Add LevDoom and COOM benchmarks to the tools/projects list by TTomilin in https://github.com/Farama-Foundation/ViZDoom/pull/585
* Building and CI/CD updates/clean up by mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/579 and https://github.com/Farama-Foundation/ViZDoom/pull/586
* Update pybind11 version to 2.13.4 to support NumPy>=2.0 by mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/590
* Add workflows for building Windows wheels by mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/591
* Update workflows to support building macOS Apple Silicon (arm64) wheels by mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/592

New Contributors
* TTomilin made their first contribution in https://github.com/Farama-Foundation/ViZDoom/pull/585

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

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).

What's Changed
* Add support for Python 3.12 by mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/570
* Fix the bug in the Gymnasium wrapper that was constructing correct actions only for `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
* Add Farama notifications to the Python package by mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/568
* Add workflows to build docs version by mgoulao in https://github.com/Farama-Foundation/ViZDoom/pull/567
* Add `set/getGameArgs`/`set/get_game_args` methods by mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/569
* Add support for +win_x/y CVARs on Linux and MacOS by mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/569
* Setup.py and tests updates by mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/573
* Add support for viz_noxserver option on macos by mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/577
* Documentation updates by mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/576 and https://github.com/Farama-Foundation/ViZDoom/pull/578

**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.

What's Changed
* Create FUNDING.yml by mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/557
* Create CODE_OF_CONDUCT.md by mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/559
* Building and CI/CD fixes by mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/558, https://github.com/Farama-Foundation/ViZDoom/pull/560, https://github.com/Farama-Foundation/ViZDoom/pull/562
* Documentation updates by mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/561, https://github.com/Farama-Foundation/ViZDoom/pull/563, and https://github.com/Farama-Foundation/ViZDoom/pull/564
* `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.

What's Changed
* Docstrings were added to the Python module by mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/544
* Argument names were added to the Python module by mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/549
* A new documentation website based on Sphinx was created by mgoulao, mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/540, https://github.com/Farama-Foundation/ViZDoom/pull/551, https://github.com/Farama-Foundation/ViZDoom/pull/554
* Manylinux wheels workflow using cibuildwheel was added by mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/552
* Python 3.7 support was dropped by mwydmuch in https://github.com/Farama-Foundation/ViZDoom/pull/550

**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.**

New Features and Improvements:
- **Added Gymnasium support.** The wrapper for Gymnasium 0.28 was added, and from now on it will be an integral part of the library. The old Gym 0.26 wrapper remains as an optional extra. Because of that, we mark this release as the next minor release for the first time in 4 years.
- **Added Pickle support.**
- The Gymnasium/Gym wrappers now support the serialization of environments via pickle. Now both the environments and their states can be serialized.
- The `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.
- **Compatibility with ARM.** The library can now be easily compiled and installed on ARM Linux as well as on Apple Silicon.
- **Python 3.11 support.** The ViZDoom library can now be installed with Python 3.11.

Environments:
The default configurations for all build-in scenarios/environments were unified to use 320x240 resolution (original DOS Doom resolution) as default.

Bug Fixes and Documentation Updates:
This release introduces numerous improvements to the codebase that will simplify further maintenance:
- Pre-commit-hooks with code formatting and checks were added.
- All assembler code was removed. Instead, the C/C++ code that was present in the engine as a fallback is now used instead. Currently, these assembler parts are not bringing significant performance improvements and thus were not worth keeping in our opinion. Because of that, the assembler compiler was removed from the list of dependencies as it's no longer needed.
- Lemon and Zipdir libraries were updated to the newer versions to fix issues with a building project on ARM machines and some Windows configurations.
- Fixed some deprecation warnings in the C/C++ codebase.
- Updated and cleaned-up documentation related to the project building.
- Added a long description for the PyPI package page.
- Added many tests for both core API and the Gymnasium wrapper.
- Cleaned up the codebase and removed unused files, scripts, commented code blocks, and Visual Studio project files.


**Full Changelog**: https://github.com/Farama-Foundation/ViZDoom/compare/1.1.14...1.2.0

Support for Apple Silicon
- Fixed building on Apple Silicon Macbooks.

Gym
- OpenAI Gym environment wrappers were updated to the Gym v0.26 API version.