Skip to content

Commit

Permalink
Readme updates (and feature disable)
Browse files Browse the repository at this point in the history
  • Loading branch information
vsicurella committed Jun 22, 2019
1 parent 0c5185d commit af1ffcd
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 9 deletions.
42 changes: 33 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,45 @@
# SuperVirtualKeyboard

LATEST VERSION: Alpha 2019-05-12 (Contact me for build)
LATEST VERSION: Alpha 2019-06-22 (Coming soon)

SUMMARY:

Super Virtual Keyboard is a MIDI-generating plugin that allows you to explore different keyboard layouts with the intention of making microtonal scales, particularly
larger ones, easier to digest and compose with. This is actually a subproject of a more generalized, larger project to offer many different ways to analyze scales.
larger ones, easier to digest and compose with.

FEATURES:

- -> This plugin does not yet offer retuning capabilities, so you will have to alter your synth's tuning. <-

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

- Hold "Shift" to hold down notes, "Alt" for "Mono Legato" mode, and "Space" to de/retrigger held notes.
- 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 "Up" & "Down" keys on held notes to transpose by one interval, or "Left" & "Right" keys to transpose by one modal step.
At this time, modal transposition is only possible if all held notes belong to the same mode (all white, all black, etc.)
- 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 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
- 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

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

- Hold "Shift" to hold down notes, "Alt" for "Mono Legato" mode, and "Space" to de/retrigger held notes.

- 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.
- * Temporarily Disabled * 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.

- Save and load your custom scales and key colors!

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

- Save and load your custom scales, midi mappings, and key colors!

TO DO:

Expand All @@ -35,10 +48,21 @@ TO DO:
- Add note names
- Set transposition parameters
- Graphics shading & other niceties
- more...
- 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 custom preset folder, browsable in plugin
- Add plugin and midi settings dialog windows
- Add MPE Tuning capability
- More...

BUGS:

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

2 changes: 2 additions & 0 deletions Source/UI/Components/KeyboardEditorBar.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,8 @@ KeyboardEditorBar::KeyboardEditorBar (SvkPluginState* pluginStateIn, Application


//[UserPreSize]
mapButton->setVisible(false);

presetLibraryBox->setMenu(*pluginState->presetManager->getPresetMenu());
presetLibraryBox->setEditableText(false);
presetLibraryBox->addListener(this);
Expand Down

0 comments on commit af1ffcd

Please sign in to comment.