Files
tetri5/README.md
2021-07-15 19:34:31 -04:00

55 lines
1.8 KiB
Markdown

<p align="center">
<img width="320" height="288" src="https://github.com/gio101046/tetri5/blob/main/resource/image/title_screen.png?raw=true">
</p>
[![Total alerts](https://img.shields.io/lgtm/alerts/g/gio101046/tetri5.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/gio101046/tetri5/alerts/)
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/gio101046/tetri5.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/gio101046/tetri5/context:python)
[![Trello](https://img.shields.io/badge/-Trello-blue?style=for-the-badge&logo=trello)](https://trello.com/b/3BxntLgZ/tetri5)
The tetri5 project was created for the purpose of becoming familiar with Python 3. The game was created using the pygame python library and builds on Github are packaged into one executable using cx_Freeze.
The goal is to implement the features of the current version of Tetris (https://tetris.com/play-tetris) and add some extra ones with a unique twist.
### Feature List
- [x] Rotate Right
- [ ] Rotate Left
- [x] Soft Drop
- [x] Hard Drop
- [x] Lock Delay
- [x] Wall Kick
- [x] Next Piece
## Demo
![gif](https://i.imgur.com/7QbL08C.gif)
## Requirements
Make sure you have installed Python 3. If you have not, download and install Python 3 at [python.org](https://www.python.org/downloads/).
Then use the package manager [pip](https://pip.pypa.io/en/stable/) to install the required dependencies.
```bash
pip install -r requirements.txt
```
## Run the Game
Clone the Github repository. From your terminal move to the root of the project and run the following line:
```bash
python main.py
```
In some systems you may need to run this instead:
```bash
python3 main.py
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## License
[MIT](https://choosealicense.com/licenses/mit/)