# rescriptoon
TODO add description

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Last Release](https://img.shields.io/pypi/v/rescriptoon.svg)](https://pypi.org/project/rescriptoon/#history)
[![Python Version](https://img.shields.io/pypi/pyversions/rescriptoon.svg)](https://pypi.org/project/rescriptoon/)

## Installation

Compatible with X Window System (X11)

```sh
$ sudo apt-get install python3-xlib python3-psutil `# optional`
$ pip3 install --user --upgrade rescriptoon
```

## Usage

```sh
$ rescriptoon TODO
```

`rescriptoon --help` shows all available options.

While in the game press `` ` `` (grave) to enable extended controls.
Press `` ` `` again to disable.

```sh
$ rescriptoon --toggle slash
```

## Mappings

![default mapping](docs/extended-controls/default-mapping.svg)

(based on <https://en.wikipedia.org/wiki/File:Qwerty.svg>)

### Movement

| Key   | Action                          | Target Engine |
| ----- | ------------------------------- | ------------- |
| `     | turn Extended Controls on / off |               |
| w     | walk forward                    | 0             |
| s     | walk backward                   | 0             |
| a     | turn left                       | 0             |
| d     | turn right                      | 0             |
| v     | throw pie                       | 0             |
| i     | walk forward                    | 1             |
| k     | walk backward                   | 1             |
| j     | turn left                       | 1             |
| l     | turn right                      | 1             |
| /     | jump                            | 1             |
| n     | throw pie                       | 1             |
| space | jump                            | all           |

### Gag Selection

| Key   | Action                          | Target Engine |
| ----- | ------------------------------- | ------------- |
| e     | select elephant trunk in battle | 0             |
| o     | select elephant trunk in battle | 1             |
| f     | select fog in battle            | 0             |
| ;     | select fog in battle            | 1             |
