This repository contains code for the pygame game blockbuster. BlockBuster is an Arkanoid clone that generates levels from image input. BlockBuster gets its name from most of the levels being tile maps of popular movie screen shots the user gets to destroy with a ball and a paddle.
BlockBuster is a program written in Python 3. Pip3 is the default package installer that comes with python and therefore, it is required to install other dependencies for this program. For a step-by-step guide on installing pip3, there is a link here.
If you are on windows and need to install python3, download the python3 installation file.
If you are on ubuntu and need to install python3, it can be done with the command:
sudo apt-get install python3
After installing pip3, run the following command in the root directory of this project:
pip3 install --upgrade pip
pip3 install --user -r requirements.txt.
After the dependencies have been properly installed, use the following command to run the game.
python3 blockbuster.py
Or, if you are a windows user and python3 is not a recognized bash command, try using:
py -3 blockbuser.py
BlockBuster is a game that must be configured by editing the settings.py file located in the src directory. Primarily the user will need to edit the LEVEL parameter. This parameter is the image file that is converted into the level that the user plays. BlockBuster searches for this image in the input directory, also located in the src directory.
Some other notable settings can adjust the default height and width of the paddle with PADDLE_HEIGHT and PADDLE_WIDTH respectively. We can also edit the amount of lives the player starts with by adjusting the BALLS parameter. Furthermore we can adjust speed and size of the ball with BALL_SPEED and BALL_SIZE. We can also adjust the width and height of the window with the WIDTH and HEIGHT.
All of the values must be integer values and are measured in pixels, or if the variable is related to speed it is measured in pixels per frame.
In this project, pytest3 is used to test functionality of the game and associated files. In order to install pytest3 in Linux, use the following command to the terminal: sudo apt install python3-pytest. Afterwards, verify your installation by typing in pytest-3. If installed correctly, you shall be prompted that you did not enter enough arguments.
Afterwards there are two required installations used for linting. Linting is the process of following a style guide to make code easier to debug/lint. In this project, we use the PEP8 standards. In order to check for PEP8 python standards, we use two primary tools: Flake8 and autopep8.
They can be installed by using the following commands:
python3 -m pip install flake8 for flake8 installation
python3 -m pip install autopep8 for autopep8 installation
Then you can run flake8 to check your python files against a style guide with: flake8 <file_name>.py and then correct errors with autopep8 --in-place --aggressive <file_name>.py. A similar implementation checks all of BlockBuster.py with this linting tool in the tests directory.