aboutsummaryrefslogtreecommitdiff
path: root/docs/keycodes.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/keycodes.md')
-rw-r--r--docs/keycodes.md205
1 files changed, 118 insertions, 87 deletions
diff --git a/docs/keycodes.md b/docs/keycodes.md
index b15fb62a0..1dc378caf 100644
--- a/docs/keycodes.md
+++ b/docs/keycodes.md
@@ -191,27 +191,6 @@ This is a reference only. Each group of keys links to the page documenting their
191|`KC_NO` | |Ignore this key (NOOP) | 191|`KC_NO` | |Ignore this key (NOOP) |
192|`KC_TRANSPARENT` |`KC_TRNS` |Use the next lowest non-transparent key | 192|`KC_TRANSPARENT` |`KC_TRNS` |Use the next lowest non-transparent key |
193 193
194## [Mouse Keys](feature_mouse_keys.md)
195
196|Key |Aliases |Description |
197|----------------|---------|---------------------------|
198|`KC_MS_UP` |`KC_MS_U`|Mouse Cursor Up |
199|`KC_MS_DOWN` |`KC_MS_D`|Mouse Cursor Down |
200|`KC_MS_LEFT` |`KC_MS_L`|Mouse Cursor Left |
201|`KC_MS_RIGHT` |`KC_MS_R`|Mouse Cursor Right |
202|`KC_MS_BTN1` |`KC_BTN1`|Mouse Button 1 |
203|`KC_MS_BTN2` |`KC_BTN2`|Mouse Button 2 |
204|`KC_MS_BTN3` |`KC_BTN3`|Mouse Button 3 |
205|`KC_MS_BTN4` |`KC_BTN4`|Mouse Button 4 |
206|`KC_MS_BTN5` |`KC_BTN5`|Mouse Button 5 |
207|`KC_MS_WH_UP` |`KC_WH_U`|Mouse Wheel Up |
208|`KC_MS_WH_DOWN` |`KC_WH_D`|Mouse Wheel Down |
209|`KC_MS_WH_LEFT` |`KC_WH_L`|Mouse Wheel Left |
210|`KC_MS_WH_RIGHT`|`KC_WH_R`|Mouse Wheel Right |
211|`KC_MS_ACCEL0` |`KC_ACL0`|Set mouse acceleration to 0|
212|`KC_MS_ACCEL1` |`KC_ACL1`|Set mouse acceleration to 1|
213|`KC_MS_ACCEL2` |`KC_ACL2`|Set mouse acceleration to 2|
214
215## [Quantum Keycodes](quantum_keycodes.md#qmk-keycodes) 194## [Quantum Keycodes](quantum_keycodes.md#qmk-keycodes)
216 195
217|Key |Aliases |Description | 196|Key |Aliases |Description |
@@ -227,6 +206,36 @@ This is a reference only. Each group of keys links to the page documenting their
227|`M(n)` | |Call macro `n` | 206|`M(n)` | |Call macro `n` |
228|`MACROTAP(n)`| |Macro-tap `n` idk FIXME | 207|`MACROTAP(n)`| |Macro-tap `n` idk FIXME |
229 208
209## [Audio Keys](feature_audio.md)
210
211|Key |Aliases |Description |
212|----------------|---------|----------------------------------|
213|`AU_ON` | |Audio mode on |
214|`AU_OFF` | |Audio mode off |
215|`AU_TOG` | |Toggles Audio mode |
216|`CLICKY_TOGGLE` |`CK_TOGG`|Toggles Audio clicky mode |
217|`CLICKY_UP` |`CK_UP` |Increases frequency of the clicks |
218|`CLICKY_DOWN` |`CK_DOWN`|Decreases frequency of the clicks |
219|`CLICKY_RESET` |`CK_RST` |Resets frequency to default |
220|`MU_ON` | |Turns on Music Mode |
221|`MU_OFF` | |Turns off Music Mode |
222|`MU_TOG` | |Toggles Music Mode |
223|`MU_MOD` | |Cycles through the music modes |
224
225
226
227## [Backlighting](feature_backlight.md)
228
229|Key |Description |
230|---------|------------------------------------------|
231|`BL_TOGG`|Turn the backlight on or off |
232|`BL_STEP`|Cycle through backlight levels |
233|`BL_ON` |Set the backlight to max brightness |
234|`BL_OFF` |Turn the backlight off |
235|`BL_INC` |Increase the backlight level |
236|`BL_DEC` |Decrease the backlight level |
237|`BL_BRTG`|Toggle backlight breathing |
238
230## [Bootmagic](feature_bootmagic.md) 239## [Bootmagic](feature_bootmagic.md)
231 240
232|Key |Aliases |Description | 241|Key |Aliases |Description |
@@ -251,17 +260,88 @@ This is a reference only. Each group of keys links to the page documenting their
251|`MAGIC_UNSWAP_ALT_GUI` |`AG_NORM`|Unswap Alt and GUI on both sides | 260|`MAGIC_UNSWAP_ALT_GUI` |`AG_NORM`|Unswap Alt and GUI on both sides |
252|`MAGIC_TOGGLE_NKRO` | |Turn NKRO on or off | 261|`MAGIC_TOGGLE_NKRO` | |Turn NKRO on or off |
253 262
254## [Backlighting](feature_backlight.md) 263## [Bluetooth](feature_bluetooth.md)
255 264
256|Key |Description | 265|Key |Description |
257|---------|------------------------------------------| 266|----------|----------------------------------------------|
258|`BL_TOGG`|Turn the backlight on or off | 267|`OUT_AUTO`|Automatically switch between USB and Bluetooth|
259|`BL_STEP`|Cycle through backlight levels | 268|`OUT_USB` |USB only |
260|`BL_ON` |Set the backlight to max brightness | 269|`OUT_BT` |Bluetooth only |
261|`BL_OFF` |Turn the backlight off | 270
262|`BL_INC` |Increase the backlight level | 271
263|`BL_DEC` |Decrease the backlight level | 272## [Layer Switching](feature_advanced_keycodes.md# Switching and Toggling Layers)
264|`BL_BRTG`|Toggle backlight breathing | 273
274|Key |Description |
275|-----------------|---------------------------------------------------------------------|
276|`DF(layer)` |Switches the default layer |
277|`MO(layer)` |Momentarily activates layer, switches off when you let go |
278|`LM(layer, mod)` |As `MO(layer)` but with `mod` active |
279|`LT(layer, kc)` |Momentarily activates layer if held, sends kc if tapped |
280|`TG(layer)` |Toggles the layer (enables it if no active, and vise versa) |
281|`TO(layer)` |Activates layer and deactivates all other layers |
282|`TT(layer)` |Momentarily activates layer if held, toggles it if tapped repeatedly |
283
284## [Mouse Keys](feature_mouse_keys.md)
285
286|Key |Aliases |Description |
287|----------------|---------|---------------------------|
288|`KC_MS_UP` |`KC_MS_U`|Mouse Cursor Up |
289|`KC_MS_DOWN` |`KC_MS_D`|Mouse Cursor Down |
290|`KC_MS_LEFT` |`KC_MS_L`|Mouse Cursor Left |
291|`KC_MS_RIGHT` |`KC_MS_R`|Mouse Cursor Right |
292|`KC_MS_BTN1` |`KC_BTN1`|Mouse Button 1 |
293|`KC_MS_BTN2` |`KC_BTN2`|Mouse Button 2 |
294|`KC_MS_BTN3` |`KC_BTN3`|Mouse Button 3 |
295|`KC_MS_BTN4` |`KC_BTN4`|Mouse Button 4 |
296|`KC_MS_BTN5` |`KC_BTN5`|Mouse Button 5 |
297|`KC_MS_WH_UP` |`KC_WH_U`|Mouse Wheel Up |
298|`KC_MS_WH_DOWN` |`KC_WH_D`|Mouse Wheel Down |
299|`KC_MS_WH_LEFT` |`KC_WH_L`|Mouse Wheel Left |
300|`KC_MS_WH_RIGHT`|`KC_WH_R`|Mouse Wheel Right |
301|`KC_MS_ACCEL0` |`KC_ACL0`|Set mouse acceleration to 0|
302|`KC_MS_ACCEL1` |`KC_ACL1`|Set mouse acceleration to 1|
303|`KC_MS_ACCEL2` |`KC_ACL2`|Set mouse acceleration to 2|
304
305## [Modifiers](feature_advanced_keycodes.md#modifier-keys)
306
307|Key |Aliases |Description |
308|----------|---------- |----------------------------------------------------|
309|`KC_HYPR` | |Hold Left Control, Shift, Alt and GUI |
310|`KC_MEH` | |Hold Left Control, Shift and Alt |
311|`LCTL(kc)`| |Hold Left Control and press `kc` |
312|`LSFT(kc)`|`S(kc)` |Hold Left Shift and press `kc` |
313|`LALT(kc)`| |Hold Left Alt and press `kc` |
314|`LGUI(kc)`|`LCMD(kc)`, `LWIN(kc)`|Hold Left GUI and press `kc` |
315|`RCTL(kc)`| |Hold Right Control and press `kc` |
316|`RSFT(kc)`| |Hold Right Shift and press `kc` |
317|`RALT(kc)`| |Hold Right Alt and press `kc` |
318|`RGUI(kc)`|`RCMD(kc)`, `LWIN(kc)`|Hold Right GUI and press `kc` |
319|`HYPR(kc)`| |Hold Left Control, Shift, Alt and GUI and press `kc`|
320|`MEH(kc)` | |Hold Left Control, Shift and Alt and press `kc` |
321|`LCAG(kc)`| |Hold Left Control, Alt and GUI and press `kc` |
322|`ALTG(kc)`| |Hold Right Control and Alt and press `kc` |
323|`SGUI(kc)`|`SCMD(kc)`, `SWIN(kc)`|Hold Left Shift and GUI and press `kc` |
324|`LCA(kc)` | |Hold Left Control and Alt and press `kc` |
325
326## [Mod-Tap Keys](feature_advanced_keycodes.md#mod-tap)
327
328|Key |Aliases |Description |
329|------------|---------------------------------------|-------------------------------------------------------|
330|`LCTL_T(kc)`|`CTL_T(kc)` |Left Control when held, `kc` when tapped |
331|`RCTL_T(kc)`| |Right Control when held, `kc` when tapped |
332|`LSFT_T(kc)`|`SFT_T(kc)` |Left Shift when held, `kc` when tapped |
333|`RSFT_T(kc)`| |Right Shift when held, `kc` when tapped |
334|`LALT_T(kc)`|`ALT_T(kc)` |Left Alt when held, `kc` when tapped |
335|`RALT_T(kc)`|`ALGR_T(kc)` |Right Alt when held, `kc` when tapped |
336|`LGUI_T(kc)`|`LCMD_T(kc)`, `RWIN_T(kc)`, `GUI_T(kc)`|Left GUI when held, `kc` when tapped |
337|`RGUI_T(kc)`|`RCMD_T(kc)`, `RWIN_T(kc)` |Right GUI when held, `kc` when tapped |
338|`C_S_T(kc)` | |Left Control and Shift when held, `kc` when tapped |
339|`MEH_T(kc)` | |Left Control, Shift and Alt when held, `kc` when tapped|
340|`LCAG_T(kc)`| |Left Control, Alt and GUI when held, `kc` when tapped |
341|`RCAG_T(kc)`| |Right Control, Alt and GUI when held, `kc` when tapped |
342|`ALL_T(kc)` | |Left Control, Shift, Alt and GUI when held, `kc` when tapped - more info [here](http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/)|
343|`SCMD_T(kc)`|`SWIN_T(kc)` |Left Shift and GUI when held, `kc` when tapped |
344|`LCA_T(kc)` | |Left Control and Alt when held, `kc` when tapped |
265 345
266## [RGB Lighting](feature_rgblight.md) 346## [RGB Lighting](feature_rgblight.md)
267 347
@@ -309,55 +389,6 @@ This is a reference only. Each group of keys links to the page documenting their
309|`PRINT_ON` |Start printing everything the user types| 389|`PRINT_ON` |Start printing everything the user types|
310|`PRINT_OFF`|Stop printing everything the user types | 390|`PRINT_OFF`|Stop printing everything the user types |
311 391
312## [Bluetooth](feature_bluetooth.md)
313
314|Key |Description |
315|----------|----------------------------------------------|
316|`OUT_AUTO`|Automatically switch between USB and Bluetooth|
317|`OUT_USB` |USB only |
318|`OUT_BT` |Bluetooth only |
319
320## [Modifiers](quantum_keycodes.md#modifiers)
321
322|Key |Aliases |Description |
323|----------|---------- |----------------------------------------------------|
324|`KC_HYPR` | |Hold Left Control, Shift, Alt and GUI |
325|`KC_MEH` | |Hold Left Control, Shift and Alt |
326|`LCTL(kc)`| |Hold Left Control and press `kc` |
327|`LSFT(kc)`|`S(kc)` |Hold Left Shift and press `kc` |
328|`LALT(kc)`| |Hold Left Alt and press `kc` |
329|`LGUI(kc)`|`LCMD(kc)`, `LWIN(kc)`|Hold Left GUI and press `kc` |
330|`RCTL(kc)`| |Hold Right Control and press `kc` |
331|`RSFT(kc)`| |Hold Right Shift and press `kc` |
332|`RALT(kc)`| |Hold Right Alt and press `kc` |
333|`RGUI(kc)`|`RCMD(kc)`, `LWIN(kc)`|Hold Right GUI and press `kc` |
334|`HYPR(kc)`| |Hold Left Control, Shift, Alt and GUI and press `kc`|
335|`MEH(kc)` | |Hold Left Control, Shift and Alt and press `kc` |
336|`LCAG(kc)`| |Hold Left Control, Alt and GUI and press `kc` |
337|`ALTG(kc)`| |Hold Right Control and Alt and press `kc` |
338|`SGUI(kc)`|`SCMD(kc)`, `SWIN(kc)`|Hold Left Shift and GUI and press `kc` |
339|`LCA(kc)` | |Hold Left Control and Alt and press `kc` |
340
341## [Mod-Tap Keys](quantum_keycodes.md#mod-tap-keys)
342
343|Key |Aliases |Description |
344|------------|---------------------------------------|-------------------------------------------------------|
345|`LCTL_T(kc)`|`CTL_T(kc)` |Left Control when held, `kc` when tapped |
346|`RCTL_T(kc)`| |Right Control when held, `kc` when tapped |
347|`LSFT_T(kc)`|`SFT_T(kc)` |Left Shift when held, `kc` when tapped |
348|`RSFT_T(kc)`| |Right Shift when held, `kc` when tapped |
349|`LALT_T(kc)`|`ALT_T(kc)` |Left Alt when held, `kc` when tapped |
350|`RALT_T(kc)`|`ALGR_T(kc)` |Right Alt when held, `kc` when tapped |
351|`LGUI_T(kc)`|`LCMD_T(kc)`, `RWIN_T(kc)`, `GUI_T(kc)`|Left GUI when held, `kc` when tapped |
352|`RGUI_T(kc)`|`RCMD_T(kc)`, `RWIN_T(kc)` |Right GUI when held, `kc` when tapped |
353|`C_S_T(kc)` | |Left Control and Shift when held, `kc` when tapped |
354|`MEH_T(kc)` | |Left Control, Shift and Alt when held, `kc` when tapped|
355|`LCAG_T(kc)`| |Left Control, Alt and GUI when held, `kc` when tapped |
356|`RCAG_T(kc)`| |Right Control, Alt and GUI when held, `kc` when tapped |
357|`ALL_T(kc)` | |Left Control, Shift, Alt and GUI when held, `kc` when tapped - more info [here](http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/)|
358|`SCMD_T(kc)`|`SWIN_T(kc)` |Left Shift and GUI when held, `kc` when tapped |
359|`LCA_T(kc)` | |Left Control and Alt when held, `kc` when tapped |
360
361## [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md) 392## [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md)
362 393
363|Key |Aliases |Description | 394|Key |Aliases |Description |
@@ -396,19 +427,13 @@ This is a reference only. Each group of keys links to the page documenting their
396|`TT(layer)` |Normally acts like MO unless it's tapped multiple times, which toggles `layer` on | 427|`TT(layer)` |Normally acts like MO unless it's tapped multiple times, which toggles `layer` on |
397|`LM(layer, mod)`|Momentarily turn on `layer` (like MO) with `mod` active as well. | 428|`LM(layer, mod)`|Momentarily turn on `layer` (like MO) with `mod` active as well. |
398 429
399## [One Shot Keys](quantum_keycodes.md#one-shot-keys) 430## [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys)
400 431
401|Key |Description | 432|Key |Description |
402|------------|----------------------------------| 433|------------|----------------------------------|
403|`OSM(mod)` |Hold `mod` for one keypress | 434|`OSM(mod)` |Hold `mod` for one keypress |
404|`OSL(layer)`|Switch to `layer` for one keypress| 435|`OSL(layer)`|Switch to `layer` for one keypress|
405 436
406## [Unicode Support](feature_unicode.md)
407
408|Key |Aliases| |
409|------------|-------|-------------------------------------------------|
410|`UNICODE(n)`|`UC(n)`|Send Unicode character `n` |
411|`X(n)` | |Send Unicode character `n` via a different method|
412 437
413## [Swap Hands](feature_swap_hands.md) 438## [Swap Hands](feature_swap_hands.md)
414 439
@@ -421,3 +446,9 @@ This is a reference only. Each group of keys links to the page documenting their
421|`SH_MOFF` |Momentarily turns off swap. | 446|`SH_MOFF` |Momentarily turns off swap. |
422|`SH_TG` |Toggles swap on and off with every key press. | 447|`SH_TG` |Toggles swap on and off with every key press. |
423|`SH_TT` |Toggles with a tap; momentary when held. | 448|`SH_TT` |Toggles with a tap; momentary when held. |
449## [Unicode Support](feature_unicode.md)
450
451|Key |Aliases| |
452|------------|-------|-------------------------------------------------|
453|`UNICODE(n)`|`UC(n)`|Send Unicode character `n` |
454|`X(n)` | |Send Unicode character `n` via a different method|
generated by cgit v1.2.3 (git 2.25.1) at 2025-07-06 15:50:15 +0000