This repo is a top-down tank shooter game designed with PyGame. Players can play against enemy tanks who possess basic decision making ability. The next phase will focus on using reinforcement learning to give the enemy tanks better decision making abilities.
This repo was built with python version 3.10.8. The only package outside the standard packages required for this repo are:
- pygame version 2.1.2
- numpy version 1.22. (needed for the A* algorithm)
- gym version 0.21.0
The requirements.txt allows the user to create an environment with this package by running the command: python3 -m pip install -r requirements.txt
The goal of the game is to get more points than your opponent without running out of life within the time limit. Each game currently runs for 2 minutes with a count down timer shown in the upper right of the screen. The current score for red and blue is shown in the upper left.
Players are the blue tank and the computer controls the red tank. To control the blue tank, use the following commands:
- Left arrow or "a" key = Rotate left
- Right arrow or "d" key = Rotate right
- Up arrow or "w" key = Move ahead
- Down arrow or "s" key = Move backward (backward speed is half the forward speed)
- Space bar = Shoot a bullet
- Return = Lay a mine
The player and computer player start with 10 bullets and 5 mines. Each bullet or mine hit remove 1 point of life. Mines last for 5 seconds once they are placed down. After the elapsed 5 seconds they disappear from play. Mines are represented by small squares which are the same color as the tank with placed them. The current bullet and mine inventory for both players is shown at the bottom of the screen. These settings can be changed in the settings.py file.
Players or the cpu player gains 1 point for each bullet or mine hit. Players also gain 3 points from touching the "goal": . Once the goal is touched by a tank, it will move to a random open location on the board that is at least 100 units away from any tank.
During game play, players or the cpu player can regain 3 points of life by touching the "medical kits": . Players can also replenish 5 bullets by touching the . Once the health or ammo pack are touched they will disappear and be unavailable for 3 seconds for health or 5 seconds for ammo. These settings can be changed in the settings.py file
This repo contains the following folders and files:
-
tank_game : Run this file to play the game. This controls the pygame game flow.
-
tank_gym : Creates a Gym environment for training a RL agent to play the tank_game.
-
Tools: This folder contains several classes and methods used in the main script.
- sprites.py has classes for all the sprites used in the game such as the player tank, cpu-controlled red tank, goal, health kit, etc.
- data_loader.py has methods to load the map, images, and settings.
- helper_methods.py has methods used in multiple scripts.
- A_Star.py implements the A* algorithm to find the shortest path between two points. This is used by the cpu-controlled red tank to find the shortest path to the player tank, health kits, or ammo kits.
-
Images : Images used in this Readme file
- GameImages: Has the png files used for all images in the game. This is a subset of the full kenney image pack below.
- Kenney_topdowntankredux Has the full set of original images from the kenney_website.
-
Config - Folder for the map files and settings.
- map.txt map file which is loaded before play. Each "1" is a wall. Each "." is an open square of size (24x24) (size set in the settings.py file.). The player starts at the "P" location and the red tank(s) start at the "M" locations. Health packs are located at "H" and ammo at "A".
- map_complex.txt is a large map which can be used. To use this map, change the setting in the settings.py file.
- settings.py is a python script with all preset settings. This is loaded by all scripts in the repo for reference.
-
requirements.py - list of python packages required to run the scripts in this repo.
Initial code based on examples from: kids_can_code
A star code from: Andrew Jones. "Applying the A* Path Finding Algorithm in Python (Part 1: 2D square grid)", 14 Sept 2018, accessed 20 Dec 2022. link
Game images from : kenney_topdown-tanks-redux