scenarios_spec_test.py

#!/usr/bin/env python3

#####################################################################
# This script presents how to run some scenarios.
# Configuration is loaded from "../../scenarios/<SCENARIO_NAME>.cfg" file.
# <episodes> number of episodes are played. 
# Random combination of buttons is chosen for every action.
# Game variables from state and last reward are printed.
#
# To see the scenario description go to "../../scenarios/README.md"
#####################################################################

from __future__ import print_function

import itertools as it
from random import choice
from time import sleep
import vizdoom as vzd
from argparse import ArgumentParser

DEFAULT_CONFIG = "./scenarios/basic.cfg"
if __name__ == "__main__":

    parser = ArgumentParser("ViZDoom scenarios example.")
    parser.add_argument(dest="config",
                        default=DEFAULT_CONFIG,
                        nargs="?",
                        help="Path to the configuration file of the scenario."
                             " Please see "
                             "./scenarios/*.cfg for more scenarios.")

    args = parser.parse_args()
    game = vzd.DoomGame()

    # load custom keybindings
    game.set_doom_config_path("./_vizdoom.ini")
    # Choose scenario config file you wish to watch.
    # Don't load two configs cause the second will overwrite the first one.
    # Multiple config files are ok but combining these ones doesn't make much sense.
    game.load_config(args.config)
    # Enables freelook in engine
    game.add_game_args("+freelook 1")

    # Sets other rendering options (all of these options except crosshair are enabled (set to True) by default)
    # game.set_render_hud(False)
    # game.set_render_minimal_hud(False)  # If hud is enabled
    game.set_render_crosshair(True)
    # game.set_render_weapon(True)
    # game.set_render_decals(False)  # Bullet holes and blood on the walls
    # game.set_render_particles(False)
    # game.set_render_effects_sprites(False)  # Smoke and blood
    # game.set_render_messages(False)  # In-game messages
    # game.set_render_corpses(False)
    # game.set_render_screen_flashes(True)  # Effect upon taking damage or picking up items

    # Makes the screen bigger to see more details.
    game.set_screen_resolution(vzd.ScreenResolution.RES_640X480)
    game.set_window_visible(True)
    game.set_mode(vzd.Mode.SPECTATOR)
    game.init()

    # Creates all possible actions depending on how many buttons there are.
    actions_num = game.get_available_buttons_size()
    actions = []
    for perm in it.product([False, True], repeat=actions_num):
        actions.append(list(perm))

    episodes = 1
    sleep_time = 0.028

    for i in range(episodes):
        print("Episode #" + str(i + 1))

        # Not needed for the first episode but the loop is nicer.
        game.new_episode()
        while not game.is_episode_finished():

            # Gets the state and possibly to something with it
            state = game.get_state()

            game.advance_action()
            a = game.get_last_action()
            r = game.get_last_reward()

            print("State #" + str(state.number))
            print("Game Variables:", state.game_variables)
            print("Last Action:", a)
            print("Last Reward:", r)
            print("=====================")

            # Sleep some time because processing is too fast to watch.
            if sleep_time > 0:
                sleep(sleep_time)

        print("Episode finished!")
        print("total reward:", game.get_total_reward())
        print("************************")