Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
LabyStudio committed Jun 26, 2022
1 parent 8868c53 commit b3a9f16
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@ There are two types of modules:<br>
- <b>Mini Piano</b>: displays a simple piano keyboard for your Windows taskbar<br>
- <b>Piano Tutorial</b>: displays a bigger piano keyboard with a timeline of pressed keys<br>

## Installation
This addon requires the core application [DesktopModules](https://github.com/LabyStudio/desktopmodules)

You can download the addon jar file [here](https://github.com/LabyStudio/piano-addon/releases/) <br>
Put the built jar file into the following directory: ``C:/Users/<name>/AppData/Roaming/DesktopModules/addons/``<br>
And then you are ready to launch the core application.

### Configuration:
To set up your MIDI device, you have to enable it in ``devices``.<br>
If ``show_mini_piano_on_detect`` is set to true, the mini piano will enable itself once it detects a MIDI device.<br>
Expand All @@ -25,4 +32,7 @@ You can additionally broadcast the MIDI messages to your other applications by s
"port": 0
}
}
```
```

## Run in IDE
Launch the main class ``StartPiano``

0 comments on commit b3a9f16

Please sign in to comment.