aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2017-07-22 17:12:02 -0400
committerJack Humbert <jack.humb@gmail.com>2017-07-23 14:59:29 -0400
commit6bdf7482b151446c8b4e442de6fadb1395dc4dae (patch)
tree71ff911073b4b290243fb0de1be4d1d3d99034ea
parent415d38ba9ee20424ce354ed5f8e590fae58b863f (diff)
downloadqmk_firmware-6bdf7482b151446c8b4e442de6fadb1395dc4dae.tar.gz
qmk_firmware-6bdf7482b151446c8b4e442de6fadb1395dc4dae.zip
update audio/music documentation
-rw-r--r--docs/modding_your_keyboard.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/modding_your_keyboard.md b/docs/modding_your_keyboard.md
index ab40bdf93..5613bf525 100644
--- a/docs/modding_your_keyboard.md
+++ b/docs/modding_your_keyboard.md
@@ -12,6 +12,10 @@ AG_NORM_SONG // plays when you press AG_NORM (quantum.c)
12AG_SWAP_SONG // plays when you press AG_SWAP (quantum.c) 12AG_SWAP_SONG // plays when you press AG_SWAP (quantum.c)
13MUSIC_ON_SONG // plays when music mode is activated (process_music.c) 13MUSIC_ON_SONG // plays when music mode is activated (process_music.c)
14MUSIC_OFF_SONG // plays when music mode is deactivated (process_music.c) 14MUSIC_OFF_SONG // plays when music mode is deactivated (process_music.c)
15CHROMATIC_SONG // plays when the chromatic music mode is selected (process_music.c)
16GUITAR_SONG // plays when the guitar music mode is selected (process_music.c)
17VIOLIN_SONG // plays when the violin music mode is selected (process_music.c)
18MAJOR_SONG // plays when the major music mode is selected (process_music.c)
15``` 19```
16 20
17You can override the default songs by doing something like this in your `config.h`: 21You can override the default songs by doing something like this in your `config.h`:
@@ -55,6 +59,11 @@ Keycodes available:
55* `MU_ON` - Turn music mode on 59* `MU_ON` - Turn music mode on
56* `MU_OFF` - Turn music mode off 60* `MU_OFF` - Turn music mode off
57* `MU_TOG` - Toggle music mode 61* `MU_TOG` - Toggle music mode
62* `MU_MOD` - Cycle through the music modes:
63 * `CHROMATIC_MODE` - Chromatic scale, row changes the octave
64 * `GUITAR_MODE` - Chromatic scale, but the row changes the string (+5 st)
65 * `VIOLIN_MODE` - Chromatic scale, but the row changes the string (+7 st)
66 * `MAJOR_MODE` - Major scale
58 67
59In music mode, the following keycodes work differently, and don't pass through: 68In music mode, the following keycodes work differently, and don't pass through:
60 69
@@ -64,6 +73,12 @@ In music mode, the following keycodes work differently, and don't pass through:
64* `KC_UP` - speed-up playback 73* `KC_UP` - speed-up playback
65* `KC_DOWN` - slow-down playback 74* `KC_DOWN` - slow-down playback
66 75
76By default, `MUSIC_MASK` is set to `keycode < 0xFF` which means keycodes less than `0xFF` are turned into notes, and don't output anything. You can change this by defining this in your `config.h` like this:
77
78 #define MUSIC_MASK keycode != KC_NO
79
80Which will capture all keycodes - be careful, this will get you stuck in music mode until you restart your keyboard!
81
67## MIDI functionalty 82## MIDI functionalty
68 83
69This is still a WIP, but check out `quantum/keymap_midi.c` to see what's happening. Enable from the Makefile. 84This is still a WIP, but check out `quantum/keymap_midi.c` to see what's happening. Enable from the Makefile.