Metadata-Version: 2.1
Name: rory
Version: 0.3.4
Summary: Play along to MIDI files in console
Home-page: https://github.com/quintinfsmith/rory
Author: Quintin Smith
Author-email: smith.quintin@protonmail.com
License: GPL-2.0
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Operating System :: POSIX :: Linux
Requires-Python: ~=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# Rory
Learn Piano using MIDI files and a MIDI Keyboard<br/>
[![Travis (.com)](https://img.shields.io/travis/com/quintinfsmith/rory?style=flat-square)](https://travis-ci.com/github/quintinfsmith/rory)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/rory?style=flat-square)](https://pypi.org/project/rory/)
[![PyPI](https://img.shields.io/pypi/v/rory?style=flat-square)](https://pypi.org/project/rory/)
[![GitHub](https://img.shields.io/github/license/quintinfsmith/rory?style=flat-square)](https://github.com/quintinfsmith/rory/blob/master/LICENSE)

<img src="https://raw.githubusercontent.com/quintinfsmith/rory/master/res/sample.svg" />

## Installation
```bash
pip install rory
```

## Usage
```bash
rory path/to/midi.mid [-t steps_to_transpose]
```

The song will only scroll upon hitting the correct key combinations.
*indicators*
- red: 'wrong note'
- green: 'correct note', but there are others needed
- orange: 'correct note' but you need to release and press again.

### Controls
'q': Quit<br/>
'h': Bring up help window<br/>
'j': Next State<br/>
'k': Previous state<br/>
'[': set loop start<br/>
']': set loop end<br/>
'/': stop looping<br/>
[number] 'i': ignore channel [number]<br/>
[number] 'p': jump to state [number]<br/>

### Notes
- Terminal needs to be 106+ characters wide.
- I've generated some scale excercises in scales/*.mid



