aboutsummaryrefslogtreecommitdiff
path: root/docs/quantum_keycodes.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/quantum_keycodes.md')
-rw-r--r--docs/quantum_keycodes.md26
1 files changed, 13 insertions, 13 deletions
diff --git a/docs/quantum_keycodes.md b/docs/quantum_keycodes.md
index e9edad03e..a59d8fbc8 100644
--- a/docs/quantum_keycodes.md
+++ b/docs/quantum_keycodes.md
@@ -4,7 +4,7 @@ All keycodes within quantum are numbers between `0x0000` and `0xFFFF`. Within yo
4 4
5On this page we have documented keycodes between `0x00FF` and `0xFFFF` which are used to implement advanced quantum features. If you define your own custom keycodes they will be put into this range as well. Keycodes above `0x00FF` may not be used with any of the mod/layer-tap keys listed 5On this page we have documented keycodes between `0x00FF` and `0xFFFF` which are used to implement advanced quantum features. If you define your own custom keycodes they will be put into this range as well. Keycodes above `0x00FF` may not be used with any of the mod/layer-tap keys listed
6 6
7# Quantum keycodes 7## QMK keycodes
8 8
9|Name|Description| 9|Name|Description|
10|----|-----------| 10|----|-----------|
@@ -18,7 +18,7 @@ On this page we have documented keycodes between `0x00FF` and `0xFFFF` which are
18|`M(n)`|to call macro n| 18|`M(n)`|to call macro n|
19|`MACROTAP(n)`|to macro-tap n idk FIXME| 19|`MACROTAP(n)`|to macro-tap n idk FIXME|
20 20
21# Bootmagic Keycodes 21## Bootmagic Keycodes
22 22
23Shortcuts for bootmagic options (these work even when bootmagic is off.) 23Shortcuts for bootmagic options (these work even when bootmagic is off.)
24 24
@@ -44,7 +44,7 @@ Shortcuts for bootmagic options (these work even when bootmagic is off.)
44|`MAGIC_UNSWAP_ALT_GUI`/`AG_NORM`|Disable the Alt/GUI switching| 44|`MAGIC_UNSWAP_ALT_GUI`/`AG_NORM`|Disable the Alt/GUI switching|
45|`MAGIC_TOGGLE_NKRO`|Turn NKRO on or off| 45|`MAGIC_TOGGLE_NKRO`|Turn NKRO on or off|
46 46
47# Audio 47## Audio
48 48
49```c 49```c
50#ifdef AUDIO_ENABLE 50#ifdef AUDIO_ENABLE
@@ -69,7 +69,7 @@ Shortcuts for bootmagic options (these work even when bootmagic is off.)
69#endif 69#endif
70``` 70```
71 71
72## Midi 72### Midi
73 73
74#if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_BASIC)) 74#if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))
75 MI_ON, // send midi notes when music mode is enabled 75 MI_ON, // send midi notes when music mode is enabled
@@ -157,7 +157,7 @@ MI_MODSD, // decrease modulation speed
157MI_MODSU, // increase modulation speed 157MI_MODSU, // increase modulation speed
158#endif // MIDI_ADVANCED 158#endif // MIDI_ADVANCED
159 159
160# Backlight 160## Backlight
161 161
162These keycodes control the backlight. Most keyboards use this for single color in-switch lighting. 162These keycodes control the backlight. Most keyboards use this for single color in-switch lighting.
163 163
@@ -171,7 +171,7 @@ These keycodes control the backlight. Most keyboards use this for single color i
171|`BL_TOGG`|Toggle the backlight on or off| 171|`BL_TOGG`|Toggle the backlight on or off|
172|`BL_STEP`|Step through backlight levels, wrapping around to 0 when you reach the top.| 172|`BL_STEP`|Step through backlight levels, wrapping around to 0 when you reach the top.|
173 173
174# RGBLIGHT WS2818 LEDs 174## RGBLIGHT WS2818 LEDs
175 175
176This controls the `RGBLIGHT` functionality. Most keyboards use WS2812 (and compatible) LEDs for underlight or case lighting. 176This controls the `RGBLIGHT` functionality. Most keyboards use WS2812 (and compatible) LEDs for underlight or case lighting.
177 177
@@ -203,7 +203,7 @@ This is used when multiple keyboard outputs can be selected. Currently this only
203|`OUT_USB`|usb only| 203|`OUT_USB`|usb only|
204|`OUT_BT`|bluetooth (when `BLUETOOTH_ENABLE`)| 204|`OUT_BT`|bluetooth (when `BLUETOOTH_ENABLE`)|
205 205
206# Modifiers 206## Modifiers
207 207
208These are special keycodes that simulate pressing several modifiers at once. 208These are special keycodes that simulate pressing several modifiers at once.
209 209
@@ -219,7 +219,7 @@ These are special keycodes that simulate pressing several modifiers at once.
219 * |`KC_LCA`|`LCTL` + `LALT`| 219 * |`KC_LCA`|`LCTL` + `LALT`|
220 */ 220 */
221 221
222## Modifiers with keys 222### Modifiers with keys
223 223
224|Name|Description| 224|Name|Description|
225|----|-----------| 225|----|-----------|
@@ -238,7 +238,7 @@ These are special keycodes that simulate pressing several modifiers at once.
238|`SCMD(kc)`/`SWIN(kc)`|`LGUI` + `LSFT` + `kc`| 238|`SCMD(kc)`/`SWIN(kc)`|`LGUI` + `LSFT` + `kc`|
239|`LCA(kc)`|`LCTL` + `LALT` + `kc`| 239|`LCA(kc)`|`LCTL` + `LALT` + `kc`|
240 240
241## One Shot Keys 241### One Shot Keys
242 242
243Most modifiers work by being held down while you push another key. You can use `OSM()` to setup a "One Shot" modifier. When you tap a one shot mod it will remain is a pressed state until you press another key. 243Most modifiers work by being held down while you push another key. You can use `OSM()` to setup a "One Shot" modifier. When you tap a one shot mod it will remain is a pressed state until you press another key.
244 244
@@ -249,7 +249,7 @@ To specify a your modifier you need to pass the `MOD` form of the key. For examp
249|`OSM(mod)`|use mod for one keypress| 249|`OSM(mod)`|use mod for one keypress|
250|`OSL(layer)`|switch to layer for one keypress| 250|`OSL(layer)`|switch to layer for one keypress|
251 251
252## Mod-tap keys 252### Mod-tap keys
253 253
254These keycodes will press the mod(s) when held, and the key when tapped. They only work with [basic keycodes](basic_keycodes.md). 254These keycodes will press the mod(s) when held, and the key when tapped. They only work with [basic keycodes](basic_keycodes.md).
255 255
@@ -271,7 +271,7 @@ These keycodes will press the mod(s) when held, and the key when tapped. They on
271|`SCMD_T(kc)`/`SWIN_T(kc)`|`LGUI` + `LSFT` when held, `kc` when tapped| 271|`SCMD_T(kc)`/`SWIN_T(kc)`|`LGUI` + `LSFT` when held, `kc` when tapped|
272|`LCA_T(kc)`|`LCTL` + `LALT` when held, `kc` when tapped| 272|`LCA_T(kc)`|`LCTL` + `LALT` when held, `kc` when tapped|
273 273
274# US ANSI Shifted symbols 274## US ANSI Shifted symbols
275 275
276These keycodes correspond to characters that are "shifted" on a standard US ANSI keyboards. They do not have dedicated keycodes but are instead typed by holding down shift and then sending a keycode. 276These keycodes correspond to characters that are "shifted" on a standard US ANSI keyboards. They do not have dedicated keycodes but are instead typed by holding down shift and then sending a keycode.
277 277
@@ -301,7 +301,7 @@ It's important to remember that all of these keycodes send a left shift - this m
301|`KC_QUES`|`KC_QUESTION`|question mark `?`| 301|`KC_QUES`|`KC_QUESTION`|question mark `?`|
302|`KC_DQT`/`KC_DQUO`|`KC_DOUBLE_QUOTE`|double quote `"`| 302|`KC_DQT`/`KC_DQUO`|`KC_DOUBLE_QUOTE`|double quote `"`|
303 303
304# Layer Changes 304## Layer Changes
305 305
306These are keycodes that can be used to change the current layer. 306These are keycodes that can be used to change the current layer.
307 307
@@ -315,7 +315,7 @@ These are keycodes that can be used to change the current layer.
315|`TT(layer)`|tap toggle? idk FIXME| 315|`TT(layer)`|tap toggle? idk FIXME|
316|`OSL(layer)`|switch to layer for one keycode| 316|`OSL(layer)`|switch to layer for one keycode|
317 317
318# Unicode 318## Unicode
319 319
320These keycodes can be used in conjuction with the [Unicode](unicode_and_additional_language_support.md) support. 320These keycodes can be used in conjuction with the [Unicode](unicode_and_additional_language_support.md) support.
321 321