aboutsummaryrefslogtreecommitdiff
path: root/docs/keycodes.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/keycodes.md')
-rw-r--r--docs/keycodes.md122
1 files changed, 62 insertions, 60 deletions
diff --git a/docs/keycodes.md b/docs/keycodes.md
index fa01df63d..dd4c4418b 100644
--- a/docs/keycodes.md
+++ b/docs/keycodes.md
@@ -214,18 +214,8 @@ This is a reference only. Each group of keys links to the page documenting their
214|`DEBUG` | |Toggle debug mode | 214|`DEBUG` | |Toggle debug mode |
215|`EEPROM_RESET` |`EEP_RST` |Resets EEPROM state by reinitializing it | 215|`EEPROM_RESET` |`EEP_RST` |Resets EEPROM state by reinitializing it |
216|`KC_GESC` |`GRAVE_ESC`|Escape when tapped, <code>&#96;</code> when pressed with Shift or GUI| 216|`KC_GESC` |`GRAVE_ESC`|Escape when tapped, <code>&#96;</code> when pressed with Shift or GUI|
217|`KC_LSPO` | |Left Shift when held, `(` when tapped |
218|`KC_RSPC` | |Right Shift when held, `)` when tapped |
219|`KC_LCPO` | |Left Control when held, `(` when tapped |
220|`KC_RCPC` | |Right Control when held, `)` when tapped |
221|`KC_LAPO` | |Left Alt when held, `(` when tapped |
222|`KC_RAPC` | |Right Alt when held, `)` when tapped |
223|`KC_SFTENT` | |Right Shift when held, Enter when tapped |
224|`KC_LEAD` | |The [Leader key](feature_leader_key.md) | 217|`KC_LEAD` | |The [Leader key](feature_leader_key.md) |
225|`KC_LOCK` | |The [Lock key](feature_key_lock.md) | 218|`KC_LOCK` | |The [Lock key](feature_key_lock.md) |
226|`FUNC(n)` |`F(n)` |Call `fn_action(n)` (deprecated) |
227|`M(n)` | |Call macro `n` |
228|`MACROTAP(n)` | |Macro-tap `n` idk FIXME |
229 219
230## [Audio Keys](feature_audio.md) 220## [Audio Keys](feature_audio.md)
231 221
@@ -257,37 +247,37 @@ This is a reference only. Each group of keys links to the page documenting their
257 247
258## [Bootmagic](feature_bootmagic.md) 248## [Bootmagic](feature_bootmagic.md)
259 249
260|Key |Aliases |Description | 250|Key |Aliases |Description |
261|----------------------------------|---------|-------------------------------------------| 251|----------------------------------|---------|--------------------------------------------------------------------------|
262|`MAGIC_SWAP_CONTROL_CAPSLOCK` | |Swap Caps Lock and Left Control | 252|`MAGIC_SWAP_CONTROL_CAPSLOCK` |`CL_SWAP`|Swap Caps Lock and Left Control |
263|`MAGIC_CAPSLOCK_TO_CONTROL` | |Treat Caps Lock as Control | 253|`MAGIC_UNSWAP_CONTROL_CAPSLOCK` |`CL_NORM`|Unswap Caps Lock and Left Control |
264|`MAGIC_SWAP_LCTL_LGUI` | |Swap Left Control and GUI | 254|`MAGIC_CAPSLOCK_TO_CONTROL` |`CL_CTRL`|Treat Caps Lock as Control |
265|`MAGIC_SWAP_RCTL_RGUI` | |Swap Right Control and GUI | 255|`MAGIC_UNCAPSLOCK_TO_CONTROL` |`CL_CAPS`|Stop treating Caps Lock as Control |
266|`MAGIC_SWAP_LALT_LGUI` | |Swap Left Alt and GUI | 256|`MAGIC_SWAP_LCTL_LGUI` |`LCG_SWP`|Swap Left Control and GUI |
267|`MAGIC_SWAP_RALT_RGUI` | |Swap Right Alt and GUI | 257|`MAGIC_UNSWAP_LCTL_LGUI` |`LCG_NRM`|Unswap Left Control and GUI |
268|`MAGIC_NO_GUI` | |Disable the GUI key | 258|`MAGIC_SWAP_RCTL_RGUI` |`RCG_SWP`|Swap Right Control and GUI |
269|`MAGIC_SWAP_GRAVE_ESC` | |Swap <code>&#96;</code> and Escape | 259|`MAGIC_UNSWAP_RCTL_RGUI` |`RCG_NRM`|Unswap Right Control and GUI |
270|`MAGIC_SWAP_BACKSLASH_BACKSPACE` | |Swap `\` and Backspace | 260|`MAGIC_SWAP_CTL_GUI` |`CG_SWAP`|Swap Control and GUI on both sides |
271|`MAGIC_HOST_NKRO` | |Force NKRO on | 261|`MAGIC_UNSWAP_CTL_GUI` |`CG_NORM`|Unswap Control and GUI on both sides |
272|`MAGIC_SWAP_ALT_GUI` |`AG_SWAP`|Swap Alt and GUI on both sides | 262|`MAGIC_TOGGLE_CTL_GUI` |`CG_TOGG`|Toggle Control and GUI swap on both sides |
273|`MAGIC_SWAP_CTL_GUI` |`CG_SWAP`|Swap Ctrl and GUI on both sides (for macOS)| 263|`MAGIC_SWAP_LALT_LGUI` |`LAG_SWP`|Swap Left Alt and GUI |
274|`MAGIC_UNSWAP_CONTROL_CAPSLOCK` | |Unswap Caps Lock and Left Control | 264|`MAGIC_UNSWAP_LALT_LGUI` |`LAG_NRM`|Unswap Left Alt and GUI |
275|`MAGIC_UNCAPSLOCK_TO_CONTROL` | |Stop treating Caps Lock as Control | 265|`MAGIC_SWAP_RALT_RGUI` |`RAG_SWP`|Swap Right Alt and GUI |
276|`MAGIC_UNSWAP_LCTL_LGUI` | |Unswap Left Control and GUI | 266|`MAGIC_UNSWAP_RALT_RGUI` |`RAG_NRM`|Unswap Right Alt and GUI |
277|`MAGIC_UNSWAP_RCTL_RGUI` | |Unswap Right Control and GUI | 267|`MAGIC_SWAP_ALT_GUI` |`AG_SWAP`|Swap Alt and GUI on both sides |
278|`MAGIC_UNSWAP_LALT_LGUI` | |Unswap Left Alt and GUI | 268|`MAGIC_UNSWAP_ALT_GUI` |`AG_NORM`|Unswap Alt and GUI on both sides |
279|`MAGIC_UNSWAP_RALT_RGUI` | |Unswap Right Alt and GUI | 269|`MAGIC_TOGGLE_ALT_GUI` |`AG_TOGG`|Toggle Alt and GUI swap on both sides |
280|`MAGIC_UNNO_GUI` | |Enable the GUI key | 270|`MAGIC_NO_GUI` |`GUI_OFF`|Disable the GUI keys |
281|`MAGIC_UNSWAP_GRAVE_ESC` | |Unswap <code>&#96;</code> and Escape | 271|`MAGIC_UNNO_GUI` |`GUI_ON` |Enable the GUI keys |
282|`MAGIC_UNSWAP_BACKSLASH_BACKSPACE`| |Unswap `\` and Backspace | 272|`MAGIC_SWAP_GRAVE_ESC` |`GE_SWAP`|Swap <code>&#96;</code> and Escape |
283|`MAGIC_UNHOST_NKRO` | |Force NKRO off | 273|`MAGIC_UNSWAP_GRAVE_ESC` |`GE_NORM`|Unswap <code>&#96;</code> and Escape |
284|`MAGIC_UNSWAP_ALT_GUI` |`AG_NORM`|Unswap Alt and GUI on both sides | 274|`MAGIC_SWAP_BACKSLASH_BACKSPACE` |`BS_SWAP`|Swap `\` and Backspace |
285|`MAGIC_UNSWAP_CTL_GUI` |`CG_NORM`|Unswap Ctrl and GUI on both sides | 275|`MAGIC_UNSWAP_BACKSLASH_BACKSPACE`|`BS_NORM`|Unswap `\` and Backspace |
286|`MAGIC_TOGGLE_ALT_GUI` |`AG_TOGG`|Toggle Alt and GUI swap on both sides | 276|`MAGIC_HOST_NKRO` |`NK_ON` |Enable N-key rollover |
287|`MAGIC_TOGGLE_CTL_GUI` |`CG_TOGG`|Toggle Ctrl and GUI swap on both sides | 277|`MAGIC_UNHOST_NKRO` |`NK_OFF` |Disable N-key rollover |
288|`MAGIC_TOGGLE_NKRO` | |Turn NKRO on or off | 278|`MAGIC_TOGGLE_NKRO` |`NK_TOGG`|Toggle N-key rollover |
289|`MAGIC_EE_HANDS_LEFT` | |Set "Left Hand" for EE_HANDS handedness | 279|`MAGIC_EE_HANDS_LEFT` |`EH_LEFT`|Set the master half of a split keyboard as the left hand (for `EE_HANDS`) |
290|`MAGIC_EE_HANDS_RIGHT` | |Set "Right Hand" for EE_HANDS handedness | 280|`MAGIC_EE_HANDS_RIGHT` |`EH_RGHT`|Set the master half of a split keyboard as the right hand (for `EE_HANDS`)|
291 281
292## [Bluetooth](feature_bluetooth.md) 282## [Bluetooth](feature_bluetooth.md)
293 283
@@ -389,12 +379,12 @@ This is a reference only. Each group of keys links to the page documenting their
389|`RGB_TOG` | |Toggle RGB lighting on or off | 379|`RGB_TOG` | |Toggle RGB lighting on or off |
390|`RGB_MODE_FORWARD` |`RGB_MOD` |Cycle through modes, reverse direction when Shift is held | 380|`RGB_MODE_FORWARD` |`RGB_MOD` |Cycle through modes, reverse direction when Shift is held |
391|`RGB_MODE_REVERSE` |`RGB_RMOD`|Cycle through modes in reverse, forward direction when Shift is held| 381|`RGB_MODE_REVERSE` |`RGB_RMOD`|Cycle through modes in reverse, forward direction when Shift is held|
392|`RGB_HUI` | |Increase hue | 382|`RGB_HUI` | |Increase hue, decrease hue when Shift is held |
393|`RGB_HUD` | |Decrease hue | 383|`RGB_HUD` | |Decrease hue, increase hue when Shift is held |
394|`RGB_SAI` | |Increase saturation | 384|`RGB_SAI` | |Increase saturation, decrease saturation when Shift is held |
395|`RGB_SAD` | |Decrease saturation | 385|`RGB_SAD` | |Decrease saturation, increase saturation when Shift is held |
396|`RGB_VAI` | |Increase value (brightness) | 386|`RGB_VAI` | |Increase value (brightness), decrease value when Shift is held |
397|`RGB_VAD` | |Decrease value (brightness) | 387|`RGB_VAD` | |Decrease value (brightness), increase value when Shift is held |
398|`RGB_MODE_PLAIN` |`RGB_M_P `|Static (no animation) mode | 388|`RGB_MODE_PLAIN` |`RGB_M_P `|Static (no animation) mode |
399|`RGB_MODE_BREATHE` |`RGB_M_B` |Breathing animation mode | 389|`RGB_MODE_BREATHE` |`RGB_M_B` |Breathing animation mode |
400|`RGB_MODE_RAINBOW` |`RGB_M_R` |Rainbow animation mode | 390|`RGB_MODE_RAINBOW` |`RGB_M_R` |Rainbow animation mode |
@@ -407,19 +397,19 @@ This is a reference only. Each group of keys links to the page documenting their
407 397
408## [RGB Matrix Lighting](feature_rgb_matrix.md) 398## [RGB Matrix Lighting](feature_rgb_matrix.md)
409 399
410|Key |Aliases |Description | 400|Key |Aliases |Description |
411|-------------------|----------|--------------------------------------------------------------------| 401|-------------------|----------|--------------------------------------------------------------------------------------|
412|`RGB_TOG` | |Toggle RGB lighting on or off | 402|`RGB_TOG` | |Toggle RGB lighting on or off |
413|`RGB_MODE_FORWARD` |`RGB_MOD` |Cycle through modes, reverse direction when Shift is held | 403|`RGB_MODE_FORWARD` |`RGB_MOD` |Cycle through modes, reverse direction when Shift is held |
414|`RGB_MODE_REVERSE` |`RGB_RMOD`|Cycle through modes in reverse, forward direction when Shift is held| 404|`RGB_MODE_REVERSE` |`RGB_RMOD`|Cycle through modes in reverse, forward direction when Shift is held |
415|`RGB_HUI` | |Increase hue | 405|`RGB_HUI` | |Increase hue, decrease hue when Shift is held |
416|`RGB_HUD` | |Decrease hue | 406|`RGB_HUD` | |Decrease hue, increase hue when Shift is held |
417|`RGB_SAI` | |Increase saturation | 407|`RGB_SAI` | |Increase saturation, decrease saturation when Shift is held |
418|`RGB_SAD` | |Decrease saturation | 408|`RGB_SAD` | |Decrease saturation, increase saturation when Shift is held |
419|`RGB_VAI` | |Increase value (brightness) | 409|`RGB_VAI` | |Increase value (brightness), decrease value when Shift is held |
420|`RGB_VAD` | |Decrease value (brightness) | 410|`RGB_VAD` | |Decrease value (brightness), increase value when Shift is held |
421|`RGB_SPI` | |Increase effect speed (does no support eeprom yet) | 411|`RGB_SPI` | |Increase effect speed (does not support eeprom yet), decrease speed when Shift is held|
422|`RGB_SPD` | |Decrease effect speed (does no support eeprom yet) | 412|`RGB_SPD` | |Decrease effect speed (does not support eeprom yet), increase speed when Shift is held|
423 413
424## [Thermal Printer](feature_thermal_printer.md) 414## [Thermal Printer](feature_thermal_printer.md)
425 415
@@ -461,6 +451,18 @@ This is a reference only. Each group of keys links to the page documenting their
461|`OSM(mod)` |Hold `mod` for one keypress | 451|`OSM(mod)` |Hold `mod` for one keypress |
462|`OSL(layer)`|Switch to `layer` for one keypress| 452|`OSL(layer)`|Switch to `layer` for one keypress|
463 453
454## [Space Cadet](feature_space_cadet.md)
455
456|Key |Description |
457|-----------|----------------------------------------|
458|`KC_LCPO` |Left Control when held, `(` when tapped |
459|`KC_RCPC` |Right Control when held, `)` when tapped|
460|`KC_LSPO` |Left Shift when held, `(` when tapped |
461|`KC_RSPC` |Right Shift when held, `)` when tapped |
462|`KC_LAPO` |Left Alt when held, `(` when tapped |
463|`KC_RAPC` |Right Alt when held, `)` when tapped |
464|`KC_SFTENT`|Right Shift when held, Enter when tapped|
465
464## [Swap Hands](feature_swap_hands.md) 466## [Swap Hands](feature_swap_hands.md)
465 467
466|Key |Description | 468|Key |Description |
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-22 06:30:58 +0000