Skip to content

Latest commit

 

History

History
57 lines (40 loc) · 1.68 KB

README.md

File metadata and controls

57 lines (40 loc) · 1.68 KB
Raw

Pyanoboard

Pyanoboard is a simple piano to keyboard emulator, allowing you to use any MIDI enabled device as a virtual keyboard.

Pyanoboard actually simulates key events rather than sending characters to be typed, which means you can use it for anything such as gaming and not just typing.

Installation

Either

  • Clone this repository and use the pyanoboard directory
    • You must have pygame installed
  • Install the package via pip pip install pyanoboard

Prerequisites

  • MIDI enabled device such as a digital piano
  • MIDI to USB cable
  • python
  • Windows

Usage

To use this package, enter

python -m pyanoboard config

Where config is the path to your configuration file using the JSON format. An example configuration file has been included under example/config.json

example config

{
    "device_id": 1,
    "bindings": [
        {
            "note": "C3",
            "key": "h"
        }
    ]
}

pyanoboard can also take the following arguments

Argument Meaning
-verbose Enables verbose logging
-devices Shows a list of the connected MIDI devices instead of starting pyanoboard

In order to find the device_id of your device, use the -devices argument

python -m pyanoboard -devices