Skip to content

Commit 9d4ab0d

Browse files
authored
Update README.md
1 parent 15c7044 commit 9d4ab0d

File tree

1 file changed

+7
-12
lines changed

1 file changed

+7
-12
lines changed

README.md

+7-12
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#ViZDoom [![Build Status](https://travis-ci.org/Marqt/ViZDoom.svg?branch=master)](https://travis-ci.org/Marqt/ViZDoom)
1+
#ViZDoom 1.0.4
22
[http://vizdoom.cs.put.edu.pl](http://vizdoom.cs.put.edu.pl)
33

44
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 deep reinforcement learning, in particular.
@@ -18,12 +18,6 @@ ViZDoom is based on [ZDoom](https://github.com/rheit/zdoom) to provide the game
1818

1919
ViZDoom API is **reinforcement learning** friendly (suitable also for learning from demonstration, apprenticeship learning or apprenticeship via inverse reinforcement learning, etc.).
2020

21-
## Planned Features (June)
22-
* Lua bindings,
23-
* Multi-player working in sync mode,
24-
* Labeling game objects visible in the frame,
25-
* Time scaling in async mode.
26-
2721
## Cite as
2822

2923
>Michał Kempka, Marek Wydmuch, Grzegorz Runc, Jakub Toczek & Wojciech Jaśkowski, ViZDoom: A Doom-based AI Research Platform for Visual Reinforcement Learning, 2016 ([arXiv:1605.02097](http://arxiv.org/abs/1605.02097))
@@ -50,17 +44,17 @@ cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_PYTHON=ON -DBUILD_JAVA=ON
5044
make
5145
```
5246

53-
``-DBUILD_PYTHON=ON`` and ``-DBUILD_JAVA=ON`` CMake options for Python and Java bindings are optional (default OFF).
47+
``-DBUILD_PYTHON=ON`` and ``-DBUILD_JAVA=ON`` CMake options for Python and Java bindings are optional (default OFF). To force building bindings for Python3 instead of first version found use ``-DBUILD_PYTHON3=ON`` (needs Boost.Python builded with Python 3, default OFF).
5448

5549
###Windows
5650

57-
We are providing compiled runtime binaries and development libraries for Windows [here](https://github.com/Marqt/ViZDoom/releases/download/1.0.2/ViZDoom-1.0.2-Win-x86_64.zip).
51+
We are providing compiled runtime binaries and development libraries for Windows [here](https://github.com/Marqt/ViZDoom/releases/download/1.0.4/ViZDoom-1.0.4-Win-x86_64.zip).
5852

5953
####Dependencies
6054
* CMake 3.0+
6155
* Visual Studio 2012+
6256
* Boost libraries
63-
* Python 2.7+ with Numpy and Boost.Python for Python binding (optional)
57+
* Python 2.7+ or Python 3.4+ with Numpy and Boost.Python for Python binding (optional)
6458
* JDK for Java binding (JAVA_HOME must be set) (optional)
6559

6660
Additionally, [ZDoom dependencies](http://zdoom.org/wiki/Compile_ZDoom_on_Windows) are needed.
@@ -75,7 +69,7 @@ Run CMake GUI, select ViZDoom's root directory and set paths to:
7569
* NUMPY_INCLUDES (optional)
7670
* ZDoom dependencies paths
7771

78-
In configuration select BUILD_PYTHON and BUILD_JAVA options for Python and Java bindings (optional, default OFF).
72+
In configuration select BUILD_PYTHON, BUILD_PYTHON3 and BUILD_JAVA options for Python and Java bindings (optional, default OFF).
7973

8074
Use generated Visual Studio solution to build all ViZDoom's parts.
8175

@@ -87,7 +81,7 @@ Let us know if You are using ViZDoom on OSX.
8781
* CMake 3.0+
8882
* XCode 5+
8983
* Boost libraries
90-
* Python 2.7+ with Numpy and Boost.Python for Python binding (optional)
84+
* Python 2.7+ or Python 3+ with Numpy and Boost.Python for Python binding (optional)
9185
* JDK for Java binding (JAVA_HOME must be set) (optional)
9286

9387
Additionally, [ZDoom dependencies](http://zdoom.org/wiki/Compile_ZDoom_on_Mac_OS_X) are needed.
@@ -111,6 +105,7 @@ Compilation output will be placed in ``vizdoom_root_dir/bin`` and it should cont
111105
* ``bin/libvizdoom.a (vizdoom.lib)`` - C++ ViZDoom static library
112106
* ``bin/libvizdoom.so (vizdoom.dll)`` - C++ ViZDoom dynamically linked library
113107
* ``bin/python/vizdoom.so (vizdoom.pyd)`` - ViZDoom Python module
108+
* ``bin/python3/vizdoom.so (vizdoom.pyd)`` - ViZDoom Python3 module
114109
* ``bin/java/libvizdoom.so (vizdoom.dll)`` - ViZDoom library for Java
115110
* ``bin/java/vizdoom.jar`` - Contains ViZDoom Java classes
116111

0 commit comments

Comments
 (0)