Update the examples

Author: mwydmuch

examples/python/README.md

@@ -7,6 +7,9 @@ For the examples to work properly you need to install ViZDoom or create a link t
 ### [audio_buffer.py](https://github.com/mwydmuch/ViZDoom/blob/master/examples/python/audio_buffer.py)
 Demonstrates how to use the audio buffer.
 
+### [automap_buffer.py](https://github.com/mwydmuch/ViZDoom/blob/master/examples/python/automap_buffer.py)
+Demonstrates how to use the automap buffer.
+
 ### [basic.py](https://github.com/mwydmuch/ViZDoom/blob/master/examples/python/basic.py)
 Demonstrates how to use the most basic features of the environment. It configures the engine, and makes the agent perform random actions. It also prints the current state and the reward earned with every action.
 
@@ -25,14 +28,14 @@ Demonstrates how to configure and play the singleplayer game for CIG competition
 ### [delta_buttons.py](https://github.com/mwydmuch/ViZDoom/blob/master/examples/python/delta_buttons.py)
 Shows how delta buttons work (they may take values other than 0 and 1 and can be used for precise movement).
 
-### [format.py](https://github.com/mwydmuch/ViZDoom/blob/master/examples/python/format.py)
-Presents different formats of the screen buffer. [OpenCV](http://opencv.org/) is used to display the images.
-
 ### [fps_test.py](https://github.com/mwydmuch/ViZDoom/blob/master/examples/python/fps_test.py)
 Tests the performance of the environment in frames per second. It should give you some idea how fast ViZDoom works on your hardware.
 
-### [labels.py](https://github.com/mwydmuch/ViZDoom/blob/master/examples/python/labels.py)
-Contains an example of how to implement basic Q-learning on the interface within PyTorch.
+### [gymnasium_wrapper.py](https://github.com/mwydmuch/ViZDoom/blob/master/examples/python/gymnasium_wrapper.py)
+Shows how to use ViZDoom Gymnasium wrapper.
+
+### [labels_buffer.py](https://github.com/mwydmuch/ViZDoom/blob/master/examples/python/labels_buffer.py)
+Demonstrates how to use the labels buffer.
 
 ### [learning_pytorch.py](https://github.com/mwydmuch/ViZDoom/blob/master/examples/python/learning_pytorch.py), [learning_pytorch_test.py](https://github.com/mwydmuch/ViZDoom/blob/master/examples/python/learning_pytorch_test.py)
 Contains an example of how to implement basic Q-learning on the interface within PyTorch.
@@ -58,6 +61,9 @@ Demonstrates how to record an episode and replay it.
 ### [record_multiplayer.py](https://github.com/mwydmuch/ViZDoom/blob/master/examples/python/record_multiplayer.py)
 Demonstrates how to record the multiplayer game and replay it.
 
+### [save_load_game.py](https://github.com/mwydmuch/ViZDoom/blob/master/examples/python/save_load_game.py)
+Demonstrates how to use save and load functionality build into the game engine.
+
 ### [scenarios.py](https://github.com/mwydmuch/ViZDoom/blob/master/examples/python/scenarios.py)
 Presents different scenarios that come with ViZDoom environment.
 

examples/python/audio_buffer.py

@@ -53,7 +53,7 @@
         print(
             "[ERROR] Could not launch ViZDoom. If you see an error above about BiquadFilter and gain,\n"
             "        try setting game.add_game_args('+snd_efx 0'). If that fails, see\n"
-            "        https://github.com/mwydmuch/ViZDoom/pull/486"
+            "        https://github.com/Farama-Foundation/ViZDoom/pull/486"
         )
         exit(1)
 
@@ -63,8 +63,10 @@
     episodes = 3
     audio_slices = []
     for i in range(episodes):
-        print("Episode #" + str(i + 1))
+        print(f"Episode #{i + 1}")
+
         game.new_episode()
+
         while not game.is_episode_finished():
 
             # Gets the state
@@ -87,10 +89,10 @@
         if audio_data.max() == 0:
             print(
                 "[WARNING] Audio buffers were full of silence. This is a common bug on e.g. Ubuntu 20.04\n"
-                "          See https://github.com/mwydmuch/ViZDoom/pull/486\n"
+                "          See https://github.com/Farama-Foundation/ViZDoom/pull/486\n"
                 "          Two possible fixes:\n"
                 "            1) Try setting game.add_game_args('+snd_efx 0'). This my disable some audio effects\n"
-                "            2) Try installing a newer version of OpenAL Soft library, see https://github.com/mwydmuch/ViZDoom/pull/486#issuecomment-889389185"
+                "            2) Try installing a newer version of OpenAL Soft library, see https://github.com/Farama-Foundation/ViZDoom/pull/486#issuecomment-889389185"
             )
         # Save audio file
         wavfile.write("basic_sounds.wav", 22050, np.concatenate(audio_slices, axis=0))

examples/python/automap.py renamed to examples/python/automap_buffer.py

@@ -68,7 +68,7 @@
     sleep_time = 28
 
     for i in range(episodes):
-        print("Episode #" + str(i + 1))
+        print(f"Episode #{i + 1}")
         seen_in_this_episode = set()
 
         # Not needed for the first episode but the loop is nicer.
@@ -87,7 +87,7 @@
 
             game.make_action(choice(actions))
 
-            print("State #" + str(state.number))
+            print(f"State #{state.number}")
             print(
                 "Player position X:",
                 state.game_variables[0],

examples/python/basic.py

@@ -139,7 +139,7 @@
     sleep_time = 1.0 / vzd.DEFAULT_TICRATE  # = 0.028
 
     for i in range(episodes):
-        print("Episode #" + str(i + 1))
+        print(f"Episode #{i + 1}")
 
         # Starts a new episode. It is not needed right after init() but it doesn't cost much. At least the loop is nicer.
         game.new_episode()
@@ -187,7 +187,7 @@
             # r = game.get_last_reward()
 
             # Prints state's game variables and reward.
-            print("State #" + str(n))
+            print(f"State #{n}")
             print("Game variables:", vars)
             print("Reward:", r)
             print("=====================")

examples/python/buffers.py

@@ -89,7 +89,7 @@
     sleep_time = 0.028
 
     for i in range(episodes):
-        print("Episode #" + str(i + 1))
+        print(f"Episode #{i + 1}")
 
         # Not needed for the first episode but the loop is nicer.
         game.new_episode()
@@ -126,7 +126,7 @@
 
             game.make_action(choice(actions))
 
-            print("State #" + str(state.number))
+            print(f"State #{state.number}")
             print("=====================")
 
         print("Episode finished!")

examples/python/cig_multiplayer.py

@@ -60,11 +60,11 @@
     frags = game.get_game_variable(vzd.GameVariable.FRAGCOUNT)
     if frags != last_frags:
         last_frags = frags
-        print("Player " + str(player_number) + " has " + str(frags) + " frags.")
+        print(f"Player {player_number} has {frags} frags.")
 
     # Check if player is dead
     if game.is_player_dead():
-        print("Player " + str(player_number) + " died.")
+        print(f"Player {player_number} died.")
         # Use this to respawn immediately after death, new state will be available.
         game.respawn_player()
 

examples/python/cig_multiplayer_bots.py

@@ -57,7 +57,7 @@
 
 for i in range(episodes):
 
-    print("Episode #" + str(i + 1))
+    print(f"Episode #{i + 1}")
 
     # Add specific number of bots
     # (file examples/bots.cfg must be placed in the same directory as the Doom executable file,
@@ -79,7 +79,7 @@
         frags = game.get_game_variable(vzd.GameVariable.FRAGCOUNT)
         if frags != last_frags:
             last_frags = frags
-            print("Player has " + str(frags) + " frags.")
+            print(f"Player has {frags} frags.")
 
         # Check if player is dead
         if game.is_player_dead():
@@ -94,11 +94,7 @@
     server_state = game.get_server_state()
     for i in range(len(server_state.players_in_game)):
         if server_state.players_in_game[i]:
-            print(
-                server_state.players_names[i]
-                + ": "
-                + str(server_state.players_frags[i])
-            )
+            print(f"{server_state.players_names[i]}: {server_state.players_frags[i]}")
     print("************************")
 
     # Starts a new episode. All players have to call new_episode() in multiplayer mode.

examples/python/cig_singleplayer.py

@@ -52,7 +52,7 @@
             # Use this to respawn immediately after death, new state will be available.
             game.respawn_player()
 
-        print("State #" + str(state.number))
+        print(f"State #{state.number}")
         print("Game variables: ", state.game_variables)
         print("Action:", last_action)
         print("Reward:", reward)

examples/python/cig_singleplayer_host.py

@@ -90,7 +90,7 @@
         last_action = game.get_last_action()
         reward = game.get_last_reward()
 
-        print("State #" + str(state.number))
+        print(f"State #{state.number}")
         print("Game variables: ", state.game_variables)
         print("Action:", last_action)
         print("Reward:", reward)

examples/python/delta_buttons.py

@@ -40,7 +40,7 @@
     sleep_time = 0.028
 
     for i in range(episodes):
-        print("Episode #" + str(i + 1))
+        print(f"Episode #{i + 1}")
 
         game.new_episode()
 
@@ -57,7 +57,7 @@
             if not time % 50:
                 action[3] = -action[3]
 
-            print("State #" + str(state.number))
+            print(f"State #{state.number}")
             print("Action made: ", action)
             print("=====================")
 

examples/python/labels_buffer.py

@@ -101,7 +101,8 @@ def color_labels(labels):
         return tmp
 
     for i in range(episodes):
-        print("Episode #" + str(i + 1))
+        print(f"Episode #{i + 1}")
+
         seen_in_this_episode = set()
 
         # Not needed for the first episode but the loop is nicer.
@@ -147,7 +148,7 @@ def color_labels(labels):
             # Make random action
             game.make_action(choice(actions))
 
-            print("State #" + str(state.number))
+            print(f"State #{state.number}")
             print(
                 "Player position: x:",
                 state.game_variables[0],

examples/python/learning_pytorch.py

@@ -113,7 +113,7 @@ def run(game, agent, actions, num_epochs, frame_repeat, steps_per_epoch=2000):
         game.new_episode()
         train_scores = []
         global_step = 0
-        print("\nEpoch #" + str(epoch + 1))
+        print(f"\nEpoch #{epoch + 1}")
 
         for _ in trange(steps_per_epoch, leave=False):
             state = preprocess(game.get_state().screen_buffer)

examples/python/multiple_instances.py

@@ -11,22 +11,27 @@
 # Run this many episodes
 episodes = 1
 config = os.path.join(vzd.scenarios_path, "multi_duel.cfg")
+win_x = 100
+win_y = 100
 
 
 def player1():
     game = vzd.DoomGame()
 
     game.load_config(config)
+
+    # Setup 2 players deathmatch game that will time out after 1 minute
     game.add_game_args("-host 2 -deathmatch +timelimit 1 +sv_spawnfarthest 1")
-    game.add_game_args("+name Player1 +colorset 0")
+
+    # Use additional arguments to set player name, color and window position
+    game.add_game_args(f"+name Player1 +colorset 0 +win_x {win_x} +win_y {win_y}")
 
     game.init()
 
     actions = [[True, False, False], [False, True, False], [False, False, True]]
 
     for i in range(episodes):
-
-        print("Episode #" + str(i + 1))
+        print(f"Episode #{i + 1}")
 
         while not game.is_episode_finished():
             if game.is_player_dead():
@@ -47,8 +52,14 @@ def player2():
     game = vzd.DoomGame()
 
     game.load_config(config)
+
+    # Join existing game
     game.add_game_args("-join 127.0.0.1")
-    game.add_game_args("+name Player2 +colorset 3")
+
+    # Use additional arguments to set player name, color and window position
+    game.add_game_args(
+        f"+name Player2 +colorset 3 +win_x {win_x + game.get_screen_width()} +win_y {win_y}"
+    )
 
     game.init()
 

examples/python/multiple_instances_advance.py

@@ -17,6 +17,8 @@
 episodes = 1
 timelimit = 1  # minutes
 players = 8  # number of players
+win_x = 100
+win_y = 100
 
 skip = 4
 mode = vzd.Mode.PLAYER  # or Mode.ASYNC_PLAYER
@@ -65,13 +67,14 @@ def player_action(game, player_sleep_time, actions, player_skip):
 
 def player_host(p):
     game, actions = setup_player()
+
+    # Setup multiplayer deathmatch game for {p} players that will time out after {timelimit} minutes
     game.add_game_args(
-        "-host "
-        + str(p)
-        + " -netmode 0 -deathmatch +timelimit "
-        + str(timelimit)
-        + " +sv_spawnfarthest 1 +name Player0 +colorset 0"
+        f"-host {p} -netmode 0 -deathmatch +timelimit {timelimit} +sv_spawnfarthest 1"
     )
+    # Use additional arguments to set player name, color and window position
+    game.add_game_args(f"+name Player0 +colorset 0 +win_x {win_x} +win_y {win_y}")
+    # Add additional arguments
     game.add_game_args(args)
 
     game.init()
@@ -81,7 +84,7 @@ def player_host(p):
     player_skip = skip
 
     for i in range(episodes):
-        print("Episode #" + str(i + 1))
+        print(f"Episode #{i + 1}")
         episode_start_time = None
 
         while not game.is_episode_finished():
@@ -100,10 +103,8 @@ def player_host(p):
         player_count = int(game.get_game_variable(vzd.GameVariable.PLAYER_COUNT))
         for i in range(1, player_count + 1):
             print(
-                "Host: Player" + str(i) + ":",
-                game.get_game_variable(
-                    eval("vzd.GameVariable.PLAYER" + str(i) + "_FRAGCOUNT")
-                ),
+                f"Host: Player{i}:",
+                game.get_game_variable(eval(f"vzd.GameVariable.PLAYER{i}_FRAGCOUNT")),
             )
         print("Host: Episode processing time:", time() - episode_start_time)
 
@@ -115,7 +116,14 @@ def player_host(p):
 
 def player_join(p):
     game, actions = setup_player()
-    game.add_game_args("-join 127.0.0.1 +name Player" + str(p) + " +colorset " + str(p))
+
+    # Join existing game
+    game.add_game_args("-join 127.0.0.1")
+    # Use additional arguments to set player name, color and window position
+    game.add_game_args(
+        f"+name Player{p} +colorset 0 +win_x {win_x + p % 4 * game.get_screen_width()} +win_y {win_y + p // 4 * game.get_screen_height()} "
+    )
+    # Add additional arguments
     game.add_game_args(args)
 
     game.init()
@@ -129,7 +137,7 @@ def player_join(p):
         while not game.is_episode_finished():
             state = game.get_state()
             print(
-                "Player" + str(p) + ":",
+                f"Player{p}:",
                 state.number,
                 action_count,
                 game.get_episode_time(),
@@ -138,7 +146,7 @@ def player_join(p):
             action_count += 1
 
         print(
-            "Player" + str(p) + " frags:",
+            f"Player{p} frags:",
             game.get_game_variable(vzd.GameVariable.FRAGCOUNT),
         )
         game.new_episode()

examples/python/objects_and_sectors.py

@@ -61,7 +61,7 @@
     sleep_time = 1.0 / vzd.DEFAULT_TICRATE  # = 0.028
 
     for i in range(episodes):
-        print("Episode #" + str(i + 1))
+        print(f"Episode #{i + 1}")
 
         # Not needed for the first episode but the loop is nicer.
         game.new_episode()
@@ -71,7 +71,7 @@
             state = game.get_state()
             game.make_action(choice(actions))
 
-            print("State #" + str(state.number))
+            print(f"State #{state.number}")
             print(
                 "Player position: x:",
                 state.game_variables[0],

examples/python/pyoblige.py

@@ -116,7 +116,7 @@
             last_action = game.get_last_action()
             reward = game.get_last_reward()
 
-            print("State #" + str(state.number))
+            print(f"State #{state.number}")
             print("Game variables: ", state.game_variables)
             print("Action:", last_action)
             print("Reward:", reward)