Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/david-vandensteen/computer-key-to-midi

Last synced: 4 days ago
JSON representation

Host: GitHub
URL: https://github.com/david-vandensteen/computer-key-to-midi
Owner: David-Vandensteen
Created: 2021-12-16T11:05:46.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2023-09-13T06:05:56.000Z (about 1 year ago)
Last Synced: 2023-09-13T13:52:53.161Z (about 1 year ago)
Language: JavaScript
Size: 186 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
![Windows](https://img.shields.io/badge/platform-windows-lightgrey)
[![Node.js](https://img.shields.io/badge/Node.js-18.x-green.svg)](https://nodejs.org/en/download/)

# computer-key-to-midi
This project is a software that converts computer key inputs into MIDI inputs.
The software runs on node.js.

## Installation
To use this project, you will need to have Node.js and npm installed on your machine.
Once you have those installed, you can clone the repository and install the dependencies by running:
```
git clone https://github.com/David-Vandensteen/computer-key-to-midi.git
cd computer-key-to-midi
npm install
```

## Usage
The software can run in two modes, master and slave.
The master mode is used to send MIDI data to a device received from slave.

### Master mode
To run the software in master mode, you will need to specify the host and port, as well as the name of the MIDI output device you want to use.
You can use the command

```npm
npm run master -- -i -o -h -p
```

### Slave mode
To run the software in slave mode, you will need to specify the host and port of the master device.
You can use the command

```npm
npm run slave -- -h -p
```
You can also specify a configuration file with `--config `

### List MIDI devices
You can list all available MIDI inputs and outputs with the command
```
npm run start -- --list
```

### Configuration
The software can be configured through a YAML file.
The default configuration file is located in `src/model/mcc-1/config/default-fr.yaml` but you can specify your own with the `--config` option.

## License
This project is licensed under the MIT License.