Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vsicurella authored Aug 22, 2019
1 parent dda7fad commit bcde38f
Showing 1 changed file with 23 additions and 21 deletions.
44 changes: 23 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# SuperVirtualKeyboard

LATEST VERSION: Alpha 2019-08-03 (v0.02)
LATEST VERSION: Alpha 2019-08-22 (v0.021)

SUMMARY:

Expand All @@ -13,14 +13,17 @@ FEATURES:

- Select a scale from a large selection of mode presets then click the keys on the keyboard to play.

- Use the Mapping settings in the "Edit Note Mapping" dialog in the "Edit" menu to remap your midi piano keyboard to a microtonal scale.
- Use the mapping function to remap your midi piano keyboard to a microtonal scale.

- The first scale selection box represents what scale you're mapping from, which should be your hardware MIDI keyboard's layout. More often than not this will be Meantone[7] 12. The second scale is the scale you will be remapping to.

- Mapping "Mode to Mode" will put the scale's mode onto the diatonic keys (the "white keys") of your midi keyboard and approxmate closest degrees on the chromatic keys.
- Mapping "Mode to Mode" will map your MIDI keyboard's white keys to the white keys of the selected scale and will approxmate closest degrees on the chromatic keys.

- Mapping "Mode to Scale" will put the scale's mode onto your full chromatic midi keyboard. This if useful if your scale's mode size is equal to your midi keyboard's scale size
- Mapping "Mode to Scale" map your full chromatic MIDI keyboard to the selected scale's white keys. This if useful if your scale's mode size is equal to your midi keyboard's scale size
- for example, Meantone[12] 31 (in 31edo) works great on a standard midi keyboard
- Superpyth[12] 22 is quite interesting ;)
- Mapping "Mode by Order" will allow you to map a particular order of keys (order 0 = diatonic white keys, order 1 = pentatonic black keys) to a particular order of keys in your mode's scale

- Mapping "Mode by Order" will allow you to map a particular order of keys (order 0 = diatonic white keys, order 1 = pentatonic black keys) to a particular order of keys in the selected scale.

- If you don't have a midi controller, here are some features you can take advantage of:

Expand All @@ -29,42 +32,41 @@ FEATURES:
- Use "Up" & "Down" keys on held notes to transpose by one interval, or "Left" & "Right" keys to transpose by one modal step.

- Save your layout as a text file that Reaper can load as "MIDI Note Names" so that you can see the layout in Reaper's piano roll!

- Change the colors of the keys! Open up the color chooser from the Edit menu, select a color then click and use a modifier to paint the keys.
- No modifiers will paint all keys of the same scale degree
- Shift will paint all belonging to the same mode
- Control will only paint the clicked key.
- Right-clicking, with respective modifiers, resets the key to either the default mode or degree color.


- View and Edit information about your mode in the "View Mode Info" dialog in the "Edit" menu

- Save and load your custom scales and midi mappings!

New in version 0.02
** Disabled in v0.021 **
- Change the colors of the keys! Open up the color chooser from the Edit menu, select a color then click and use a modifier to paint the keys.
- No modifiers will paint all keys of the same scale degree
- Shift will paint all belonging to the same mode
- Control will only paint the clicked key.
- Right-clicking, with respective modifiers, resets the key to either the default mode or degree color.

New in version 0.021
- Updated GUI
- Custom mode folder scanning
- Saving/Importing both modes and presets
- MOS scales up through 23EDO
- Bug: Colors don't stay on the right keys the first time you set them, but should work after that
- MOS scales up through 23EDO, also 31EDO
- Bug: Ableton export is not yet implemented

TO DO:
- Add manual mapping
- Add note names
- Add MPE Tuning capability
- Add preset tags and improve preset browsing and management
- Customize key sizes and positions
- Change keyboard orientation
- Add note names
- Set transposition parameters
- Graphics shading & other niceties
- Have a complete selection of EDO MOS scales and include more detailed Mode info
- Add preset tags and improve preset browsing and management
- Allow piano keys to be treggered by computer keyboard keys
- Add preset slots to allow for automated scale switching
- Add MPE Tuning capability
- Allow piano keys to be triggered by computer keyboard keys
- More...

BUGS:
- Midi device doesn't get reconfigured when device settings change
- Window resizing is bad funky
- Mapping Mode by Order and setting offsets don't work as intended
- Learn manual mapping needs to be re-implemented
- More...

0 comments on commit bcde38f

Please sign in to comment.