README.md

Python examples

For the examples to work properly you need to install ViZDoom.

The list of examples

audio_buffer.py

Demonstrates how to use the audio buffer.

automap_buffer.py

Demonstrates how to use the automap buffer.

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.

buffers.py

Demonstrates all the visual buffers (screen buffer, depth buffer, labels buffer, map buffer) available in ViZDoom environment.

cig_multiplayer.py, cig_multiplayer_host.py

Demonstrates how to configure and play the multiplayer game for CIG competition.

cig_multiplayer_bots.py

Demonstrates how to play with bots to simulate the multiplayer game. Helpful for developing an AI agent for CIG competition.

cig_singleplayer.py, cig_multiplayer_host.py

Demonstrates how to configure and play the singleplayer game for CIG competition.

delta_buttons.py

Shows how delta buttons work (they may take values other than 0 and 1 and can be used for precise movement).

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.

gymnasium_wrapper.py

Shows how to use ViZDoom Gymnasium wrapper.

labels_buffer.py

Demonstrates how to use the labels buffer.

learning_pytorch.py, learning_pytorch_test.py

Contains an example of how to implement basic Q-learning on the interface within PyTorch.

learning_theano.py

Contains an example of how to implement basic Q-learning on the interface within Theano.

learning_tensorflow.py

Contains an example of how to implement basic Q-learning on the interface within Tensorflow.

multiple_instances.py, multiple_instances_advance.py

Contains an example of how to create a "server" and have multiple agents playing on the server at once. Combine with bots.py and learning_x.py to train agents against some AI

objects_and_sectors.py

Demonstrates how to access list of actors/objects and map geometry of the scenario.

pyoblige.py (level generator)

Contains an example of how to combine PyOblige with ViZDoom.

record_episodes.py

Demonstrates how to record an episode and replay it.

record_multiplayer.py

Demonstrates how to record the multiplayer game and replay it.

save_load_game.py

Demonstrates how to use save and load functionality build into the game engine.

scenarios.py

Presents different scenarios that come with ViZDoom environment.

seed.py

Shows how to run deterministic episodes by setting the seed. After setting the seed every episode will look the same (if the agent behaves deterministically).

shaping.py

Demonstrates how to make use of the game variables to implement shaping using health_guided.wad scenario.

spectator.py

Shows how to use the SPECTATOR mode in which YOU play Doom and AI is the spectator (intended for apprenticeship learning).

ticrate.py

Demonstrates how to use different ticrates in ASYNC mode.