Links update in docs, README.md, setup.py and rockspec

Former-commit-id: 409f609
priyanshu030 · Feb 15, 2017 · 7cedbf5 · 7cedbf5
1 parent 190b9ab
commit 7cedbf5
Show file tree

Hide file tree

Showing 8 changed files with 39 additions and 28 deletions.
diff --git 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 [![Build Status](https://travis-ci.org/mwydmuch/ViZDoom.svg?branch=master)](https://travis-ci.org/mwydmuch/ViZDoom)
 [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.
@@ -53,17 +53,17 @@ ViZDoom API is **reinforcement learning** friendly (suitable also for learning f
 ## Windows build
 For Windows we are providing compiled runtime binaries and development libraries:
 
-### [1.1.0](https://github.com/Marqt/ViZDoom/releases/tag/1.1.0) (2016-12-23):
-- [Python 2.7 (64-bit)](https://github.com/Marqt/ViZDoom/releases/download/1.1.0/ViZDoom-1.1.0-Win-Python27-x86_64.zip)
-- [Python 3.4 (64-bit)](https://github.com/Marqt/ViZDoom/releases/download/1.1.0/ViZDoom-1.1.0-Win-Python34-x86_64.zip)
-- [Python 3.5 (64-bit)](https://github.com/Marqt/ViZDoom/releases/download/1.1.0/ViZDoom-1.1.0-Win-Python35-x86_64.zip)
-- [Lua 5.1 & LuaJIT (64-bit)](https://github.com/Marqt/ViZDoom/releases/download/1.1.0/ViZDoom-1.1.0-Win-Lua51-LuaJIT-x86_64.zip)
-- [Java (64-bit)](https://github.com/Marqt/ViZDoom/releases/download/1.1.0/ViZDoom-1.1.0-Win-Java-x86_64.zip)
+### [1.1.0](https://github.com/mwydmuch/ViZDoom/releases/tag/1.1.0) (2016-12-23):
+- [Python 2.7 (64-bit)](https://github.com/mwydmuch/ViZDoom/releases/download/1.1.0/ViZDoom-1.1.0-Win-Python27-x86_64.zip)
+- [Python 3.4 (64-bit)](https://github.com/mwydmuch/ViZDoom/releases/download/1.1.0/ViZDoom-1.1.0-Win-Python34-x86_64.zip)
+- [Python 3.5 (64-bit)](https://github.com/mwydmuch/ViZDoom/releases/download/1.1.0/ViZDoom-1.1.0-Win-Python35-x86_64.zip)
+- [Lua 5.1 & LuaJIT (64-bit)](https://github.com/mwydmuch/ViZDoom/releases/download/1.1.0/ViZDoom-1.1.0-Win-Lua51-LuaJIT-x86_64.zip)
+- [Java (64-bit)](https://github.com/mwydmuch/ViZDoom/releases/download/1.1.0/ViZDoom-1.1.0-Win-Java-x86_64.zip)
 
 
 ## Examples
 
-Before running the provided examples, make sure that [freedoom2.wad](https://freedoom.github.io/download.html) is placed it in the ``scenarios`` subdirectory (on Linux it should be done automatically by the building process):
+Before running the provided examples, make sure that [freedoom2.wad](https://freedoom.github.io/download.html) is placed in the same directory as the ViZDoom executable (on Linux it should be done automatically by the building process):
 
 - [Python](examples/python)
 - [C++](examples/c%2B%2B)

diff --git a/doc/Changelog.md b/doc/Changelog.md
@@ -1,6 +1,16 @@
 # Changelog
 
-## Changes in 1.1
+## Changes in 1.1.1
+
+#### GameState
+- `number` renamed to `id` for clearness.
+- `GameVariable.DEATHCOUNT` fixed.
+
+#### Lua specific
+- Fixed crash when calling `getState` in terminal state.
+
+
+## Changes in 1.1.0
 
 #### Buffers
 

diff --git a/doc/ConfigFile.md b/doc/ConfigFile.md
@@ -100,4 +100,4 @@ doom_skill = 5
 
 ```
 
-Other examples can be found [here](https://github.com/Marqt/ViZDoom/tree/master/examples/config)
+Other examples can be found [here](https://github.com/mwydmuch/ViZDoom/tree/master/examples/config)
diff --git a/doc/DoomGame.md b/doc/DoomGame.md
@@ -166,8 +166,8 @@ After calling this method, first state from replay will be available.
 All rewards, variables and state are available during replaying episode.
 
 See also:
-- [examples/python/record_episodes.py](https://github.com/Marqt/ViZDoom/tree/master/examples/python/record_episodes.py),
-- [examples/python/record_multiplayer.py](https://github.com/Marqt/ViZDoom/tree/master/examples/python/record_multiplayer.py).
+- [examples/python/record_episodes.py](https://github.com/mwydmuch/ViZDoom/tree/master/examples/python/record_episodes.py),
+- [examples/python/record_multiplayer.py](https://github.com/mwydmuch/ViZDoom/tree/master/examples/python/record_multiplayer.py).
 
 ---
 ### <a name="isRunning"></a> `isRunning`
@@ -748,7 +748,7 @@ Default value: 35 (default Doom ticrate).
 Config key: `ticrate`
 
 See also:
-- [exmaples/python/ticrate.py](https://github.com/Marqt/ViZDoom/tree/master/examples/python/ticrate.py)
+- [exmaples/python/ticrate.py](https://github.com/mwydmuch/ViZDoom/tree/master/examples/python/ticrate.py)
 
 
 ---
@@ -887,7 +887,7 @@ Default value: randomized in constructor
 Config key: `seed`
 
 See also:
-- [examples/python/seed.py](https://github.com/Marqt/ViZDoom/tree/master/examples/python/seed.py)
+- [examples/python/seed.py](https://github.com/mwydmuch/ViZDoom/tree/master/examples/python/seed.py)
 
 
 
@@ -1037,7 +1037,7 @@ Config key: `depthBufferEnabled/depth_buffer_enabled`
 
 See also: 
 - [`Types: GameState`](Types.md#gamestate)
-- [examples/python/buffers.py](https://github.com/Marqt/ViZDoom/tree/master/examples/python/buffers.py),
+- [examples/python/buffers.py](https://github.com/mwydmuch/ViZDoom/tree/master/examples/python/buffers.py),
 
 ---
 ### <a name="isLabelsBufferEnabled"></a> `isLabelsBufferEnabled`
@@ -1073,8 +1073,8 @@ Config key: `labelsBufferEnabled/labels_buffer_enabled`
 See also: 
 - [`Types: Label`](Types.md#label)
 - [`Types: GameState`](Types.md#gamestate)
-- [examples/python/labels.py](https://github.com/Marqt/ViZDoom/tree/master/examples/python/labels.py),
-- [examples/python/buffers.py](https://github.com/Marqt/ViZDoom/tree/master/examples/python/buffers.py),
+- [examples/python/labels.py](https://github.com/mwydmuch/ViZDoom/tree/master/examples/python/labels.py),
+- [examples/python/buffers.py](https://github.com/mwydmuch/ViZDoom/tree/master/examples/python/buffers.py),
 
 
 
@@ -1111,7 +1111,7 @@ Config key: `automapBufferEnabled/automap_buffer_enabled`
 
 See also: 
 - [`Types: GameState`](Types.md#gamestate)
-- [examples/python/buffers.py](https://github.com/Marqt/ViZDoom/tree/master/examples/python/buffers.py),
+- [examples/python/buffers.py](https://github.com/mwydmuch/ViZDoom/tree/master/examples/python/buffers.py),
 
 
 ---

diff --git a/doc/Types.md b/doc/Types.md
@@ -30,8 +30,8 @@
 - `std::string / string / String / str` **objectName / object_name**
 - `uint8_t / number / byte / int` **value**
 - `double / number / double / float` **objectPositionX / object_position_x**
-- `double / number / double / float` **objectPositionX / object_position_y**
-- `double / number / double / float` **objectPositionX / object_position_z**
+- `double / number / double / float` **objectPositionY / object_position_y**
+- `double / number / double / float` **objectPositionZ / object_position_z**
 
 **objectId / object_id** - unique object instance ID - assigned when object is seen for the first time 
 (so object with lower id was seen before object with higher).
@@ -41,7 +41,7 @@
 ### <a name="gamestate"></a> `GameState`
 (`C++ type / Lua type / Java type / Python type` **name**)
 
-- `unsigned int / number / unsigned int / int` **number**
+- `unsigned int / number / unsigned int / int` **id**
 - `std::vector<float> / DoubleTensor / double[] / numpy.double[]` **gameVariables / game_variables**
 - `BufferPtr / ByteTensor / byte[] / numpy.uint8[]` **screenBuffer / screen_buffer**
 - `BufferPtr / ByteTensor / byte[] / numpy.uint8[]` **depthBuffer / depth_buffer**

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,5 +1,5 @@
 site_name: ViZDoom
-repo_url : https://github.com/Marqt/ViZDoom
+repo_url : https://github.com/mwydmuch/ViZDoom
 docs_dir : doc
 pages:
 - ViZDoom: index.md

diff --git a/setup.py b/setup.py
@@ -48,7 +48,7 @@ def run(self):
         except subprocess.CalledProcessError:
             sys.stderr.write(
                 "\033[1m" + "\nInstallation failed, you may be missing some dependencies. "
-                            "\nPlease check https://github.com/Marqt/ViZDoom/blob/master/doc/Building.md "
+                            "\nPlease check https://github.com/mwydmuch/ViZDoom/blob/master/doc/Building.md "
                             "for details\n\n"
                 + "\033[0m")
             raise

diff --git a/vizdoom-1.1.0-1.rockspec → vizdoom-1.1.1-0.rockspec b/vizdoom-1.1.0-1.rockspec → vizdoom-1.1.1-0.rockspec
@@ -1,9 +1,9 @@
 package = "vizdoom"
-version = "1.1.0-1"
+version = "1.1.1-0"
 
 source = {
-    url = "git://github.com/Marqt/ViZDoom",
-    tag = "1.1.0-luarocks"
+    url = "git://github.com/mwydmuch/ViZDoom",
+    tag = "1.1.1"
 }
 
 description = {
@@ -13,7 +13,7 @@ description = {
         It is primarily intended for research in machine visual learning, and deep reinforcement learning, in particular.
     ]],
     homepage = "http://vizdoom.cs.put.edu.pl/",
-    --issues_url = "https://github.com/Marqt/ViZDoom/issues"
+    --issues_url = "https://github.com/mwydmuch/ViZDoom/issues"
     --labels = {"vizdoom", "doom", "ai", "deep learning", "reinforcement learning", "research"}
 }
 
@@ -22,13 +22,14 @@ supported_platforms = {"unix"}
 dependencies = {
     "torch >= 7.0",
     "image >= 1.0",
+    "torchffi >= 1.0",
 }
 
 build = {
     type = "command",
     build_command = [[
         rm -f CMakeCache.txt
-        cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_LUA=ON -DLUA_LIBRARIES="$(LUA_LIBDIR)/libluajit.so" -DLUA_INCLUDE_DIR="$(LUA_INCDIR)" && $(MAKE)
+        cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_LUA=ON -DLUA_LIBRARIES="$(LUA_LIBDIR)/libluajit.so" -DLUA_INCLUDE_DIR="$(LUA_INCDIR)" && $(MAKE) -j 4
     ]],
     install_command = [[
         mkdir -p $(LUA_LIBDIR)/lua/5.1/vizdoom
Original file line number	Diff line number	Diff line change
Expand Up		@@ -100,4 +100,4 @@ doom_skill = 5

		```

		Other examples can be found [here](https://github.com/Marqt/ViZDoom/tree/master/examples/config)
		Other examples can be found [here](https://github.com/mwydmuch/ViZDoom/tree/master/examples/config)