From c1f6e14cdcd9f4bfe05f9bd2214ecabb98c86c9a Mon Sep 17 00:00:00 2001 From: Marek Wydmuch Date: Mon, 12 Feb 2024 02:04:01 +0100 Subject: [PATCH 1/4] Add a new method to the core API - isEpisodeTimeoutReached/is_episode_timeout_reached --- include/ViZDoomGame.h | 1 + src/lib/ViZDoomController.cpp | 14 +++++++++----- src/lib/ViZDoomController.h | 1 + src/lib/ViZDoomGame.cpp | 5 +++++ src/lib_python/ViZDoomMethodsDocstrings.h | 3 +++ src/lib_python/ViZDoomPythonModule.cpp | 1 + 6 files changed, 20 insertions(+), 5 deletions(-) diff --git a/include/ViZDoomGame.h b/include/ViZDoomGame.h index 8c5ce4793..0ae86c3ce 100644 --- a/include/ViZDoomGame.h +++ b/include/ViZDoomGame.h @@ -62,6 +62,7 @@ namespace vizdoom { bool isNewEpisode(); bool isEpisodeFinished(); + bool isEpisodeTimeoutReached(); bool isPlayerDead(); void respawnPlayer(); void sendGameCommand(std::string cmd); diff --git a/src/lib/ViZDoomController.cpp b/src/lib/ViZDoomController.cpp index 5cabb09f7..07008f80b 100644 --- a/src/lib/ViZDoomController.cpp +++ b/src/lib/ViZDoomController.cpp @@ -281,10 +281,7 @@ namespace vizdoom { } bool DoomController::isTicPossible() { - return !((!this->gameState->GAME_MULTIPLAYER && this->gameState->PLAYER_DEAD) - || (this->mapTimeout > 0 && this->mapTimeout + this->mapStartTime <= this->gameState->MAP_TIC) - || (this->gameState->MAP_TICLIMIT > 0 && this->gameState->MAP_TICLIMIT <= this->gameState->MAP_TIC) - || (this->gameState->MAP_END)); + return !(this->isMapEnded() || this->isMapTimeoutReached()); } void DoomController::tic(bool update) { @@ -601,7 +598,14 @@ namespace vizdoom { } bool DoomController::isMapEnded() { - return this->doomRunning && this->gameState->MAP_END; + // Check if the map has ended or the player is dead (in single player mode) + return (!this->gameState->GAME_MULTIPLAYER && this->gameState->PLAYER_DEAD) || (this->gameState->MAP_END); + } + + bool DoomController::isMapTimeoutReached() { + // Check if internal or user-defined map timeout has been reached + return (this->mapTimeout > 0 && this->mapTimeout + this->mapStartTime <= this->gameState->MAP_TIC) + || (this->gameState->MAP_TICLIMIT > 0 && this->gameState->MAP_TICLIMIT <= this->gameState->MAP_TIC); } unsigned int DoomController::getMapLastTic() { diff --git a/src/lib/ViZDoomController.h b/src/lib/ViZDoomController.h index 070e8912e..e847703da 100644 --- a/src/lib/ViZDoomController.h +++ b/src/lib/ViZDoomController.h @@ -160,6 +160,7 @@ namespace vizdoom { bool isMapLastTic(); bool isMapFirstTic(); bool isMapEnded(); + bool isMapTimeoutReached(); unsigned int getMapLastTic(); void setNoConsole(bool console); diff --git a/src/lib/ViZDoomGame.cpp b/src/lib/ViZDoomGame.cpp index 45d7c1a6f..bda7d6169 100644 --- a/src/lib/ViZDoomGame.cpp +++ b/src/lib/ViZDoomGame.cpp @@ -342,6 +342,11 @@ namespace vizdoom { return !this->doomController->isTicPossible(); } + bool DoomGame::isEpisodeTimeoutReached() { + if (!this->isRunning()) throw ViZDoomIsNotRunningException(); + return this->doomController->isMapTimeoutReached(); + } + bool DoomGame::isPlayerDead() { if (!this->isRunning()) throw ViZDoomIsNotRunningException(); return this->doomController->isPlayerDead(); diff --git a/src/lib_python/ViZDoomMethodsDocstrings.h b/src/lib_python/ViZDoomMethodsDocstrings.h index 06fc6e901..5fe24e561 100644 --- a/src/lib_python/ViZDoomMethodsDocstrings.h +++ b/src/lib_python/ViZDoomMethodsDocstrings.h @@ -84,6 +84,9 @@ processes the specified number of tics, updates the state and calculates a new r :meth:`make_action` and :meth:`advance_action` methods will take no effect after this point (unless :meth:`new_episode` method is called).)DOCSTRING"; + const char *isEpisodeTimeoutReached = R"DOCSTRING(Returns ``True`` if the current episode is in the terminal state due to exceeding the time limit (timeout) +set with :meth:`set_episode_timeout`` method or via ``+timelimit` parameter.)DOCSTRING"; + const char *isPlayerDead = R"DOCSTRING(Returns ``True`` if the player is dead. In singleplayer, the player's death is equivalent to the end of the episode. In multiplayer, when the player is dead :meth:`respawn_player` method can be called.)DOCSTRING"; diff --git a/src/lib_python/ViZDoomPythonModule.cpp b/src/lib_python/ViZDoomPythonModule.cpp index 0bc41f56a..8d763a853 100644 --- a/src/lib_python/ViZDoomPythonModule.cpp +++ b/src/lib_python/ViZDoomPythonModule.cpp @@ -630,6 +630,7 @@ PYBIND11_MODULE(vizdoom, vz){ CLASS_FUNC_2_PYT_WITH_ARGS("new_episode", DoomGamePython::newEpisode, pyb::arg("recording_file_path") = "") CLASS_FUNC_2_PYT_WITH_ARGS("replay_episode", DoomGamePython::replayEpisode, pyb::arg("file_path"), pyb::arg("player") = 0) CLASS_FUNC_2_PYT("is_episode_finished", DoomGamePython::isEpisodeFinished) + CLASS_FUNC_2_PYT("is_episode_timeout_reached", DoomGamePython::isEpisodeTimeoutReached) CLASS_FUNC_2_PYT("is_new_episode", DoomGamePython::isNewEpisode) CLASS_FUNC_2_PYT("is_player_dead", DoomGamePython::isPlayerDead) CLASS_FUNC_2_PYT("respawn_player", DoomGamePython::respawnPlayer) From b49605a5c34b96274717bb0bccd4bb0995486f13 Mon Sep 17 00:00:00 2001 From: Marek Wydmuch Date: Mon, 12 Feb 2024 02:14:09 +0100 Subject: [PATCH 2/4] Update scenarios cfg files --- scenarios/basic.cfg | 4 ++-- scenarios/cig.cfg | 2 +- scenarios/deadly_corridor.cfg | 4 ++++ scenarios/deathmatch.cfg | 5 ++++- scenarios/defend_the_center.cfg | 4 ++-- scenarios/defend_the_line.cfg | 3 +-- scenarios/health_gathering.cfg | 2 +- scenarios/health_gathering_supreme.cfg | 2 +- scenarios/learning.cfg | 8 ++++++-- scenarios/multi.cfg | 1 - scenarios/multi_duel.cfg | 4 ++++ scenarios/my_way_home.cfg | 4 ++-- scenarios/predict_position.cfg | 4 ++-- scenarios/rocket_basic.cfg | 4 ++-- scenarios/simpler_basic.cfg | 8 ++++++-- scenarios/take_cover.cfg | 3 +++ 16 files changed, 41 insertions(+), 21 deletions(-) diff --git a/scenarios/basic.cfg b/scenarios/basic.cfg index 56438ae98..d9567433d 100644 --- a/scenarios/basic.cfg +++ b/scenarios/basic.cfg @@ -18,10 +18,10 @@ render_decals = false render_particles = false window_visible = true -# make episodes start after 20 tics (after unholstering the gun) +# Make episodes start after 20 tics (after unholstering the gun) episode_start_time = 14 -# make episodes finish after 300 actions (tics) +# Make episodes finish after 300 actions (tics) episode_timeout = 300 # Available buttons diff --git a/scenarios/cig.cfg b/scenarios/cig.cfg index fb02e77b1..cf6204c05 100644 --- a/scenarios/cig.cfg +++ b/scenarios/cig.cfg @@ -4,7 +4,7 @@ doom_scenario_path = cig.wad -#12 minutes +# Make episodes finish after 12 minutes episode_timeout = 25200 # Rendering options diff --git a/scenarios/deadly_corridor.cfg b/scenarios/deadly_corridor.cfg index 108a55407..0607cd46b 100644 --- a/scenarios/deadly_corridor.cfg +++ b/scenarios/deadly_corridor.cfg @@ -21,6 +21,10 @@ render_decals = false render_particles = false window_visible = true +# Make episodes start in the first tic +episode_start_time = 1 + +# Make episodes finish after 2100 actions (tics) episode_timeout = 2100 # Available buttons diff --git a/scenarios/deathmatch.cfg b/scenarios/deathmatch.cfg index 00fd7a8c0..ff0664c95 100644 --- a/scenarios/deathmatch.cfg +++ b/scenarios/deathmatch.cfg @@ -15,7 +15,10 @@ render_decals = false render_particles = false window_visible = true -# make episodes finish after 4200 actions (tics) +# Make episodes start in the first tic +episode_start_time = 1 + +# Make episodes finish after 4200 actions (tics) episode_timeout = 4200 # Available buttons diff --git a/scenarios/defend_the_center.cfg b/scenarios/defend_the_center.cfg index 3eaff70a4..ddae7533a 100644 --- a/scenarios/defend_the_center.cfg +++ b/scenarios/defend_the_center.cfg @@ -18,10 +18,10 @@ render_decals = false render_particles = false window_visible = true -# make episodes start after 10 tics (after unholstering the gun) +# Make episodes start after 10 tics (after unholstering the gun) episode_start_time = 10 -# make episodes finish after 2100 actions (tics) +# Make episodes finish after 2100 actions (tics) episode_timeout = 2100 # Available buttons diff --git a/scenarios/defend_the_line.cfg b/scenarios/defend_the_line.cfg index f323e4f54..d9a854408 100644 --- a/scenarios/defend_the_line.cfg +++ b/scenarios/defend_the_line.cfg @@ -18,10 +18,9 @@ render_decals = false render_particles = false window_visible = true -# make episodes start after 10 tics (after unholstering the gun) +# Make episodes start after 10 tics (after unholstering the gun) episode_start_time = 10 - # Available buttons available_buttons = { diff --git a/scenarios/health_gathering.cfg b/scenarios/health_gathering.cfg index d431ce669..ea710f973 100644 --- a/scenarios/health_gathering.cfg +++ b/scenarios/health_gathering.cfg @@ -19,7 +19,7 @@ render_decals = false render_particles = false window_visible = true -# make episodes finish after 2100 actions (tics) +# Make episodes finish after 2100 actions (tics) episode_timeout = 2100 # Available buttons diff --git a/scenarios/health_gathering_supreme.cfg b/scenarios/health_gathering_supreme.cfg index 5466f6c54..760d84a8b 100644 --- a/scenarios/health_gathering_supreme.cfg +++ b/scenarios/health_gathering_supreme.cfg @@ -19,7 +19,7 @@ render_decals = false render_particles = false window_visible = true -# make episodes finish after 2100 actions (tics) +# Make episodes finish after 2100 actions (tics) episode_timeout = 2100 # Available buttons diff --git a/scenarios/learning.cfg b/scenarios/learning.cfg index 97228a1db..e212afdc2 100644 --- a/scenarios/learning.cfg +++ b/scenarios/learning.cfg @@ -1,3 +1,7 @@ +# Lines starting with # are treated as comments (or with whitespaces+#). +# It doesn't matter if you use capital letters or not. +# It doesn't matter if you use underscore or camel notation for keys, e.g. episode_timeout is the same as episodeTimeout. + doom_scenario_path = basic.wad # Rewards @@ -13,10 +17,10 @@ render_decals = false render_particles = false window_visible = false -# make episodes start after 20 tics (after unholstering the gun) +# Make episodes start after 20 tics (after unholstering the gun) episode_start_time = 14 -# make episodes finish after 300 actions (tics) +# Make episodes finish after 300 actions (tics) episode_timeout = 300 # Available buttons diff --git a/scenarios/multi.cfg b/scenarios/multi.cfg index 75ee67349..e74449e57 100644 --- a/scenarios/multi.cfg +++ b/scenarios/multi.cfg @@ -18,7 +18,6 @@ render_particles = false window_visible = true - # Available buttons available_buttons = { diff --git a/scenarios/multi_duel.cfg b/scenarios/multi_duel.cfg index 3d4f6e2a5..37c3d9f4c 100644 --- a/scenarios/multi_duel.cfg +++ b/scenarios/multi_duel.cfg @@ -1,3 +1,7 @@ +# Lines starting with # are treated as comments (or with whitespaces+#). +# It doesn't matter if you use capital letters or not. +# It doesn't matter if you use underscore or camel notation for keys, e.g. episode_timeout is the same as episodeTimeout. + doom_scenario_path = multi_duel.wad screen_resolution = RES_320X240 diff --git a/scenarios/my_way_home.cfg b/scenarios/my_way_home.cfg index f13398092..c0b257f4b 100644 --- a/scenarios/my_way_home.cfg +++ b/scenarios/my_way_home.cfg @@ -18,10 +18,10 @@ render_decals = false render_particles = false window_visible = true -# make episodes start after 10 tics (after unholstering the gun) +# Make episodes start after 10 tics (after unholstering the gun) episode_start_time = 10 -# make episodes finish after 2100 actions (tics) +# Make episodes finish after 2100 actions (tics) episode_timeout = 2100 # Available buttons diff --git a/scenarios/predict_position.cfg b/scenarios/predict_position.cfg index 0bc456715..475e3bfce 100644 --- a/scenarios/predict_position.cfg +++ b/scenarios/predict_position.cfg @@ -18,10 +18,10 @@ render_decals = false render_particles = false window_visible = true -# make episodes start after 16 tics (after the rocket launcher is ready) +# Make episodes start after 16 tics (after the rocket launcher is ready) episode_start_time = 16 -# make episodes finish after 300 actions (tics) +# Make episodes finish after 300 actions (tics) episode_timeout = 300 # Available buttons diff --git a/scenarios/rocket_basic.cfg b/scenarios/rocket_basic.cfg index f872da3dc..5f0c2008f 100644 --- a/scenarios/rocket_basic.cfg +++ b/scenarios/rocket_basic.cfg @@ -12,10 +12,10 @@ render_weapon = true render_decals = false render_particles = false -# make episodes start after 14 tics (after unholstering the gun) +# Make episodes start after 14 tics (after unholstering the gun) episode_start_time = 14 -# make episodes finish after 300 actions (tics) +# Make episodes finish after 300 actions (tics) episode_timeout = 300 # Available buttons diff --git a/scenarios/simpler_basic.cfg b/scenarios/simpler_basic.cfg index c9be8e65f..7973d5537 100644 --- a/scenarios/simpler_basic.cfg +++ b/scenarios/simpler_basic.cfg @@ -1,3 +1,7 @@ +# Lines starting with # are treated as comments (or with whitespaces+#). +# It doesn't matter if you use capital letters or not. +# It doesn't matter if you use underscore or camel notation for keys, e.g. episode_timeout is the same as episodeTimeout. + doom_scenario_path = simpler_basic.wad # Rewards @@ -13,10 +17,10 @@ render_weapon = true render_decals = false render_particles = false -# make episodes start after 20 tics (after unholstering the gun) +# Make episodes start after 20 tics (after unholstering the gun) episode_start_time = 14 -# make episodes finish after 300 actions (tics) +# Make episodes finish after 300 actions (tics) episode_timeout = 300 # Available buttons diff --git a/scenarios/take_cover.cfg b/scenarios/take_cover.cfg index a9650a639..3ec06f38f 100644 --- a/scenarios/take_cover.cfg +++ b/scenarios/take_cover.cfg @@ -19,6 +19,9 @@ render_decals = false render_particles = false window_visible = true +# Make episodes start in the first tic +episode_start_time = 1 + # Available buttons available_buttons = { From c28126587615b1e46ee66428eb7c35069c7ab308 Mon Sep 17 00:00:00 2001 From: Marek Wydmuch Date: Mon, 12 Feb 2024 02:15:17 +0100 Subject: [PATCH 3/4] Add docs for the new is_episode_timeout_reached method --- docs/api/cpp/doomGame.md | 11 +++++++++++ docs/api/python/doomGame.md | 1 + 2 files changed, 12 insertions(+) diff --git a/docs/api/cpp/doomGame.md b/docs/api/cpp/doomGame.md index 4616164ca..08b63473a 100644 --- a/docs/api/cpp/doomGame.md +++ b/docs/api/cpp/doomGame.md @@ -179,6 +179,17 @@ Returns true if the current episode is in the terminal state (is finished). will take no effect after this point (unless [`newEpisode`](#newepisode) method is called). +--- +### `isEpisodeTimeoutReached` + +| C++ | `bool isEpisodeTimeoutReached()` | +| :-- | :-- | +| Python | `is_episode_timeout_reached() -> bool` | + +Returns true if the current episode is in the terminal state due to exceeding the time limit (timeout) +set with [`setEpisodeTimeout`](#setepisodetimeout) method or via `+timelimit` parameter. + + --- ### `isPlayerDead` diff --git a/docs/api/python/doomGame.md b/docs/api/python/doomGame.md index 7c51615c1..06cda30dc 100644 --- a/docs/api/python/doomGame.md +++ b/docs/api/python/doomGame.md @@ -24,6 +24,7 @@ DoomGame is the main object of the ViZDoom library, representing a single instan .. autofunction:: vizdoom.DoomGame.make_action .. autofunction:: vizdoom.DoomGame.is_new_episode .. autofunction:: vizdoom.DoomGame.is_episode_finished +.. autofunction:: vizdoom.DoomGame.is_episode_timeout_reached .. autofunction:: vizdoom.DoomGame.is_player_dead .. autofunction:: vizdoom.DoomGame.respawn_player .. autofunction:: vizdoom.DoomGame.send_game_command From 563a2a46cff9651440eb827cd376beb7c89a4970 Mon Sep 17 00:00:00 2001 From: Marek Wydmuch Date: Mon, 12 Feb 2024 02:17:37 +0100 Subject: [PATCH 4/4] Unified the docs filenames with outher Farama projects --- .../{configurationFiles.md => configuration_files.md} | 0 docs/api/cpp/{doomGame.md => doom_game.md} | 0 docs/api/cpp/{gameState.md => game_state.md} | 0 docs/api/python/{doomGame.md => doom_game.md} | 0 docs/api/python/{gameState.md => game_state.md} | 0 .../{creatingCustom.md => creating_custom.md} | 0 docs/environments/{thirdParty.md => third_party.md} | 0 docs/index.md | 10 +++++----- .../{apisAndWrappers.md => apis_and_wrappers.md} | 0 .../{pythonQuickstart.md => python_quickstart.md} | 0 scripts/create_python_docs_from_cpp_docs.py | 4 ++-- scripts/create_python_docstrings_from_cpp_docs.py | 2 +- 12 files changed, 8 insertions(+), 8 deletions(-) rename docs/api/{configurationFiles.md => configuration_files.md} (100%) rename docs/api/cpp/{doomGame.md => doom_game.md} (100%) rename docs/api/cpp/{gameState.md => game_state.md} (100%) rename docs/api/python/{doomGame.md => doom_game.md} (100%) rename docs/api/python/{gameState.md => game_state.md} (100%) rename docs/environments/{creatingCustom.md => creating_custom.md} (100%) rename docs/environments/{thirdParty.md => third_party.md} (100%) rename docs/introduction/{apisAndWrappers.md => apis_and_wrappers.md} (100%) rename docs/introduction/{pythonQuickstart.md => python_quickstart.md} (100%) diff --git a/docs/api/configurationFiles.md b/docs/api/configuration_files.md similarity index 100% rename from docs/api/configurationFiles.md rename to docs/api/configuration_files.md diff --git a/docs/api/cpp/doomGame.md b/docs/api/cpp/doom_game.md similarity index 100% rename from docs/api/cpp/doomGame.md rename to docs/api/cpp/doom_game.md diff --git a/docs/api/cpp/gameState.md b/docs/api/cpp/game_state.md similarity index 100% rename from docs/api/cpp/gameState.md rename to docs/api/cpp/game_state.md diff --git a/docs/api/python/doomGame.md b/docs/api/python/doom_game.md similarity index 100% rename from docs/api/python/doomGame.md rename to docs/api/python/doom_game.md diff --git a/docs/api/python/gameState.md b/docs/api/python/game_state.md similarity index 100% rename from docs/api/python/gameState.md rename to docs/api/python/game_state.md diff --git a/docs/environments/creatingCustom.md b/docs/environments/creating_custom.md similarity index 100% rename from docs/environments/creatingCustom.md rename to docs/environments/creating_custom.md diff --git a/docs/environments/thirdParty.md b/docs/environments/third_party.md similarity index 100% rename from docs/environments/thirdParty.md rename to docs/environments/third_party.md diff --git a/docs/index.md b/docs/index.md index baf907f24..fb48c44bc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -59,9 +59,9 @@ game.close() :hidden: :caption: Introduction -introduction/pythonQuickstart +introduction/python_quickstart introduction/building -introduction/apisAndWrappers +introduction/apis_and_wrappers ``` ```{toctree} @@ -70,7 +70,7 @@ introduction/apisAndWrappers api/python api/cpp -api/configurationFiles +api/configuration_files ``` ```{toctree} @@ -78,8 +78,8 @@ api/configurationFiles :caption: Environments environments/default -environments/thirdParty -environments/creatingCustom +environments/third_party +environments/creating_custom ``` ```{toctree} diff --git a/docs/introduction/apisAndWrappers.md b/docs/introduction/apis_and_wrappers.md similarity index 100% rename from docs/introduction/apisAndWrappers.md rename to docs/introduction/apis_and_wrappers.md diff --git a/docs/introduction/pythonQuickstart.md b/docs/introduction/python_quickstart.md similarity index 100% rename from docs/introduction/pythonQuickstart.md rename to docs/introduction/python_quickstart.md diff --git a/scripts/create_python_docs_from_cpp_docs.py b/scripts/create_python_docs_from_cpp_docs.py index c86a4542e..b1c11b206 100755 --- a/scripts/create_python_docs_from_cpp_docs.py +++ b/scripts/create_python_docs_from_cpp_docs.py @@ -5,8 +5,8 @@ FILES_TO_PARSE = [ { - "input_filepath": "docs/api/cpp/doomGame.md", - "output_filepath": "docs/api/python/doomGame.md", + "input_filepath": "docs/api/cpp/doom_game.md", + "output_filepath": "docs/api/python/doom_game.md", "submodule": "DoomGame.", "append_to_header": """ ```{eval-rst} diff --git a/scripts/create_python_docstrings_from_cpp_docs.py b/scripts/create_python_docstrings_from_cpp_docs.py index bcbf20afd..0c91df821 100755 --- a/scripts/create_python_docstrings_from_cpp_docs.py +++ b/scripts/create_python_docstrings_from_cpp_docs.py @@ -9,7 +9,7 @@ def camel_case_to_snake_case(text): FILES_TO_PARSE = [ - {"filepath": "docs/api/cpp/doomGame.md", "namespace": "DoomGamePython"}, + {"filepath": "docs/api/cpp/doom_game.md", "namespace": "DoomGamePython"}, {"filepath": "docs/api/cpp/utils.md"}, ] OUTPUT_FILE = "src/lib_python/ViZDoomMethodsDocstrings.h"