crayonix/tetri5
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: update readme

Browse Source
This commit is contained in:
Giovani
2021-07-10 14:20:00 -04:00
parent f363b943e3
commit a9527473a6
1 changed files with 16 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@@ -2,9 +2,18 @@
[![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)
The tetri5 project was created for the purpose of becoming familiar with Python 3. The goal is to replicate the most current version of Tetris (https://tetris.com/play-tetris) down to every mechanic. This includes the way pieces rotate and even newer features such as the ghost piece.
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 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
- [ ] Wall Kick
- [x] Next Piece
## Demo
@@ -14,11 +23,10 @@ The game was created using the pygame python library and builds on Github are pa
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 packages.
Then use the package manager [pip](https://pip.pypa.io/en/stable/) to install the required dependencies.
```bash
pip install pygame
pip install pyyaml
pip install -r requirements.txt
```
## Run the Game
@@ -37,3 +45,6 @@ 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/)