diff --git a/doc/DoomGame.md b/doc/DoomGame.md
index 8de8014ab..544739698 100644
--- a/doc/DoomGame.md
+++ b/doc/DoomGame.md
@@ -4,6 +4,94 @@
* [init](#init)
* [close](#close)
* [newEpisode](#newEpisode)
+* [replayEpisode](#replayEpisode)
+* [isRunning](#isRunning)
+* [setAction](#setAction)
+* [advanceAction](#advanceAction)
+* [makeAction](#makeAction)
+* [isNewEpisode](#isNewEpisode)
+* [isEpisodeFinished](#isEpisodeFinished)
+* [isPlayerDead](#isPlayerDead)
+* [respawnPlayer](#respawnPlayer)
+* [sendGameCommand](#sendGameCommand)
+* [getState](#getState)
+* [getLastAction](#getLastAction)
+* [getEpisodeTime](#getEpisodeTime)
+
+[Buttons settings methods](#buttons)
+* [addAvailableButton](#addAvailableButton)
+* [clearAvailableButtons](#clearAvailableButtons)
+* [getAvailableButtonsSize](#getAvailableButtonsSize)
+* [setButtonMaxValue](#setButtonMaxValue)
+* [getButtonMaxValue](#getButtonMaxValue)
+
+[GameVariables methods](#vars)
+* [addAvailableGameVariable](#addAvailableGameVariable)
+* [clearAvailableGameVariables](#clearAvailableGameVariables)
+* [getAvailableGameVariablesSize](#getAvailableGameVariablesSize)
+* [getGameVariable](#getGameVariable)
+
+[Game Arguments methods](#args)
+* [addGameArgs](#addGameArgs)
+* [clearGameArgs](#clearGameArgs)
+
+[Rewards methods](#rewards)
+* [getLivingReward](#getLivingReward)
+* [setLivingReward](#setLivingReward)
+* [getDeathPenalty](#getDeathPenalty)
+* [setDeathPenalty](#setDeathPenalty)
+* [getLastReward](#getLastReward)
+* [getTotalReward](#getTotalReward)
+
+[General game setting methods](#settings)
+* [loadConfig](#loadConfig)
+* [getMode](#getMode)
+* [setMode](#setMode)
+* [getTicrate](#getTicrate)
+* [setTicrate](#setTicrate)
+* [setViZDoomPath](#setViZDoomPath)
+* [setDoomGamePath](#setDoomGamePath)
+* [setDoomScenarioPath](#setDoomScenarioPath)
+* [setDoomMap](#setDoomMap)
+* [setDoomSkill](#setDoomSkill)
+* [setDoomConfigPath](#setDoomConfigPath)
+* [getSeed](#getSeed)
+* [setSeed](#setSeed)
+* [getEpisodeStartTime](#getEpisodeStartTime)
+* [setEpisodeStartTime](#setEpisodeStartTime)
+* [getEpisodeTimeout](#getEpisodeTimeout)
+* [setEpisodeTimeout](#setEpisodeTimeout)
+
+[Output/rendering setting methods](#rendering)
+* [setScreenResolution](#setScreenResolution)
+* [getScreenFormat](#getScreenFormat)
+* [setScreenFormat](#setScreenFormat)
+* [isDepthBufferEnabled](#isDepthBufferEnabled)
+* [setDepthBufferEnabled](#setDepthBufferEnabled)
+* [isLabelsBufferEnabled](#isLabelsBufferEnabled)
+* [setLabelsBufferEnabled](#setLabelsBufferEnabled)
+* [isAutomapBufferEnabled](#isAutomapBufferEnabled)
+* [setAutomapBufferEnabled](#setAutomapBufferEnabled)
+* [setAutomapMode](#setAutomapMode)
+* [setAutomapRotate](#setAutomapRotate)
+* [setAutomapRenderTextures](#setAutomapRenderTextures)
+* [setRenderHud](#setRenderHud)
+* [setRenderMinimalHud](#setRenderMinimalHud)
+* [setRenderWeapon](#setRenderWeapon)
+* [setRenderCrosshair](#setRenderCrosshair)
+* [setRenderDecals](#setRenderDecals)
+* [setRenderParticles](#setRenderParticles)
+* [setRenderEffectsSprites](#setRenderEffectsSprites)
+* [setRenderMessages](#setRenderMessages)
+* [setWindowVisible](#setWindowVisible)
+* [setConsoleEnabled](#setConsoleEnabled)
+* [setSoundEnabled](#setSoundEnabled)
+* [getScreenWidth](#getScreenWidth)
+* [getScreenHeight](#getScreenHeight)
+* [getScreenChannels](#getScreenChannels)
+* [getScreenPitch](#getScreenPitch)
+* [getScreenSize](#getScreenSize)
+
## Flow control methods:
@@ -23,7 +111,7 @@ Init returns true when the game was started properly and false otherwise.
---
-### `close`
+### `close`
| C++ | `void close()` |
| :-- | :-- |
@@ -56,7 +144,7 @@ Then the rest of the players must also call this method to start a new episode.
---
-### `replayEpisode`
+### `replayEpisode`
| C++ | `void replayEpisode(std::string filePath, unsigned int player = 0)` |
| :-- | :-- |
@@ -78,7 +166,7 @@ See also:
---
-### `isRunning`
+### `isRunning`
| C++ | `bool isRunning()` |
| :-- | :-- |
@@ -90,7 +178,7 @@ Checks if the ViZDoom game instance is running.
---
-### `setAction`
+### `setAction`
| C++ | `void setAction(std::vector const &actions)` |
| :-- | :-- |
@@ -104,7 +192,7 @@ or in configuration file (in order of appearance).
---
-### `advanceAction`
+### `advanceAction`
| C++ | `void advanceAction(unsigned int tics = 1, bool updateState = true, bool renderOnly = false)` |
| :-- | :-- |
@@ -119,7 +207,7 @@ will be rendered after last processed tic.
---
-### `makeAction`
+### `makeAction`
| C++ | `double makeAction(std::vector const &actions, unsigned int tics = 1)` |
| :-- | :-- |
@@ -133,7 +221,7 @@ updates the state and calculates a new reward, which is returned.
---
-### `isNewEpisode`
+### `isNewEpisode`
| C++ | `bool isNewEpisode()` |
| :-- | :-- |
@@ -145,7 +233,7 @@ Returns true if the current episode is in the initial state - first state, no ac
---
-### `isEpisodeFinished`
+### `isEpisodeFinished`
| C++ | `bool isEpisodeFinished()` |
| :-- | :-- |
@@ -158,7 +246,7 @@ Returns true if the current episode is in the terminal state (is finished).
---
-### `isPlayerDead`
+### `isPlayerDead`
| C++ | `bool isPlayerDead()` |
| :-- | :-- |
@@ -172,7 +260,7 @@ In multiplayer when player is dead `respawnPlayer` can be called.
---
-### `respawnPlayer`
+### `respawnPlayer`
| C++ | `void respawnPlayer()` |
| :-- | :-- |
@@ -185,7 +273,7 @@ After calling this method, first state after respawn will be available.
---
-### `sendGameCommand`
+### `sendGameCommand`
| C++ | `void sendGameCommand(std::string cmd)` |
| :-- | :-- |
@@ -201,7 +289,7 @@ See also:
---
-### `getState`
+### `getState`
| C++ | `GameStatePtr (std::shared_ptr) GameState getState()` |
| :-- | :-- |
@@ -219,7 +307,7 @@ See also:
---
-### `getLastAction`
+### `getLastAction`
| C++ | `std::vector getLastAction()` |
| :-- | :-- |
@@ -233,7 +321,7 @@ Most useful in `SPECTATOR` mode.
---
-### `getEpisodeTime`
+### `getEpisodeTime`
| C++ | `unsigned int getEpisodeTime()` |
| :-- | :-- |
@@ -244,10 +332,10 @@ Most useful in `SPECTATOR` mode.
Returns number of current episode tic.
-## Buttons settings methods
+## Buttons settings methods
---
-### `addAvailableButton`
+### `addAvailableButton`
| C++ | `void addAvailableButton(Button button, unsigned int maxValue = 0)` |
| :-- | :-- |
@@ -268,7 +356,7 @@ See also:
---
-### `clearAvailableButtons`
+### `clearAvailableButtons`
| C++ | `void clearAvailableButtons()` |
| :-- | :-- |
@@ -280,7 +368,7 @@ Clears all available `Buttons` added so far.
---
-### `getAvailableButtonsSize`
+### `getAvailableButtonsSize`
| C++ | `int getAvailableButtonsSize()` |
| :-- | :-- |
@@ -292,7 +380,7 @@ Returns the number of available `Buttons`.
---
-### `setButtonMaxValue`
+### `setButtonMaxValue`
| C++ | `void setButtonMaxValue(Button button, unsigned int maxValue = 0)` |
| :-- | :-- |
@@ -307,7 +395,7 @@ Constraints limit applies in all Modes.
---
-### `getButtonMaxValue`
+### `getButtonMaxValue`
| C++ | `unsigned int getButtonMaxValue(Button button)` |
| :-- | :-- |
@@ -318,11 +406,11 @@ Constraints limit applies in all Modes.
Returns the maximum allowed, absolute value for the specified button.
-## GameVariables methods
+## GameVariables methods
---
-### `addAvailableGameVariable`
+### `addAvailableGameVariable`
| C++ | `void addAvailableGameVariable(GameVariable variable)` |
| :-- | :-- |
@@ -340,7 +428,7 @@ See also:
- ConfigFile: List
---
-### `clearAvailableGameVariables`
+### `clearAvailableGameVariables`
| C++ | `void clearAvailableGameVariables()` |
| :-- | :-- |
@@ -352,7 +440,7 @@ Clears the list of available `GameVariables` that are included in the GameState
---
-### `getAvailableGameVariablesSize`
+### `getAvailableGameVariablesSize`
| C++ | `unsigned int getAvailableGameVariablesSize()` |
| :-- | :-- |
@@ -364,7 +452,7 @@ Returns the number of available `GameVariables`.
---
-### `getGameVariable`
+### `getGameVariable`
| C++ | `int getGameVariable(GameVariable variable)` |
| :-- | :-- |
@@ -380,10 +468,10 @@ See also:
- Types: `GameVariable`
-## Game Arguments methods
+## Game Arguments methods
---
-### `addGameArgs`
+### `addGameArgs`
| C++ | `void addGameArgs(std::string args)` |
| :-- | :-- |
@@ -401,7 +489,7 @@ See also:
---
-### `clearGameArgs`
+### `clearGameArgs`
| C++ | `void clearGameArgs()` |
| :-- | :-- |
@@ -412,10 +500,10 @@ See also:
Clears all arguments previously added with addGameArgs method.
-## Reward methods
+## Reward methods
---
-### `getLivingReward`
+### `getLivingReward`
| C++ | `double getLivingReward()` |
| :-- | :-- |
@@ -427,7 +515,7 @@ Returns the reward granted to the player after every tic.
---
-### `setLivingReward`
+### `setLivingReward`
| C++ | `void setLivingReward(double livingReward)` |
| :-- | :-- |
@@ -443,7 +531,7 @@ Config key: `livingReward/living_reward`
---
-### `getDeathPenalty`
+### `getDeathPenalty`
| C++ | `double getDeathPenalty()` |
| :-- | :-- |
@@ -455,7 +543,7 @@ Returns the penalty for player's death.
---
-### `setDeathPenalty`
+### `setDeathPenalty`
| C++ | `void setDeathPenalty(double deathPenalty)` |
| :-- | :-- |
@@ -471,7 +559,7 @@ Config key: `deathPenalty/death_penalty`
---
-### `getLastReward`
+### `getLastReward`
| C++ | `double getLastReward()` |
| :-- | :-- |
@@ -483,7 +571,7 @@ Returns a reward granted after last update of state.
---
-### `getTotalReward`
+### `getTotalReward`
| C++ | `double getTotalReward()` |
| :-- | :-- |
@@ -494,10 +582,10 @@ Returns a reward granted after last update of state.
Returns the sum of all rewards gathered in the current episode.
-## General game setting methods
+## General game setting methods
---
-### `loadConfig`
+### `loadConfig`
| C++ | `bool loadConfig(std::string filePath)` |
| :-- | :-- |
@@ -513,7 +601,7 @@ false if file was contained errors.
---
-### `getMode`
+### `getMode`
| C++ | `Mode getMode()` |
| :-- | :-- |
@@ -525,7 +613,7 @@ Returns current mode.
---
-### `setMode`
+### `setMode`
| C++ | `void setMode(Mode mode)` |
| :-- | :-- |
@@ -544,7 +632,7 @@ See also:
---
-### `getTicrate`
+### `getTicrate`
| C++ | `unsigned int getTicrate()` |
| :-- | :-- |
@@ -558,7 +646,7 @@ Returns current ticrate.
---
-### `setTicrate`
+### `setTicrate`
| C++ | `void setTicrate(unsigned int ticrate)` |
| :-- | :-- |
@@ -579,7 +667,7 @@ See also:
---
-### `setViZDoomPath`
+### `setViZDoomPath`
| C++ | `void setViZDoomPath(std::string filePath)` |
| :-- | :-- |
@@ -595,7 +683,7 @@ Config key: `ViZDoomPath/vizdoom_path`
---
-### `setDoomGamePath`
+### `setDoomGamePath`
| C++ | `void setDoomGamePath(std::string filePath)` |
| :-- | :-- |
@@ -611,7 +699,7 @@ Config key: `DoomGamePath/doom_game_path`
---
-### `setDoomScenarioPath`
+### `setDoomScenarioPath`
| C++ | `void setDoomScenarioPath(std::string filePath)` |
| :-- | :-- |
@@ -627,7 +715,7 @@ Config key: `DoomScenarioPath/set_doom_scenario_path`
---
-### `setDoomMap`
+### `setDoomMap`
| C++ | `void setDoomMap(std::string map)` |
| :-- | :-- |
@@ -643,7 +731,7 @@ Config key: `DoomMap/doom_map`
---
-### `setDoomSkill`
+### `setDoomSkill`
| C++ | `void setDoomSkill(int skill)` |
| :-- | :-- |
@@ -668,7 +756,7 @@ Config key: `skill`
---
-### `setDoomConfigPath`
+### `setDoomConfigPath`
| C++ | `void setDoomConfigPath(std::string filePath)` |
| :-- | :-- |
@@ -687,7 +775,7 @@ Config key: `DoomConfigPath/doom_config_path`
---
-### `getSeed`
+### `getSeed`
| C++ | `unsigned int getSeed()` |
| :-- | :-- |
@@ -699,7 +787,7 @@ Return ViZDoom's seed.
---
-### `setSeed`
+### `setSeed`
| C++ | `void setSeed(unsigned int seed)` |
| :-- | :-- |
@@ -718,7 +806,7 @@ See also:
---
-### `getEpisodeStartTime`
+### `getEpisodeStartTime`
| C++ | `unsigned int getEpisodeStartTime()` |
| :-- | :-- |
@@ -730,7 +818,7 @@ Returns start delay of every episode in tics.
---
-### `setEpisodeStartTime`
+### `setEpisodeStartTime`
| C++ | `void setEpisodeStartTime(unsigned int tics)` |
| :-- | :-- |
@@ -747,7 +835,7 @@ Config key: `episodeStartTime/episode_start_time`
---
-### `getEpisodeTimeout`
+### `getEpisodeTimeout`
| C++ | `unsigned int getEpisodeTimeout()` |
| :-- | :-- |
@@ -759,7 +847,7 @@ Returns the number of tics after which the episode will be finished.
---
-### `setEpisodeTimeout`
+### `setEpisodeTimeout`
| C++ | `void setEpisodeTimeout(unsigned int tics)` |
| :-- | :-- |
@@ -772,11 +860,11 @@ Sets the number of tics after which the episode will be finished. 0 will result
Config key: `episodeTimeout/episode_timeout`
-## Output/rendering setting methods
+## Output/rendering setting methods
------------------------------------------------------------------------------------------------------------
---
-### `setScreenResolution`
+### `setScreenResolution`
| C++ | `void setScreenResolution(ScreenResolution resolution)` |
| :-- | :-- |
@@ -797,7 +885,7 @@ See also:
---
-### `getScreenFormat`
+### `getScreenFormat`
| C++ | `ScreenFormat getScreenFormat()` |
| :-- | :-- |
@@ -809,7 +897,7 @@ Returns the format of the screen buffer and the automap buffer.
---
-### `setScreenFormat`
+### `setScreenFormat`
| C++ | `void setScreenFormat(ScreenFormat format)` |
| :-- | :-- |
@@ -830,7 +918,7 @@ See also:
---
-### `isDepthBufferEnabled`
+### `isDepthBufferEnabled`
| C++ | `bool isDepthBufferEnabled()` |
| :-- | :-- |
@@ -844,7 +932,7 @@ Returns true if the depth buffer is enabled.
---
-### `setDepthBufferEnabled`
+### `setDepthBufferEnabled`
| C++ | `void setDepthBufferEnabled(bool depthBuffer)` |
| :-- | :-- |
@@ -866,7 +954,7 @@ See also:
---
-### `isLabelsBufferEnabled`
+### `isLabelsBufferEnabled`
| C++ | `bool isLabelsBufferEnabled()` |
| :-- | :-- |
@@ -880,7 +968,7 @@ Returns true if the labels buffer is enabled.
---
-### `setLabelsBufferEnabled`
+### `setLabelsBufferEnabled`
| C++ | `void setLabelsBufferEnabled(bool labelsBuffer)` |
| :-- | :-- |
@@ -904,7 +992,7 @@ See also:
---
-### `isAutomapBufferEnabled`
+### `isAutomapBufferEnabled`
| C++ | `bool isAutomapBufferEnabled()` |
| :-- | :-- |
@@ -918,7 +1006,7 @@ Returns true if the automap buffer is enabled.
---
-### `setAutomapBufferEnabled`
+### `setAutomapBufferEnabled`
| C++ | `void setAutomapBufferEnabled(bool automapBuffer)` |
| :-- | :-- |
@@ -940,7 +1028,7 @@ See also:
---
-### `setAutomapMode`
+### `setAutomapMode`
| C++ | `void setAutomapMode(AutomapMode mode)` |
| :-- | :-- |
@@ -961,7 +1049,7 @@ See also:
---
-### `setAutomapRotate`
+### `setAutomapRotate`
| C++ | `void setAutomapRotate(bool rotate)` |
| :-- | :-- |
@@ -979,7 +1067,7 @@ Config key: `automapRotate/render_hud`
---
-### `setAutomapRenderTextures`
+### `setAutomapRenderTextures`
| C++ | `setAutomapRenderTextures(bool textures)` |
| :-- | :-- |
@@ -997,7 +1085,7 @@ Config key: `automapRenderTextures/automap_render_textures`
---
-### `setRenderHud`
+### `setRenderHud`
| C++ | `void setRenderHud(bool hud)` |
| :-- | :-- |
@@ -1013,7 +1101,7 @@ Config key: `renderHud/render_hud`
---
-### `setRenderMinimalHud`
+### `setRenderMinimalHud`
| C++ | `void setRenderMinimalHud(bool minHud)` |
| :-- | :-- |
@@ -1031,7 +1119,7 @@ Config key: `renderMinimalHud/render_minimal_hud`
---
-### `setRenderWeapon`
+### `setRenderWeapon`
| C++ | `void setRenderWeapon(bool weapon)` |
| :-- | :-- |
@@ -1047,7 +1135,7 @@ Config key: `renderWeapon/render_weapon`
---
-### `setRenderCrosshair`
+### `setRenderCrosshair`
| C++ | `void setRenderCrosshair(bool crosshair)` |
| :-- | :-- |
@@ -1063,7 +1151,7 @@ Config key: `renderCrosshair/render_crosshair`
---
-### `setRenderDecals`
+### `setRenderDecals`
| C++ | `void setRenderDecals(bool decals)` |
| :-- | :-- |
@@ -1079,7 +1167,7 @@ Config key: `renderDecals/render_decals`
---
-### `setRenderParticles`
+### `setRenderParticles`
| C++ | `void setRenderParticles(bool particles)` |
| :-- | :-- |
@@ -1095,7 +1183,7 @@ Config key: `renderParticles/render_particles`
---
-### `setRenderEffectsSprites`
+### `setRenderEffectsSprites`
| C++ | `void setRenderEffectsSprites(bool sprites)` |
| :-- | :-- |
@@ -1113,7 +1201,7 @@ Config key: `renderEffectsSprites/render_effects_sprites`
---
-### `setRenderMessages`
+### `setRenderMessages`
| C++ | `void setRenderMessages(bool messages)` |
| :-- | :-- |
@@ -1131,7 +1219,7 @@ Config key: `renderMessages/render_messages`
---
-### `setWindowVisible`
+### `setWindowVisible`
| C++ | `void setWindowVisible(bool visibility)` |
| :-- | :-- |
@@ -1148,7 +1236,7 @@ Config key: `windowVisible/window_visible`
---
-### `setConsoleEnabled`
+### `setConsoleEnabled`
| C++ | `void setConsoleEnabled(bool console)` |
| :-- | :-- |
@@ -1164,7 +1252,7 @@ Config key: `consoleEnabled/console_enabled`
---
-### `setSoundEnabled`
+### `setSoundEnabled`
| C++ | `void setSoundEnabled(bool sound)` |
| :-- | :-- |
@@ -1180,7 +1268,7 @@ Config key: `soundEnabled/sound_enabled`
---
-### `getScreenWidth`
+### `getScreenWidth`
| C++ | `int getScreenWidth()` |
| :-- | :-- |
@@ -1192,7 +1280,7 @@ Returns game's screen width - width of all buffers.
---
-### `getScreenHeight`
+### `getScreenHeight`
| C++ | `int getScreenHeight()` |
| :-- | :-- |
@@ -1204,7 +1292,7 @@ Returns game's screen height - height of all buffers.
---
-### `getScreenChannels`
+### `getScreenChannels`
| C++ | `int getScreenChannels()` |
| :-- | :-- |
@@ -1216,7 +1304,7 @@ Returns number of channels in screen buffer and map buffer (depth and labels buf
---
-### `getScreenPitch`
+### `getScreenPitch`
| C++ | `size_t getScreenPitch()` |
| :-- | :-- |
@@ -1228,7 +1316,7 @@ Returns size in bytes of one row in screen buffer and map buffer.
---
-### `getScreenSize`
+### `getScreenSize`
| C++ | `size_t getScreenSize()` |
| :-- | :-- |