Skip to content

Commit

Permalink
More little changes in doc, Changelog.md inited
Browse files Browse the repository at this point in the history
Former-commit-id: 66ba782
  • Loading branch information
mwydmuch committed Aug 21, 2016
1 parent cd0c27d commit 5a63cd0
Show file tree
Hide file tree
Showing 4 changed files with 190 additions and 141 deletions.
17 changes: 7 additions & 10 deletions doc/Building.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,6 @@ make

## Windows

We are providing compiled runtime binaries and development libraries for Windows:
[1.0.4](https://github.com/Marqt/ViZDoom/releases/download/1.0.4/ViZDoom-1.0.4-Win-x86_64.zip) or [1.1.0pre](https://github.com/Marqt/ViZDoom/releases/download/1.1.0pre-CIG2016-warm-up-fixed/ViZDoom-1.1.0pre-CIG2016-warm-up-Win-x86_64.zip).

### Dependencies
* CMake 2.8+
* Visual Studio 2012+
Expand Down Expand Up @@ -81,12 +78,12 @@ Craeting symlink to the app executable may be need:
## Compilation output
Compilation output will be placed in ``vizdoom_root_dir/bin`` and it should contain following files.

* ``bin/vizdoom/vizdoom.exe`` - ViZDoom executable
* ``bin/vizdoom / vizdoom.exe`` - ViZDoom executable
* ``bin/vizdoom.pk3`` - resources file used by ViZDoom (needed by ViZDoom executable)
* ``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/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
* ``bin/lua/vizdoom.so/vizdoom.dll`` - ViZDoom Lua module
* ``bin/lua/vizdoom.so / vizdoom.dll`` - ViZDoom Lua module
43 changes: 43 additions & 0 deletions doc/Changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Changelog

## Changes in 1.1

#### Buffers

* Depth buffer is now separate buffer in state and ScreenFormat values with it was removed - `is/setDepthBufferEnabled` added.
* Added in frame actors labeling feature -`is/setLabelsBufferEnabled` added.
* Added buffer with in game automap - `is/setAutomapBufferEnabled`, `setAutomapMode`, `setAutomapRoate`, `setAutomapRenderTextures`, AutomapMode enum added.

#### GameState

* `getState` will now return nullptr/null/None if game is in the terminal state.
* `imageBuffer` renamed to `screenBuffer`.
* Added `depthBuffer`, `labelsBuffer` and `automapBuffer` and `labels` fields.

#### Rendering options

* The option to use minimal hud instead of default - `setRenderMinimalHud` added.
* The option to enable/disable effects that use sprites - `setRenderEffectsSprites` added.
* The option to render ingame messages independently of the console output - `setRenderMessages` added.

#### Episode recording and replaying
...

#### Ticrate
* The option to set number of tics executed per second in ASNYC Modes.

#### Config loading
...

#### Others
* Improved exceptions messages.
* Java exceptions handling fixed.
* Bugs associated with paths handling fixed.
* Many minor bugs fixed.

#### C++ specific

* A lot of overloaded methods turned into a methods with default arguments.
* `getState()` now returns GameStatePtr (std::shared_ptr<GameState>) instead of GameState.
* Buffers are now copied.
* GameState's buffer has now BufferPtr (std::shared_ptr<Buffer>) type - Buffer (std::vector<uint8_t>).
Empty file added doc/ConfigFiles.md
Empty file.
Loading

0 comments on commit 5a63cd0

Please sign in to comment.