#ViZDoom
ViZDoom allows developing AI bots that play Doom using only the visual information (the screen buffer). It is primarily intended for research in machine visual learning, and reinforcement deep learning, in particular.
ViZDoom is based on ZDoom to provide the game mechanics.
- API for C++, Python and Java,
- Easy-to-create custom scenarios (examples available),
- Single-player (sync and async) and multi-player (async) modes,
- Fast (up to 7000 fps in sync mode, single threaded),
- Customizable resolution and rendering parameters,
- Access to the depth buffer (3D vision)
- Off-screen rendering,
- Lightweight (few MBs),
- Supports Linux and Windows.
ViZDoom API is reinforcement learning friendly (suitable also for learning from demonstration, apprenticeship learning or apprenticeship via inverse reinforcement learning, etc.).
###Linux
####Dependencies
- CMake 3.0+
- Make
- GCC 4.6+
- Boost libraires
- Python 2.7+ with Numpy and Boost.Python for Python binding (optional)
- JDK for Java binding (optional)
Additionally, ZDoom dependencies are needed.
####Compiling In ViZDoom's root directory:
cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_PYTHON=ON -DBUILD_JAVA=ON
make-DBUILD_PYTHON=ON/OFF and -DBUILD_JAVA=ON/OFF CMake options for Python and Java bindings are optional (default OFF).
Also, for Java binding JAVA_HOME environment variable must be set.
###Windows
ViZDoom is now highly unstable on Windows - we are working to fix it. In the future, we will provide compiled runtime binaries and development libraries for Windows.
####Dependencies
- CMake 3.0+
- Visual Studio 2012+
- Boost libraires
- Python 2.7+ with Numpy and Boost.Python for Python binding (optional)
- JDK for Java binding (optional)
Additionally, ZDoom dependencies are needed.
####Compiling Run CMake GUI, select ViZDoom's root directory and set paths to:
- BOOST_ROOT
- BOOST_INCLUDEDIR
- BOOST_LIBRARYDIR
- PYTHON_INCLUDE_DIR (optional)
- PYTHON_LIBRARY (optional)
- ZDoom dependencies paths
Use generated Visual Studio solution to build all ViZDoom's parts.
###OSX Untested, code should be compatible, CMake may need minor adjustments. Let us know if You are using ViZDoom on OSX.
##Examples
Before running the provided examples, make sure that freedoom2.wad is placed it in the scenarios subdirectory (it should be done automatically by the building process).