chore: add improved readme

This commit is contained in:
2021-07-19 22:25:30 -04:00
parent 4e873cd792
commit 35ef220aff

101
README.md
View File

@@ -1,50 +1,89 @@
<p align="center">
<h1 align="center">
<br>
<img width="320" height="288" src="https://github.com/gio101046/tetri5/blob/main/resource/image/title_screen.png?raw=true">
<br>
</h1>
<h4 align="center">A full featured tetris-like game using python's <a href="https://www.pygame.org/wiki/about" target="_blank">pygame</a> library.</h4>
<p align="center">
<a target="_blank" href="https://lgtm.com/projects/g/gio101046/tetri5/alerts/">
<img src="https://img.shields.io/lgtm/alerts/g/gio101046/tetri5.svg?logo=lgtm&logoWidth=18"
alt="looks good to me">
</a>
<a target="_blank" href="https://lgtm.com/projects/g/gio101046/tetri5/context:python">
<img src="https://img.shields.io/lgtm/grade/python/g/gio101046/tetri5.svg?logo=lgtm&logoWidth=18"></a>
<a target="_blank" href="https://trello.com/b/3BxntLgZ/tetri5">
<img src="https://img.shields.io/badge/-Trello-blue?logo=trello">
</a>
<!-- <a target="_blank" href="https://saythanks.io/to/giovaniluisrodriguez@gmail.com">
<img src="https://img.shields.io/badge/SayThanks.io-%E2%98%BC-1EAEDB.svg">
</a> -->
</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)
<br>
<br>
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.
<p align="center">
<a href="#key-features">Key Features</a> •
<a href="#how-to-play">How To Play</a> •
<a href="#download">Download</a> •
<!-- <a href="#credits">Credits</a> • -->
<a href="#contributing">Contributing</a> •
<a href="#license">License</a>
</p>
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.
<p align="center">
<img src="https://i.imgur.com/7QbL08C.gif" alt="tetri5 demo">
</p>
### Feature List
- [x] Rotate Right
- [ ] Rotate Left
- [x] Soft Drop
- [x] Hard Drop
- [x] Lock Delay
- [x] Wall Kick
- [x] Next Piece
## Key Features
## Demo
##### Single Player Mode
Play a game against yourself where the goal is to accumalate as many points as you can! As you complete more lines the pieces will start to fall faster. Try and complete multiple lines at once for a higher score.
![gif](https://i.imgur.com/7QbL08C.gif)
##### Multiplayer Mode (Online)
Play a game against a friend online where the first one to fill up their well looses!
## Requirements
##### Game Mechanics
- [x] Rotate Right - Rotate piece clockwise
- [ ] Rotate Left - Rotate piece counter-clockwise
- [x] Soft Drop - Speed up a piece's downward motion
- [x] Hard Drop - Drop a piece on the stack with no delay
- [x] Lock Delay - The grace period before a piece locks on the stack
- [x] Wall Kick - Push a piece off the wall in a rotation if space does not allow
- [x] Next Piece- Show a user the next piece to enter the well
Make sure you have installed Python 3. If you have not, download and install Python 3 at [python.org](https://www.python.org/downloads/).
## How to Play
Then use the package manager [pip](https://pip.pypa.io/en/stable/) to install the required dependencies.
##### Controls
- ⬆️ Rotate
- ⬅️ Move Left
- ➡️ Move Right
- ⬇️ Soft Drop
- [Space] Hard Drop
##### Multiplater
After selecting `2 PLAYER` at the title screen you will be prompted to enter a Game ID. This ID can be any 6 characters that both players agree on. Once both players have entered their Game ID the game will start.
## Download
You can download the latest build for your system by going [here](https://github.com/gio101046/tetri5/releases).
If you would like to run the game by cloning this repository, you'll need [Git](https://git-scm.com/) and [Python 3](https://www.python.org/) installed on your system. From your command line:
```bash
pip install -r requirements.txt
```
# clone this repository
$ git clone https://github.com/gio101046/tetri5.git
## Run the Game
# move into project directory
$ cd tetri5
Clone the Github repository. From your terminal move to the root of the project and run the following line:
# install python dependencies using pip
$ pip install -r requirements.txt
```bash
python main.py
```
In some systems you may need to run this instead:
```bash
python3 main.py
# run the game
$ python main.py
```
## Contributing