From 2b3b05752baa9eaeb66bc6406d885ae49759931d Mon Sep 17 00:00:00 2001 From: Marek Wydmuch Date: Tue, 14 Jun 2016 23:27:35 +0200 Subject: [PATCH] Update README.md Former-commit-id: 9d4ab0d99f8df29ecce6ef9bf301723e033c4dd8 --- README.md | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index db413843e..78e610bb0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -#ViZDoom [![Build Status](https://travis-ci.org/Marqt/ViZDoom.svg?branch=master)](https://travis-ci.org/Marqt/ViZDoom) +#ViZDoom 1.0.4 [http://vizdoom.cs.put.edu.pl](http://vizdoom.cs.put.edu.pl) 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 ViZDoom API is **reinforcement learning** friendly (suitable also for learning from demonstration, apprenticeship learning or apprenticeship via inverse reinforcement learning, etc.). -## Planned Features (June) -* Lua bindings, -* Multi-player working in sync mode, -* Labeling game objects visible in the frame, -* Time scaling in async mode. - ## Cite as >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 make ``` -``-DBUILD_PYTHON=ON`` and ``-DBUILD_JAVA=ON`` CMake options for Python and Java bindings are optional (default OFF). +``-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). ###Windows -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). +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). ####Dependencies * CMake 3.0+ * Visual Studio 2012+ * Boost libraries -* Python 2.7+ with Numpy and Boost.Python for Python binding (optional) +* Python 2.7+ or Python 3.4+ with Numpy and Boost.Python for Python binding (optional) * JDK for Java binding (JAVA_HOME must be set) (optional) 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: * NUMPY_INCLUDES (optional) * ZDoom dependencies paths -In configuration select BUILD_PYTHON and BUILD_JAVA options for Python and Java bindings (optional, default OFF). +In configuration select BUILD_PYTHON, BUILD_PYTHON3 and BUILD_JAVA options for Python and Java bindings (optional, default OFF). Use generated Visual Studio solution to build all ViZDoom's parts. @@ -87,7 +81,7 @@ Let us know if You are using ViZDoom on OSX. * CMake 3.0+ * XCode 5+ * Boost libraries -* Python 2.7+ with Numpy and Boost.Python for Python binding (optional) +* Python 2.7+ or Python 3+ with Numpy and Boost.Python for Python binding (optional) * JDK for Java binding (JAVA_HOME must be set) (optional) 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 * ``bin/libvizdoom.a (vizdoom.lib)`` - C++ ViZDoom static library * ``bin/libvizdoom.so (vizdoom.dll)`` - C++ ViZDoom dynamically linked library * ``bin/python/vizdoom.so (vizdoom.pyd)`` - ViZDoom Python module +* ``bin/python3/vizdoom.so (vizdoom.pyd)`` - ViZDoom Python3 module * ``bin/java/libvizdoom.so (vizdoom.dll)`` - ViZDoom library for Java * ``bin/java/vizdoom.jar`` - Contains ViZDoom Java classes