Metadata-Version: 2.1
Name: asciiracer
Version: 0.1.1
Summary: A racing game that runs in terminal
Home-page: https://github.com/UpGado/ascii_racer
Author: Ahmed Gado
Author-email: ahmedehabg@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown

# ASCII RACER

[![PyPI version](https://badge.fury.io/py/asciiracer.svg)](https://badge.fury.io/py/asciiracer)

A racing game that runs in Terminal. 100% Python

<p align="center"><img src="https://raw.githubusercontent.com/UpGado/ascii_racer/master/docs/gameplay.gif" alt="ascii-racer"/></p>

## Instructions

Collect as many alcoholic drinks as possible, while avoiding the `Beer` drinks. The game is only key-based.

| Keys | Role        |
|------|-------------|
| a    | Move Left   |
| d    | Move Right  |
| w    | Accelerate  |
| s    |  Decelerate |
| q    |  Quit game  |

### How to set up?
Make sure you are running at least Python 3.6.0

Only dependency is `curses` module. Depending on your platform:
- Linux or Mac: you're all set, as it will be installed by default.
- Windows: you might have to run the game in Cygwin or a Windows Subsytem for Linux (WSL). Or you can try running `pip install windows-curses`

Install using pip:
```bash
pip3 install asciiracer
```
or clone the repository and install manually:

```bash
$ git clone https://github.com/UpGado/ascii_racer.git
$ python3 setup.py install
```

### Start Game
To start, run `python3 -m asciiracer` to begin the game

### Scoring
There are four different types of drinks that you can collect on the racetrack. 
* Vodka - 10 Points
* Gin - 5 Points
* $ - 1 Point
* Beer - Negative 20 points

### Contributions
If you encounter any problem or have any suggestions, please [open an issue](https://github.com/UpGado/ascii_racer/issues/new) or [send a PR](https://github.com/UpGado/ascii_racer/pulls).

ASCII-RACER is still in beta. If you are interested, contributions are highly welcome.


