diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2017-06-10 12:26:57 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-06-10 12:26:57 -0400 |
| commit | 43b6179febfd25d6d9ce672c7303edff26f3c300 (patch) | |
| tree | 00c0ba26b4e068e810ba4ad52b7569d01607c81b /docs | |
| parent | 163754f363b4dd27f5433b251a9cce918106f02f (diff) | |
| parent | 1da0a19177effe3a946a5188c692fa8749a3a4f1 (diff) | |
| download | qmk_firmware-43b6179febfd25d6d9ce672c7303edff26f3c300.tar.gz qmk_firmware-43b6179febfd25d6d9ce672c7303edff26f3c300.zip | |
Merge branch 'master' into improve_macro_docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Modding-your-keyboard.md | 25 |
1 files changed, 17 insertions, 8 deletions
diff --git a/docs/Modding-your-keyboard.md b/docs/Modding-your-keyboard.md index 5d4b5d40f..2429570f5 100644 --- a/docs/Modding-your-keyboard.md +++ b/docs/Modding-your-keyboard.md | |||
| @@ -48,16 +48,25 @@ This is inside one of the macros. So when that macro executes, your keyboard pla | |||
| 48 | 48 | ||
| 49 | "Rest style" in the method signature above (the last parameter) specifies if there's a rest (a moment of silence) between the notes. | 49 | "Rest style" in the method signature above (the last parameter) specifies if there's a rest (a moment of silence) between the notes. |
| 50 | 50 | ||
| 51 | ## Music mode | ||
| 51 | 52 | ||
| 52 | ## Recording And Playing back Music | 53 | The music mode maps your columns to a chromatic scale, and your rows to octaves. This works best with ortholinear keyboards, but can be made to work with others. All keycodes less than `0xFF` get blocked, so you won't type while playing notes - if you have special keys/mods, those will still work. A work-around for this is to jump to a different layer with KC_NOs before (or after) enabling music mode. |
| 53 | * ```Music On``` - Turn music mode on. The default mapping is ```Lower+Upper+C``` | ||
| 54 | * ```LCTL``` - start a recording | ||
| 55 | * play some tones | ||
| 56 | * ```LALT``` - stop recording, stop playing | ||
| 57 | * ```LGUI``` - play recording | ||
| 58 | * ```LALT``` - stop playing | ||
| 59 | * ```Music Off``` - Turn music mode off. The default mapping is ```Lower+Upper+V``` | ||
| 60 | 54 | ||
| 55 | Recording is experimental due to some memory issues - if you experience some weird behavior, unplugging/replugging your keyboard will fix things. | ||
| 56 | |||
| 57 | Keycodes available: | ||
| 58 | |||
| 59 | * `MU_ON` - Turn music mode on | ||
| 60 | * `MU_OFF` - Turn music mode off | ||
| 61 | * `MU_TOG` - Toggle music mode | ||
| 62 | |||
| 63 | In music mode, the following keycodes work differently, and don't pass through: | ||
| 64 | |||
| 65 | * `LCTL` - start a recording | ||
| 66 | * `LALT` - stop recording/stop playing | ||
| 67 | * `LGUI` - play recording | ||
| 68 | * `KC_UP` - speed-up playback | ||
| 69 | * `KC_DOWN` - slow-down playback | ||
| 61 | 70 | ||
| 62 | ## MIDI functionalty | 71 | ## MIDI functionalty |
| 63 | 72 | ||
