https://github.com/imigueldiaz/hero-monsters-pygame
This is a fun experiment to learn PyGame by creating a simple game where a hero battles against monsters and collects coins.
https://github.com/imigueldiaz/hero-monsters-pygame
experiment game heroes ia learning-by-doing pygame pygame-games python3
Last synced: 7 months ago
JSON representation
This is a fun experiment to learn PyGame by creating a simple game where a hero battles against monsters and collects coins.
- Host: GitHub
- URL: https://github.com/imigueldiaz/hero-monsters-pygame
- Owner: imigueldiaz
- License: mit
- Created: 2024-09-21T06:03:52.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-29T07:05:22.000Z (12 months ago)
- Last Synced: 2024-10-29T08:17:55.511Z (12 months ago)
- Topics: experiment, game, heroes, ia, learning-by-doing, pygame, pygame-games, python3
- Language: Python
- Homepage:
- Size: 6.12 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/imigueldiaz/hero-monsters-pygame/actions/workflows/qodana_code_quality.yml) [](https://codecov.io/gh/imigueldiaz/hero-monsters-pygame) [](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html)
# Hero vs Monsters Game
This is a fun experiment to learn PyGame by creating a simple game where a hero battles against monsters and collects coins.
## Installation
1. **Clone the repository:**
```sh
git clone https://github.com/imigueldiaz/hero-monsters-pygame.git
cd hero-monsters-pygame
```
2. **Create a virtual environment (optional but recommended):**
```sh
python -m venv venv
source venv/bin/activate # On Windows use `venv\Scripts\activate`
```
3. **Install the required dependencies:**
```sh
pip install -r requirements.txt
```
## Usage
1. **Run the game:**
```sh
python run_game.py
```
2. **Controls:**
- **Left Arrow:** Move hero left
- **Right Arrow:** Move hero right
- **P:** Pause/Unpause the game
- **Space:** Restart the game after game over
- **Q or Escape:** Quit the game
## Building the executable
To build the executable, you need to have PyInstaller installed. It should be installed when you run `pip install -r requirements.txt`.
Then you only have to use the spec file to build the executable:
```sh
pyinstaller run_game.spec
```
you will find the executable in the `dist` folder.
### Tests and coverage
To run the tests, you can use the following command:
```sh
coverage run -m pytest
```
To generate the coverage report, you can use the following command:
```sh
coverage report -m
```
## Notes
The game is over when the hero collides with a monster or the hero falls off the screen. The hero can collect coins to increase the score. The game has a simple pause menu that can be accessed by pressing the "P" key.
Lots of improvements can be made to the game, such as adding more levels, different types of monsters, power-ups, etc.
> [!NOTE]
> One of the main goals of this project is to learn to write tests, learn coverage and how to use it, and CI/CD. This not a full game project, but a learning project. This project is only a fun experiment to learn PyGame. Feel free to explore, modify, and enhance the game as you like!. It's still a work in progress, and I'll continue to improve the game as I learn more about PyGame.