# KeyFlow

A MIDI effect that puts what you play into a scale, in real time.

## Overview

Pick a root and a scale, and KeyFlow moves every key you play onto it before it reaches
your instrument. Each key plays a different note of the scale, so unlike snap-to-scale
modes, two keys never play the same note.

## Choosing the keys

- **White keys**: the 7 white keys of each octave play the 7 notes of the scale, with
  middle C on the root. Every octave of keys is an octave of the scale. Black keys are silent.
- **Black keys**: the 5 black keys play a pentatonic scale the same way, with C# on the root.
- **All keys**: every key plays the next note of the scale up. Nothing is silent, but
  octaves no longer line up with the keyboard.

## Controls

- **Root**: any of the 12 notes
- **Scale**: Major, Minor, Dorian, Phrygian, Lydian, Mixolydian, Locrian, Harmonic Minor,
  Melodic Minor, Major Pentatonic, Minor Pentatonic, Blues, Phrygian Dominant, Hungarian Minor
- **Keys**: White, Black or All
- **Octave**: shifts everything from 3 octaves down to 3 up

The keyboard in KeyFlow's window shows the note each key plays and lights up as you play.
Click a key to hear it. Chords, velocity, sustain, pitch bend and other MIDI come through
as they are, and changing the scale while you hold a note won't leave it stuck.

## System Requirements

- macOS 10.15 or later, on Apple silicon or Intel
- Logic Pro, or another host that loads Audio Unit MIDI effects (KeyFlow.component)
- FL Studio, or another host that takes MIDI from VST3 instruments (KeyFlow.vst3)

## Installation

Please refer to the Installation.txt file in the Documentation folder.

## Support & Updates

- Email: stvdwell@gmail.com
- Website: https://stvdwell.com/keyflow/
- Support Development: https://ko-fi.com/stvdwell

## Version History

Version 1.1.0 (2026)
- A VST3 for FL Studio, which only passes MIDI on from VST plugins. It's an instrument
  with a silent audio output that sends the scale's notes to another instrument

Version 1.0.0 (2026)
- Initial release

## License

Copyright (c) 2026 Anton Savytski (stvdwell). All rights reserved.
See LICENSE.txt for full terms and conditions. The fonts KeyFlow uses are under the
SIL Open Font License; see the Fonts folder. KeyFlow is built with JUCE and contains
open-source libraries, listed with their licences in Third-party licenses.txt.

---
Created by Anton Savytski (stvdwell)
