Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thealphadollar/brkout

A game made using PyGame under CodeClub as a learning project.
https://github.com/thealphadollar/brkout

artwork design game-development physics-2d pip prison-break pygame python-packaging

Last synced: about 2 months ago
JSON representation

A game made using PyGame under CodeClub as a learning project.

Host: GitHub
URL: https://github.com/thealphadollar/brkout
Owner: thealphadollar
License: mit
Created: 2017-12-16T17:40:24.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2019-05-05T10:14:29.000Z (over 5 years ago)
Last Synced: 2024-10-11T20:16:31.014Z (2 months ago)
Topics: artwork, design, game-development, physics-2d, pip, prison-break, pygame, python-packaging
Language: Python
Size: 137 MB
Stars: 8
Watchers: 9
Forks: 19
Open Issues: 11
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

# BrkOut

[![forthebadge made-with-python](http://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/)

[![Gitter](https://img.shields.io/gitter/room/:user/:repo.svg)](https://gitter.im/brkout_/Lobby)

A prison escape game with a blend of brick breaking gameplay and innovative implementation of the same to get the look of an escape.

## Screenshots and Gameplay

When you decide to escape
![alt text](/game/assets/HomeScreen.png)

As you fight your way through the unbreakable wall
![alt text](/game/assets/MainGame.png)

You realise that escape might not be as easy as you thought
![alt text](/game/assets/LosingScreen.png)

And when you finally taste the free air after numerous attempts
![alt text](/game/assets/WinningScreen.png)

## Prerequisite

Python2 or Python 3 are the default languages needed for playing this game [on Linux], to check which version of Python you have, type the following in terminal:
```
python --version
```
## Downloading Brkout and Playing

You can use the below commands.

```
sudo apt-get install python-pip
pip install --upgrade pip
```
```
pip install brkout
```
If this does not work, then
```
sudo -H pip install brkout
```
For more info, visit [Pygame download page](http://www.pygame.org/download.shtml)

## Developing on the Game

### On Linux

1. Clone the branch on your local machine:
```
git clone https://github.com/thealphadollar/brkout.git
```
2. Install pipenv (`pip3 install pipenv`) and then install all dependencies (`pipenv install --dev`).
3. Make the required changes
4. Test the game by running `python3 -m game` from the repository's directory.
5. Send a Pull Request

### On Windows

1. Clone the repository by the method appropriate for the Git interface you are using.
2. Install Python 3.x
3. Install the future library
```
pip install future
```
4. Start the game using
```
python -m game
```
5. pip install any missing libraries
6. Always pull changes from the main repo before adding your changes
```
git pull upstream master
```
7. Create a new branch to work on feature
```
git branch
```
8. Make it the working branch
```
git checkout
```
9. Commit your changes
10. Merge your feature branch to the master branch when all the changes are done
```
git checkout master
git merge
```
11. Push your changes to your fork by
```
git push origin master
```
12. Create a new Pull Request on the main repo
13. Make any required changes
14. When the PR is merged, repeat #6 - #14

## Gameplay Help

1. The game can be controlled using arrows keys or the 'w', 'a', 's' and 'd' keys.
2. Spacebar and enter key both act as the selection key.
3. Spacebar or escape key can be used to pause the game.
4. Choose the required difficulty level by clicking on it.
5. Reset the highscore, if needed, by clicking on the 'reset' icon.
6. The game can also be played with a Joystick, which has to be plugged in before you
launch the game.It works well with AMKETTE game pad but any standard game pad would also work.

### Powerups

Currently 5 types of powerups are in the game. Go over a powerup to pick it up. Currently active powerups are shown in top left of the screen.

- Double Damage: Doubles the damge caused to bricks

![double_damage](https://user-images.githubusercontent.com/6888341/50610393-d2a1ad00-0ef8-11e9-87a1-3d9ad419bc1a.png)

- Double Power: Sriker's power is doubled

![double_power](https://user-images.githubusercontent.com/6888341/50610396-d7666100-0ef8-11e9-9fe9-e2f85d5839e3.png)

- Double Score: Score is doubled

![double_score](https://user-images.githubusercontent.com/6888341/50610400-da615180-0ef8-11e9-8b89-8388dc475af5.png)

- Double Speed: Ball's maximum speed is doubled

![double_speed](https://user-images.githubusercontent.com/6888341/50610404-ddf4d880-0ef8-11e9-9384-e570aebafc4e.png)

- No Friction: Friction is removed temporarily

![no_friction](https://user-images.githubusercontent.com/6888341/50610407-e0573280-0ef8-11e9-9c33-27492e236c54.png)

# Enjoy The Game

# Contribute

Please read CONTRIBUTING.md guide to know more.