mirror of https://github.com/openstenoproject/qmk synced 2024-11-09 18:19:08 +00:00

[Core] Add compile/make macro to core (#15959 )

* [Core] Add KC_MAKE keycode to core

fix linting

fix testing error

work around test idiocyncracies

fix more lint

something something stupid tests

add doc

* updates based on feedback

* Add bad names

* Fixup docs

* semantics but cleaner

Co-authored-by: precondition <57645186+precondition@users.noreply.github.com>

* Hide oneshot checks behind preprocessors

* Move no-compile option around

* Fix formatting

* make shift optional

* Make opt in

* fix formatting

* update send string function name

Co-authored-by: Joel Challis <git@zvecr.com>

Co-authored-by: precondition <57645186+precondition@users.noreply.github.com>
Co-authored-by: Joel Challis <git@zvecr.com>

2022-03-17 21:19:34 +00:00

66 KiB

Raw Blame History

Keycodes Overview

When defining a keymap each key needs a valid key definition. This page documents the symbols that correspond to keycodes that are available to you in QMK.

This is a reference only. Each group of keys links to the page documenting their functionality in more detail.

Basic Keycodes :id=basic-keycodes

See also: Basic Keycodes

Key	Aliases	Description	Windows	macOS	Linux¹
`KC_NO`	`XXXXXXX`	Ignore this key (NOOP)	N/A	N/A	N/A
`KC_TRANSPARENT`	`KC_TRNS`, `_______`	Use the next lowest non-transparent key	N/A	N/A	N/A
`KC_A`		`a` and `A`	✔	✔	✔
`KC_B`		`b` and `B`	✔	✔	✔
`KC_C`		`c` and `C`	✔	✔	✔
`KC_D`		`d` and `D`	✔	✔	✔
`KC_E`		`e` and `E`	✔	✔	✔
`KC_F`		`f` and `F`	✔	✔	✔
`KC_G`		`g` and `G`	✔	✔	✔
`KC_H`		`h` and `H`	✔	✔	✔
`KC_I`		`i` and `I`	✔	✔	✔
`KC_J`		`j` and `J`	✔	✔	✔
`KC_K`		`k` and `K`	✔	✔	✔
`KC_L`		`l` and `L`	✔	✔	✔
`KC_M`		`m` and `M`	✔	✔	✔
`KC_N`		`n` and `N`	✔	✔	✔
`KC_O`		`o` and `O`	✔	✔	✔
`KC_P`		`p` and `P`	✔	✔	✔
`KC_Q`		`q` and `Q`	✔	✔	✔
`KC_R`		`r` and `R`	✔	✔	✔
`KC_S`		`s` and `S`	✔	✔	✔
`KC_T`		`t` and `T`	✔	✔	✔
`KC_U`		`u` and `U`	✔	✔	✔
`KC_V`		`v` and `V`	✔	✔	✔
`KC_W`		`w` and `W`	✔	✔	✔
`KC_X`		`x` and `X`	✔	✔	✔
`KC_Y`		`y` and `Y`	✔	✔	✔
`KC_Z`		`z` and `Z`	✔	✔	✔
`KC_1`		`1` and `!`	✔	✔	✔
`KC_2`		`2` and `@`	✔	✔	✔
`KC_3`		`3` and `#`	✔	✔	✔
`KC_4`		`4` and `$`	✔	✔	✔
`KC_5`		`5` and `%`	✔	✔	✔
`KC_6`		`6` and `^`	✔	✔	✔
`KC_7`		`7` and `&`	✔	✔	✔
`KC_8`		`8` and `*`	✔	✔	✔
`KC_9`		`9` and `(`	✔	✔	✔
`KC_0`		`0` and `)`	✔	✔	✔
`KC_ENTER`	`KC_ENT`	Return (Enter)	✔	✔	✔
`KC_ESCAPE`	`KC_ESC`	Escape	✔	✔	✔
`KC_BACKSPACE`	`KC_BSPC`	Delete (Backspace)	✔	✔	✔
`KC_TAB`		Tab	✔	✔	✔
`KC_SPACE`	`KC_SPC`	Spacebar	✔	✔	✔
`KC_MINUS`	`KC_MINS`	`-` and `_`	✔	✔	✔
`KC_EQUAL`	`KC_EQL`	`=` and `+`	✔	✔	✔
`KC_LEFT_BRACKET`	`KC_LBRC`	`[` and `{`	✔	✔	✔
`KC_RIGHT_BRACKET`	`KC_RBRC`	`]` and `}`	✔	✔	✔
`KC_BACKSLASH`	`KC_BSLS`	`\` and `\|`	✔	✔	✔
`KC_NONUS_HASH`	`KC_NUHS`	Non-US `#` and `~`	✔	✔	✔
`KC_SEMICOLON`	`KC_SCLN`	`;` and `:`	✔	✔	✔
`KC_QUOTE`	`KC_QUOT`	`'` and `"`	✔	✔	✔
`KC_GRAVE`	`KC_GRV`	` and `~`	✔	✔	✔
`KC_COMMA`	`KC_COMM`	`,` and `<`	✔	✔	✔
`KC_DOT`		`.` and `>`	✔	✔	✔
`KC_SLASH`	`KC_SLSH`	`/` and `?`	✔	✔	✔
`KC_CAPS_LOCK`	`KC_CAPS`	Caps Lock	✔	✔	✔
`KC_F1`		F1	✔	✔	✔
`KC_F2`		F2	✔	✔	✔
`KC_F3`		F3	✔	✔	✔
`KC_F4`		F4	✔	✔	✔
`KC_F5`		F5	✔	✔	✔
`KC_F6`		F6	✔	✔	✔
`KC_F7`		F7	✔	✔	✔
`KC_F8`		F8	✔	✔	✔
`KC_F9`		F9	✔	✔	✔
`KC_F10`		F10	✔	✔	✔
`KC_F11`		F11	✔	✔	✔
`KC_F12`		F12	✔	✔	✔
`KC_PRINT_SCREEN`	`KC_PSCR`	Print Screen	✔	✔²	✔
`KC_SCROLL_LOCK`	`KC_SCRL`, `KC_BRMD`	Scroll Lock, Brightness Down (macOS)	✔	✔²	✔
`KC_PAUSE`	`KC_PAUS`, `KC_BRK`, `KC_BRMU`	Pause, Brightness Up (macOS)	✔	✔²	✔
`KC_INSERT`	`KC_INS`	Insert	✔		✔
`KC_HOME`		Home	✔	✔	✔
`KC_PAGE_UP`	`KC_PGUP`	Page Up	✔	✔	✔
`KC_DELETE`	`KC_DEL`	Forward Delete	✔	✔	✔
`KC_END`		End	✔	✔	✔
`KC_PAGE_DOWN`	`KC_PGDN`	Page Down	✔	✔	✔
`KC_RIGHT`	`KC_RGHT`	Right Arrow	✔	✔	✔
`KC_LEFT`		Left Arrow	✔	✔	✔
`KC_DOWN`		Down Arrow	✔	✔	✔
`KC_UP`		Up Arrow	✔	✔	✔
`KC_NUM_LOCK`	`KC_NUM`	Keypad Num Lock and Clear	✔	✔	✔
`KC_KP_SLASH`	`KC_PSLS`	Keypad `/`	✔	✔	✔
`KC_KP_ASTERISK`	`KC_PAST`	Keypad `*`	✔	✔	✔
`KC_KP_MINUS`	`KC_PMNS`	Keypad `-`	✔	✔	✔
`KC_KP_PLUS`	`KC_PPLS`	Keypad `+`	✔	✔	✔
`KC_KP_ENTER`	`KC_PENT`	Keypad Enter	✔	✔	✔
`KC_KP_1`	`KC_P1`	Keypad `1` and End	✔	✔	✔
`KC_KP_2`	`KC_P2`	Keypad `2` and Down Arrow	✔	✔	✔
`KC_KP_3`	`KC_P3`	Keypad `3` and Page Down	✔	✔	✔
`KC_KP_4`	`KC_P4`	Keypad `4` and Left Arrow	✔	✔	✔
`KC_KP_5`	`KC_P5`	Keypad `5`	✔	✔	✔
`KC_KP_6`	`KC_P6`	Keypad `6` and Right Arrow	✔	✔	✔
`KC_KP_7`	`KC_P7`	Keypad `7` and Home	✔	✔	✔
`KC_KP_8`	`KC_P8`	Keypad `8` and Up Arrow	✔	✔	✔
`KC_KP_9`	`KC_P9`	Keypad `9` and Page Up	✔	✔	✔
`KC_KP_0`	`KC_P0`	Keypad `0` and Insert	✔	✔	✔
`KC_KP_DOT`	`KC_PDOT`	Keypad `.` and Delete	✔	✔	✔
`KC_NONUS_BACKSLASH`	`KC_NUBS`	Non-US `\` and `\|`	✔	✔	✔
`KC_APPLICATION`	`KC_APP`	Application (Windows Context Menu Key)	✔		✔
`KC_KB_POWER`		System Power		✔³	✔
`KC_KP_EQUAL`	`KC_PEQL`	Keypad `=`	✔	✔	✔
`KC_F13`		F13	✔	✔	✔
`KC_F14`		F14	✔	✔	✔
`KC_F15`		F15	✔	✔	✔
`KC_F16`		F16	✔	✔	✔
`KC_F17`		F17	✔	✔	✔
`KC_F18`		F18	✔	✔	✔
`KC_F19`		F19	✔	✔	✔
`KC_F20`		F20	✔		✔
`KC_F21`		F21	✔		✔
`KC_F22`		F22	✔		✔
`KC_F23`		F23	✔		✔
`KC_F24`		F24	✔		✔
`KC_EXECUTE`	`KC_EXEC`	Execute			✔
`KC_HELP`		Help			✔
`KC_MENU`		Menu			✔
`KC_SELECT`	`KC_SLCT`	Select			✔
`KC_STOP`		Stop			✔
`KC_AGAIN`	`KC_AGIN`	Again			✔
`KC_UNDO`		Undo			✔
`KC_CUT`		Cut			✔
`KC_COPY`		Copy			✔
`KC_PASTE`	`KC_PSTE`	Paste			✔
`KC_FIND`		Find			✔
`KC_KB_MUTE`		Mute		✔	✔
`KC_KB_VOLUME_UP`		Volume Up		✔	✔
`KC_KB_VOLUME_DOWN`		Volume Down		✔	✔
`KC_LOCKING_CAPS_LOCK`	`KC_LCAP`	Locking Caps Lock	✔	✔
`KC_LOCKING_NUM_LOCK`	`KC_LNUM`	Locking Num Lock	✔	✔
`KC_LOCKING_SCROLL_LOCK`	`KC_LSCR`	Locking Scroll Lock	✔	✔
`KC_KP_COMMA`	`KC_PCMM`	Keypad `,`			✔
`KC_KP_EQUAL_AS400`		Keypad `=` on AS/400 keyboards
`KC_INTERNATIONAL_1`	`KC_INT1`	International 1	✔		✔
`KC_INTERNATIONAL_2`	`KC_INT2`	International 2	✔		✔
`KC_INTERNATIONAL_3`	`KC_INT3`	International 3	✔		✔
`KC_INTERNATIONAL_4`	`KC_INT4`	International 4	✔		✔
`KC_INTERNATIONAL_5`	`KC_INT5`	International 5	✔		✔
`KC_INTERNATIONAL_6`	`KC_INT6`	International 6			✔
`KC_INTERNATIONAL_7`	`KC_INT7`	International 7
`KC_INTERNATIONAL_8`	`KC_INT8`	International 8
`KC_INTERNATIONAL_9`	`KC_INT9`	International 9
`KC_LANGUAGE_1`	`KC_LNG1`	Language 1			✔
`KC_LANGUAGE_2`	`KC_LNG2`	Language 2			✔
`KC_LANGUAGE_3`	`KC_LNG3`	Language 3			✔
`KC_LANGUAGE_4`	`KC_LNG4`	Language 4			✔
`KC_LANGUAGE_5`	`KC_LNG5`	Language 5			✔
`KC_LANGUAGE_6`	`KC_LNG6`	Language 6
`KC_LANGUAGE_7`	`KC_LNG7`	Language 7
`KC_LANGUAGE_8`	`KC_LNG8`	Language 8
`KC_LANGUAGE_9`	`KC_LNG9`	Language 9
`KC_ALTERNATE_ERASE`	`KC_ERAS`	Alternate Erase
`KC_SYSTEM_REQUEST`	`KC_SYRQ`	SysReq/Attention
`KC_CANCEL`	`KC_CNCL`	Cancel
`KC_CLEAR`	`KC_CLR`	Clear			✔
`KC_PRIOR`	`KC_PRIR`	Prior
`KC_RETURN`	`KC_RETN`	Return
`KC_SEPARATOR`	`KC_SEPR`	Separator
`KC_OUT`		Out
`KC_OPER`		Oper
`KC_CLEAR_AGAIN`	`KC_CLAG`	Clear/Again
`KC_CRSEL`	`KC_CRSL`	CrSel/Props
`KC_EXSEL`	`KC_EXSL`	ExSel
`KC_LEFT_CTRL`	`KC_LCTL`	Left Control	✔	✔	✔
`KC_LEFT_SHIFT`	`KC_LSFT`	Left Shift	✔	✔	✔
`KC_LEFT_ALT`	`KC_LALT`, `KC_LOPT`	Left Alt (Option)	✔	✔	✔
`KC_LEFT_GUI`	`KC_LGUI`, `KC_LCMD`, `KC_LWIN`	Left GUI (Windows/Command/Meta key)	✔	✔	✔
`KC_RIGHT_CTRL`	`KC_RCTL`	Right Control	✔	✔	✔
`KC_RIGHT_SHIFT`	`KC_RSFT`	Right Shift	✔	✔	✔
`KC_RIGHT_ALT`	`KC_RALT`, `KC_ROPT`, `KC_ALGR`	Right Alt (Option/AltGr)	✔	✔	✔
`KC_RIGHT_GUI`	`KC_RGUI`, `KC_RCMD`, `KC_RWIN`	Right GUI (Windows/Command/Meta key)	✔	✔	✔
`KC_SYSTEM_POWER`	`KC_PWR`	System Power Down	✔	✔³	✔
`KC_SYSTEM_SLEEP`	`KC_SLEP`	System Sleep	✔	✔³	✔
`KC_SYSTEM_WAKE`	`KC_WAKE`	System Wake		✔³	✔
`KC_AUDIO_MUTE`	`KC_MUTE`	Mute	✔	✔	✔
`KC_AUDIO_VOL_UP`	`KC_VOLU`	Volume Up	✔	✔⁴	✔
`KC_AUDIO_VOL_DOWN`	`KC_VOLD`	Volume Down	✔	✔⁴	✔
`KC_MEDIA_NEXT_TRACK`	`KC_MNXT`	Next Track	✔	✔⁵	✔
`KC_MEDIA_PREV_TRACK`	`KC_MPRV`	Previous Track	✔	✔⁵	✔
`KC_MEDIA_STOP`	`KC_MSTP`	Stop Track	✔		✔
`KC_MEDIA_PLAY_PAUSE`	`KC_MPLY`	Play/Pause Track	✔	✔	✔
`KC_MEDIA_SELECT`	`KC_MSEL`	Launch Media Player	✔		✔
`KC_MEDIA_EJECT`	`KC_EJCT`	Eject		✔	✔
`KC_MAIL`		Launch Mail	✔		✔
`KC_CALCULATOR`	`KC_CALC`	Launch Calculator	✔		✔
`KC_MY_COMPUTER`	`KC_MYCM`	Launch My Computer	✔		✔
`KC_WWW_SEARCH`	`KC_WSCH`	Browser Search	✔		✔
`KC_WWW_HOME`	`KC_WHOM`	Browser Home	✔		✔
`KC_WWW_BACK`	`KC_WBAK`	Browser Back	✔		✔
`KC_WWW_FORWARD`	`KC_WFWD`	Browser Forward	✔		✔
`KC_WWW_STOP`	`KC_WSTP`	Browser Stop	✔		✔
`KC_WWW_REFRESH`	`KC_WREF`	Browser Refresh	✔		✔
`KC_WWW_FAVORITES`	`KC_WFAV`	Browser Favorites	✔		✔
`KC_MEDIA_FAST_FORWARD`	`KC_MFFD`	Next Track	✔	✔⁵	✔
`KC_MEDIA_REWIND`	`KC_MRWD`	Previous Track	✔⁶	✔⁵	✔
`KC_BRIGHTNESS_UP`	`KC_BRIU`	Brightness Up	✔	✔	✔
`KC_BRIGHTNESS_DOWN`	`KC_BRID`	Brightness Down	✔	✔	✔

^{1. The Linux kernel HID driver recognizes nearly all keycodes, but the default bindings depend on the DE/WM.}
^{2. Treated as F13-F15.}
^{3. Must be held for about three seconds, and will display a prompt instead.}
^{4. Holding Shift+Option allows for finer control of volume level.}
^{5. Skips the entire track in iTunes when tapped, seeks within the current track when held.}
^{6. WMP does not recognize the Rewind key, but both alter playback speed in VLC.}

Key	Aliases	Description
`QK_BOOTLOADER`	`QK_BOOT`	Put the keyboard into bootloader mode for flashing
`QK_DEBUG_TOGGLE`	`DB_TOGG`	Toggle debug mode
`QK_CLEAR_EEPROM`	`EE_CLR`	Reinitializes the keyboard's EEPROM (persistent memory)
`QK_MAKE`		Sends `qmk compile -kb (keyboard) -km (keymap)`, or `qmk flash` if shift is held

Key	Aliases	Description
`AU_ON`		Turns on Audio Feature
`AU_OFF`		Turns off Audio Feature
`AU_TOG`		Toggles Audio state
`CLICKY_TOGGLE`	`CK_TOGG`	Toggles Audio clicky mode
`CLICKY_UP`	`CK_UP`	Increases frequency of the clicks
`CLICKY_DOWN`	`CK_DOWN`	Decreases frequency of the clicks
`CLICKY_RESET`	`CK_RST`	Resets frequency to default
`MU_ON`		Turns on Music Mode
`MU_OFF`		Turns off Music Mode
`MU_TOG`		Toggles Music Mode
`MU_MOD`		Cycles through the music modes

Key	Description
`BL_TOGG`	Turn the backlight on or off
`BL_STEP`	Cycle through backlight levels
`BL_ON`	Set the backlight to max brightness
`BL_OFF`	Turn the backlight off
`BL_INC`	Increase the backlight level
`BL_DEC`	Decrease the backlight level
`BL_BRTG`	Toggle backlight breathing

Key	Description
`OUT_AUTO`	Automatically switch between USB and Bluetooth
`OUT_USB`	USB only
`OUT_BT`	Bluetooth only

Key	Aliases	Description
`DYN_REC_START1`	`DM_REC1`	Start recording Macro 1
`DYN_REC_START2`	`DM_REC2`	Start recording Macro 2
`DYN_MACRO_PLAY1`	`DM_PLY1`	Replay Macro 1
`DYN_MACRO_PLAY2`	`DM_PLY2`	Replay Macro 2
`DYN_REC_STOP`	`DM_RSTP`	Finish the macro that is currently being recorded.

66 KiB

Raw Blame History

Keycodes Overview

Basic Keycodes :id=basic-keycodes

Quantum Keycodes :id=quantum-keycodes

Audio Keys :id=audio-keys

Backlighting :id=backlighting

Bluetooth :id=bluetooth

Dynamic Macros :id=dynamic-macros

Grave Escape :id=grave-escape

Key Lock :id=key-lock

Layer Switching :id=layer-switching

Leader Key :id=leader-key

Magic Keycodes :id=magic-keycodes

MIDI :id=midi

Mouse Keys :id=mouse-keys

Modifiers :id=modifiers

Mod-Tap Keys :id=mod-tap-keys

Tapping Term Keys :id=tapping-term-keys

RGB Lighting :id=rgb-lighting

RGB Matrix Lighting :id=rgb-matrix-lighting

Thermal Printer :id=thermal-printer

US ANSI Shifted Symbols :id=us-ansi-shifted-symbols

One Shot Keys :id=one-shot-keys

Programmable Button Support :id=programmable-button

Space Cadet :id=space-cadet

Swap Hands :id=swap-hands

Unicode Support :id=unicode-support

Key	Description
`DF(layer)`	Set the base (default) layer
`MO(layer)`	Momentarily turn on `layer` when pressed (requires `KC_TRNS` on destination layer)
`OSL(layer)`	Momentarily activates `layer` until a key is pressed. See One Shot Keys for details.
`LM(layer, mod)`	Momentarily turn on `layer` (like MO) with `mod` active as well. Where `mod` is a mods_bit. Mods can be viewed here. Example Implementation: `LM(LAYER_1, MOD_LALT)`
`LT(layer, kc)`	Turn on `layer` when held, `kc` when tapped
`TG(layer)`	Toggle `layer` on or off
`TO(layer)`	Turns on `layer` and turns off all other layers, except the default layer
`TT(layer)`	Normally acts like MO unless it's tapped multiple times, which toggles `layer` on

Key	Aliases	Description
`MAGIC_SWAP_CONTROL_CAPSLOCK`	`CL_SWAP`	Swap Caps Lock and Left Control
`MAGIC_UNSWAP_CONTROL_CAPSLOCK`	`CL_NORM`	Unswap Caps Lock and Left Control
`MAGIC_TOGGLE_CONTROL_CAPSLOCK`	`CL_TOGG`	Toggle Caps Lock and Left Control swap
`MAGIC_CAPSLOCK_TO_CONTROL`	`CL_CTRL`	Treat Caps Lock as Control
`MAGIC_UNCAPSLOCK_TO_CONTROL`	`CL_CAPS`	Stop treating Caps Lock as Control
`MAGIC_SWAP_LCTL_LGUI`	`LCG_SWP`	Swap Left Control and GUI
`MAGIC_UNSWAP_LCTL_LGUI`	`LCG_NRM`	Unswap Left Control and GUI
`MAGIC_SWAP_RCTL_RGUI`	`RCG_SWP`	Swap Right Control and GUI
`MAGIC_UNSWAP_RCTL_RGUI`	`RCG_NRM`	Unswap Right Control and GUI
`MAGIC_SWAP_CTL_GUI`	`CG_SWAP`	Swap Control and GUI on both sides
`MAGIC_UNSWAP_CTL_GUI`	`CG_NORM`	Unswap Control and GUI on both sides
`MAGIC_TOGGLE_CTL_GUI`	`CG_TOGG`	Toggle Control and GUI swap on both sides
`MAGIC_SWAP_LALT_LGUI`	`LAG_SWP`	Swap Left Alt and GUI
`MAGIC_UNSWAP_LALT_LGUI`	`LAG_NRM`	Unswap Left Alt and GUI
`MAGIC_SWAP_RALT_RGUI`	`RAG_SWP`	Swap Right Alt and GUI
`MAGIC_UNSWAP_RALT_RGUI`	`RAG_NRM`	Unswap Right Alt and GUI
`MAGIC_SWAP_ALT_GUI`	`AG_SWAP`	Swap Alt and GUI on both sides
`MAGIC_UNSWAP_ALT_GUI`	`AG_NORM`	Unswap Alt and GUI on both sides
`MAGIC_TOGGLE_ALT_GUI`	`AG_TOGG`	Toggle Alt and GUI swap on both sides
`MAGIC_NO_GUI`	`GUI_OFF`	Disable the GUI keys
`MAGIC_UNNO_GUI`	`GUI_ON`	Enable the GUI keys
`MAGIC_TOGGLE_GUI`	`GUI_TOG`	Toggles the status of the GUI keys
`MAGIC_SWAP_GRAVE_ESC`	`GE_SWAP`	Swap ` and Escape
`MAGIC_UNSWAP_GRAVE_ESC`	`GE_NORM`	Unswap ` and Escape
`MAGIC_SWAP_BACKSLASH_BACKSPACE`	`BS_SWAP`	Swap `\` and Backspace
`MAGIC_UNSWAP_BACKSLASH_BACKSPACE`	`BS_NORM`	Unswap `\` and Backspace
`MAGIC_HOST_NKRO`	`NK_ON`	Enable N-key rollover
`MAGIC_UNHOST_NKRO`	`NK_OFF`	Disable N-key rollover
`MAGIC_TOGGLE_NKRO`	`NK_TOGG`	Toggle N-key rollover
`MAGIC_EE_HANDS_LEFT`	`EH_LEFT`	Set the master half of a split keyboard as the left hand (for `EE_HANDS`)
`MAGIC_EE_HANDS_RIGHT`	`EH_RGHT`	Set the master half of a split keyboard as the right hand (for `EE_HANDS`)

Key	Aliases	Description
`MI_ON`		Turn MIDI on
`MI_OFF`		Turn MIDI off
`MI_TOG`		Toggle MIDI enabled
`MI_C`		C octave 0
`MI_Cs`	`MI_Db`	C♯/D♭ octave 0
`MI_D`		D octave 0
`MI_Ds`	`MI_Eb`	D♯/E♭ octave 0
`MI_E`		E octave 0
`MI_F`		F octave 0
`MI_Fs`	`MI_Gb`	F♯/G♭ octave 0
`MI_G`		G octave 0
`MI_Gs`	`MI_Gs`	G♯/A♭ octave 0
`MI_A`		A octave 0
`MI_As`	`MI_Bb`	A♯/B♭ octave 0
`MI_B`		B octave 0
`MI_C_1`		C octave 1
`MI_Cs_1`	`MI_Db_1`	C♯/D♭ octave 1
`MI_D_1`		D octave 1
`MI_Ds_1`	`MI_Eb_1`	D♯/E♭ octave 1
`MI_E_1`		E octave 1
`MI_F_1`		F octave 1
`MI_Fs_1`	`MI_Gb_1`	F♯/G♭ octave 1
`MI_G_1`		G octave 1
`MI_Gs_1`	`MI_Ab_1`	G♯/A♭ octave 1
`MI_A_1`		A octave 1
`MI_As_1`	`MI_Bb_1`	A♯/B♭ octave 1
`MI_B_1`		B octave 1
`MI_C_2`		C octave 2
`MI_Cs_2`	`MI_Db_2`	C♯/D♭ octave 2
`MI_D_2`		D octave 2
`MI_Ds_2`	`MI_Eb_2`	D♯/E♭ octave 2
`MI_E_2`		E octave 2
`MI_F_2`		F octave 2
`MI_Fs_2`	`MI_Gb_2`	F♯/G♭ octave 2
`MI_G_2`		G octave 2
`MI_Gs_2`	`MI_Ab_2`	G♯/A♭ octave 2
`MI_A_2`		A octave 2
`MI_As_2`	`MI_Bb_2`	A♯/B♭ octave 2
`MI_B_2`		B octave 2
`MI_C_3`		C octave 3
`MI_Cs_3`	`MI_Db_3`	C♯/D♭ octave 3
`MI_D_3`		D octave 3
`MI_Ds_3`	`MI_Eb_3`	D♯/E♭ octave 3
`MI_E_3`		E octave 3
`MI_F_3`		F octave 3
`MI_Fs_3`	`MI_Gb_3`	F♯/G♭ octave 3
`MI_G_3`		G octave 3
`MI_Gs_3`	`MI_Ab_3`	G♯/A♭ octave 3
`MI_A_3`		A octave 3
`MI_As_3`	`MI_Bb_3`	A♯/B♭ octave 3
`MI_B_3`		B octave 3
`MI_C_4`		C octave 4
`MI_Cs_4`	`MI_Db_4`	C♯/D♭ octave 4
`MI_D_4`		D octave 4
`MI_Ds_4`	`MI_Eb_4`	D♯/E♭ octave 4
`MI_E_4`		E octave 4
`MI_F_4`		F octave 4
`MI_Fs_4`	`MI_Gb_4`	F♯/G♭ octave 4
`MI_G_4`		G octave 4
`MI_Gs_4`	`MI_Ab_4`	G♯/A♭ octave 4
`MI_A_4`		A octave 4
`MI_As_4`	`MI_Bb_4`	A♯/B♭ octave 4
`MI_B_4`		B octave 4
`MI_C_5`		C octave 5
`MI_Cs_5`	`MI_Db_5`	C♯/D♭ octave 5
`MI_D_5`		D octave 5
`MI_Ds_5`	`MI_Eb_5`	D♯/E♭ octave 5
`MI_E_5`		E octave 5
`MI_F_5`		F octave 5
`MI_Fs_5`	`MI_Gb_5`	F♯/G♭ octave 5
`MI_G_5`		G octave 5
`MI_Gs_5`	`MI_Ab_5`	G♯/A♭ octave 5
`MI_A_5`		A octave 5
`MI_As_5`	`MI_Bb_5`	A♯/B♭ octave 5
`MI_B_5`		B octave 5
`MI_OCT_N2`		Set octave to -2
`MI_OCT_N1`		Set octave to -1
`MI_OCT_0`		Set octave to 0
`MI_OCT_1`		Set octave to 1
`MI_OCT_2`		Set octave to 2
`MI_OCT_3`		Set octave to 3
`MI_OCT_4`		Set octave to 4
`MI_OCT_5`		Set octave to 5
`MI_OCT_6`		Set octave to 6
`MI_OCT_7`		Set octave to 7
`MI_OCTD`		Move down an octave
`MI_OCTU`		Move up an octave
`MI_TRNS_N6`		Set transposition to -6 semitones
`MI_TRNS_N5`		Set transposition to -5 semitones
`MI_TRNS_N4`		Set transposition to -4 semitones
`MI_TRNS_N3`		Set transposition to -3 semitones
`MI_TRNS_N2`		Set transposition to -2 semitones
`MI_TRNS_N1`		Set transposition to -1 semitone
`MI_TRNS_0`		No transposition
`MI_TRNS_1`		Set transposition to +1 semitone
`MI_TRNS_2`		Set transposition to +2 semitones
`MI_TRNS_3`		Set transposition to +3 semitones
`MI_TRNS_4`		Set transposition to +4 semitones
`MI_TRNS_5`		Set transposition to +5 semitones
`MI_TRNS_6`		Set transposition to +6 semitones
`MI_TRNSD`		Decrease transposition
`MI_TRNSU`		Increase transposition
`MI_VEL_0`		Set velocity to 0
`MI_VEL_1`		Set velocity to 12
`MI_VEL_2`		Set velocity to 25
`MI_VEL_3`		Set velocity to 38
`MI_VEL_4`		Set velocity to 51
`MI_VEL_5`		Set velocity to 64
`MI_VEL_6`		Set velocity to 76
`MI_VEL_7`		Set velocity to 89
`MI_VEL_8`		Set velocity to 102
`MI_VEL_9`		Set velocity to 114
`MI_VEL_10`		Set velocity to 127
`MI_VELD`		Decrease velocity
`MI_VELU`		Increase velocity
`MI_CH1`		Set channel to 1
`MI_CH2`		Set channel to 2
`MI_CH3`		Set channel to 3
`MI_CH4`		Set channel to 4
`MI_CH5`		Set channel to 5
`MI_CH6`		Set channel to 6
`MI_CH7`		Set channel to 7
`MI_CH8`		Set channel to 8
`MI_CH9`		Set channel to 9
`MI_CH10`		Set channel to 10
`MI_CH11`		Set channel to 11
`MI_CH12`		Set channel to 12
`MI_CH13`		Set channel to 13
`MI_CH14`		Set channel to 14
`MI_CH15`		Set channel to 15
`MI_CH16`		Set channel to 16
`MI_CHD`		Decrease channel
`MI_CHU`		Increase channel
`MI_ALLOFF`		Stop all notes
`MI_SUS`		Sustain
`MI_PORT`		Portmento
`MI_SOST`		Sostenuto
`MI_SOFT`		Soft Pedal
`MI_LEG`		Legato
`MI_MOD`		Modulation
`MI_MODSD`		Decrease modulation speed
`MI_MODSU`		Increase modulation speed
`MI_BENDD`		Bend pitch down
`MI_BENDU`		Bend pitch up

Key	Aliases	Description
`KC_MS_UP`	`KC_MS_U`	Mouse Cursor Up
`KC_MS_DOWN`	`KC_MS_D`	Mouse Cursor Down
`KC_MS_LEFT`	`KC_MS_L`	Mouse Cursor Left
`KC_MS_RIGHT`	`KC_MS_R`	Mouse Cursor Right
`KC_MS_BTN1`	`KC_BTN1`	Mouse Button 1
`KC_MS_BTN2`	`KC_BTN2`	Mouse Button 2
`KC_MS_BTN3`	`KC_BTN3`	Mouse Button 3
`KC_MS_BTN4`	`KC_BTN4`	Mouse Button 4
`KC_MS_BTN5`	`KC_BTN5`	Mouse Button 5
`KC_MS_WH_UP`	`KC_WH_U`	Mouse Wheel Up
`KC_MS_WH_DOWN`	`KC_WH_D`	Mouse Wheel Down
`KC_MS_WH_LEFT`	`KC_WH_L`	Mouse Wheel Left
`KC_MS_WH_RIGHT`	`KC_WH_R`	Mouse Wheel Right
`KC_MS_ACCEL0`	`KC_ACL0`	Set mouse acceleration to 0
`KC_MS_ACCEL1`	`KC_ACL1`	Set mouse acceleration to 1
`KC_MS_ACCEL2`	`KC_ACL2`	Set mouse acceleration to 2

Key	Aliases	Description
`LCTL(kc)`	`C(kc)`	Hold Left Control and press `kc`
`LSFT(kc)`	`S(kc)`	Hold Left Shift and press `kc`
`LALT(kc)`	`A(kc)`, `LOPT(kc)`	Hold Left Alt and press `kc`
`LGUI(kc)`	`G(kc)`, `LCMD(kc)`, `LWIN(kc)`	Hold Left GUI and press `kc`
`RCTL(kc)`		Hold Right Control and press `kc`
`RSFT(kc)`		Hold Right Shift and press `kc`
`RALT(kc)`	`ROPT(kc)`, `ALGR(kc)`	Hold Right Alt (AltGr) and press `kc`
`RGUI(kc)`	`RCMD(kc)`, `LWIN(kc)`	Hold Right GUI and press `kc`
`LSG(kc)`	`SGUI(kc)`, `SCMD(kc)`, `SWIN(kc)`	Hold Left Shift and Left GUI and press `kc`
`LAG(kc)`		Hold Left Alt and Left GUI and press `kc`
`RSG(kc)`		Hold Right Shift and Right GUI and press `kc`
`RAG(kc)`		Hold Right Alt and Right GUI and press `kc`
`LCA(kc)`		Hold Left Control and Alt and press `kc`
`LSA(kc)`		Hold Left Shift and Left Alt and press `kc`
`RSA(kc)`	`SAGR(kc)`	Hold Right Shift and Right Alt (AltGr) and press `kc`
`RCS(kc)`		Hold Right Control and Right Shift and press `kc`
`LCAG(kc)`		Hold Left Control, Alt and GUI and press `kc`
`MEH(kc)`		Hold Left Control, Shift and Alt and press `kc`
`HYPR(kc)`		Hold Left Control, Shift, Alt and GUI and press `kc`
`KC_MEH`		Left Control, Shift and Alt
`KC_HYPR`		Left Control, Shift, Alt and GUI

Key	Aliases	Description
`MT(mod, kc)`		`mod` when held, `kc` when tapped
`LCTL_T(kc)`	`CTL_T(kc)`	Left Control when held, `kc` when tapped
`LSFT_T(kc)`	`SFT_T(kc)`	Left Shift when held, `kc` when tapped
`LALT_T(kc)`	`LOPT_T(kc)`, `ALT_T(kc)`, `OPT_T(kc)`	Left Alt when held, `kc` when tapped
`LGUI_T(kc)`	`LCMD_T(kc)`, `LWIN_T(kc)`, `GUI_T(kc)`, `CMD_T(kc)`, `WIN_T(kc)`	Left GUI when held, `kc` when tapped
`RCTL_T(kc)`		Right Control when held, `kc` when tapped
`RSFT_T(kc)`		Right Shift when held, `kc` when tapped
`RALT_T(kc)`	`ROPT_T(kc)`, `ALGR_T(kc)`	Right Alt (AltGr) when held, `kc` when tapped
`RGUI_T(kc)`	`RCMD_T(kc)`, `RWIN_T(kc)`	Right GUI when held, `kc` when tapped
`LSG_T(kc)`	`SGUI_T(kc)`, `SCMD_T(kc)`, `SWIN_T(kc)`	Left Shift and GUI when held, `kc` when tapped
`LAG_T(kc)`		Left Alt and GUI when held, `kc` when tapped
`RSG_T(kc)`		Right Shift and GUI when held, `kc` when tapped
`RAG_T(kc)`		Right Alt and GUI when held, `kc` when tapped
`LCA_T(kc)`		Left Control and Alt when held, `kc` when tapped
`LSA_T(kc)`		Left Shift and Left Alt when held, `kc` when tapped
`RSA_T(kc)`	`SAGR_T(kc)`	Right Shift and Right Alt (AltGr) when held, `kc` when tapped
`RCS_T(kc)`		Right Control and Right Shift when held, `kc` when tapped
`LCAG_T(kc)`		Left Control, Alt and GUI when held, `kc` when tapped
`RCAG_T(kc)`		Right Control, Alt and GUI when held, `kc` when tapped
`C_S_T(kc)`		Left Control and Shift when held, `kc` when tapped
`MEH_T(kc)`		Left Control, Shift and Alt when held, `kc` when tapped
`HYPR_T(kc)`	`ALL_T(kc)`	Left Control, Shift, Alt and GUI when held, `kc` when tapped - more info here

Key	Description
`DT_PRNT`	"Dynamic Tapping Term Print": Types the current tapping term, in milliseconds
`DT_UP`	"Dynamic Tapping Term Up": Increases the current tapping term by `DYNAMIC_TAPPING_TERM_INCREMENT`ms (5ms by default)
`DT_DOWN`	"Dynamic Tapping Term Down": Decreases the current tapping term by `DYNAMIC_TAPPING_TERM_INCREMENT`ms (5ms by default)

Key	Aliases	Description
`RGB_TOG`		Toggle RGB lighting on or off
`RGB_MODE_FORWARD`	`RGB_MOD`	Cycle through modes, reverse direction when Shift is held
`RGB_MODE_REVERSE`	`RGB_RMOD`	Cycle through modes in reverse, forward direction when Shift is held
`RGB_HUI`		Increase hue, decrease hue when Shift is held
`RGB_HUD`		Decrease hue, increase hue when Shift is held
`RGB_SAI`		Increase saturation, decrease saturation when Shift is held
`RGB_SAD`		Decrease saturation, increase saturation when Shift is held
`RGB_VAI`		Increase value (brightness), decrease value when Shift is held
`RGB_VAD`		Decrease value (brightness), increase value when Shift is held
`RGB_MODE_PLAIN`	`RGB_M_P`	Static (no animation) mode
`RGB_MODE_BREATHE`	`RGB_M_B`	Breathing animation mode
`RGB_MODE_RAINBOW`	`RGB_M_R`	Rainbow animation mode
`RGB_MODE_SWIRL`	`RGB_M_SW`	Swirl animation mode
`RGB_MODE_SNAKE`	`RGB_M_SN`	Snake animation mode
`RGB_MODE_KNIGHT`	`RGB_M_K`	"Knight Rider" animation mode
`RGB_MODE_XMAS`	`RGB_M_X`	Christmas animation mode
`RGB_MODE_GRADIENT`	`RGB_M_G`	Static gradient animation mode
`RGB_MODE_RGBTEST`	`RGB_M_T`	Red,Green,Blue test animation mode

Key	Description
`PRINT_ON`	Start printing everything the user types
`PRINT_OFF`	Stop printing everything the user types

Key	Aliases	Description
`KC_TILDE`	`KC_TILD`	`~`
`KC_EXCLAIM`	`KC_EXLM`	`!`
`KC_AT`		`@`
`KC_HASH`		`#`
`KC_DOLLAR`	`KC_DLR`	`$`
`KC_PERCENT`	`KC_PERC`	`%`
`KC_CIRCUMFLEX`	`KC_CIRC`	`^`
`KC_AMPERSAND`	`KC_AMPR`	`&`
`KC_ASTERISK`	`KC_ASTR`	`*`
`KC_LEFT_PAREN`	`KC_LPRN`	`(`
`KC_RIGHT_PAREN`	`KC_RPRN`	`)`
`KC_UNDERSCORE`	`KC_UNDS`	`_`
`KC_PLUS`		`+`
`KC_LEFT_CURLY_BRACE`	`KC_LCBR`	`{`
`KC_RIGHT_CURLY_BRACE`	`KC_RCBR`	`}`
`KC_PIPE`		`\|`
`KC_COLON`	`KC_COLN`	`:`
`KC_DOUBLE_QUOTE`	`KC_DQUO`, `KC_DQT`	`"`
`KC_LEFT_ANGLE_BRACKET`	`KC_LABK`, `KC_LT`	`<`
`KC_RIGHT_ANGLE_BRACKET`	`KC_RABK`, `KC_GT`	`>`
`KC_QUESTION`	`KC_QUES`	`?`

Key	Description
`PROGRAMMABLE_BUTTON_1`	Programmable button 1
`PROGRAMMABLE_BUTTON_2`	Programmable button 2
`PROGRAMMABLE_BUTTON_3`	Programmable button 3
`PROGRAMMABLE_BUTTON_4`	Programmable button 4
`PROGRAMMABLE_BUTTON_5`	Programmable button 5
`PROGRAMMABLE_BUTTON_6`	Programmable button 6
`PROGRAMMABLE_BUTTON_7`	Programmable button 7
`PROGRAMMABLE_BUTTON_8`	Programmable button 8
`PROGRAMMABLE_BUTTON_9`	Programmable button 9
`PROGRAMMABLE_BUTTON_10`	Programmable button 10
`PROGRAMMABLE_BUTTON_11`	Programmable button 11
`PROGRAMMABLE_BUTTON_12`	Programmable button 12
`PROGRAMMABLE_BUTTON_13`	Programmable button 13
`PROGRAMMABLE_BUTTON_14`	Programmable button 14
`PROGRAMMABLE_BUTTON_15`	Programmable button 15
`PROGRAMMABLE_BUTTON_16`	Programmable button 16
`PROGRAMMABLE_BUTTON_17`	Programmable button 17
`PROGRAMMABLE_BUTTON_18`	Programmable button 18
`PROGRAMMABLE_BUTTON_19`	Programmable button 19
`PROGRAMMABLE_BUTTON_20`	Programmable button 20
`PROGRAMMABLE_BUTTON_21`	Programmable button 21
`PROGRAMMABLE_BUTTON_22`	Programmable button 22
`PROGRAMMABLE_BUTTON_23`	Programmable button 23
`PROGRAMMABLE_BUTTON_24`	Programmable button 24
`PROGRAMMABLE_BUTTON_25`	Programmable button 25
`PROGRAMMABLE_BUTTON_26`	Programmable button 26
`PROGRAMMABLE_BUTTON_27`	Programmable button 27
`PROGRAMMABLE_BUTTON_28`	Programmable button 28
`PROGRAMMABLE_BUTTON_29`	Programmable button 29
`PROGRAMMABLE_BUTTON_30`	Programmable button 30
`PROGRAMMABLE_BUTTON_31`	Programmable button 31
`PROGRAMMABLE_BUTTON_32`	Programmable button 32
`PB_1` to `PB_32`	Aliases for keymaps

Key	Description
`SH_T(key)`	Sends `key` with a tap; momentary swap when held.
`SW_ON`	Turns on swapping and leaves it on.
`SW_OFF`	Turn off swapping and leaves it off. Good for returning to a known state.
`SH_MON`	Swaps hands when pressed, returns to normal when released (momentary).
`SH_MOFF`	Momentarily turns off swap.
`SH_TG`	Toggles swap on and off with every key press.
`SH_TT`	Toggles with a tap; momentary when held.
`SH_OS`	One shot swap hands: toggle while pressed or until next key press.

Key	Aliases	Description
`UC(c)`		Send Unicode code point `c`, up to `0x7FFF`
`X(i)`		Send Unicode code point at index `i` in `unicode_map`
`XP(i, j)`		Send Unicode code point at index `i`, or `j` if Shift/Caps is on
`UNICODE_MODE_FORWARD`	`UC_MOD`	Cycle through selected input modes
`UNICODE_MODE_REVERSE`	`UC_RMOD`	Cycle through selected input modes in reverse
`UNICODE_MODE_MAC`	`UC_M_MA`	Switch to macOS input
`UNICODE_MODE_LNX`	`UC_M_LN`	Switch to Linux input
`UNICODE_MODE_WIN`	`UC_M_WI`	Switch to Windows input
`UNICODE_MODE_BSD`	`UC_M_BS`	Switch to BSD input (not implemented)
`UNICODE_MODE_WINC`	`UC_M_WC`	Switch to Windows input using WinCompose

Key	Description
`OSM(mod)`	Hold `mod` for one keypress
`OSL(layer)`	Switch to `layer` for one keypress
`OS_ON`	Turns One Shot keys on
`OS_OFF`	Turns One Shot keys off
`OS_TOGG`	Toggles One Shot keys status

Key	Description
`KC_LCPO`	Left Control when held, `(` when tapped
`KC_RCPC`	Right Control when held, `)` when tapped
`KC_LSPO`	Left Shift when held, `(` when tapped
`KC_RSPC`	Right Shift when held, `)` when tapped
`KC_LAPO`	Left Alt when held, `(` when tapped
`KC_RAPC`	Right Alt when held, `)` when tapped
`KC_SFTENT`	Right Shift when held, Enter when tapped

66 KiB Raw Blame History

Keycodes Overview

Basic Keycodes :id=basic-keycodes

Quantum Keycodes :id=quantum-keycodes

Audio Keys :id=audio-keys

Backlighting :id=backlighting

Bluetooth :id=bluetooth

Dynamic Macros :id=dynamic-macros

Grave Escape :id=grave-escape

Key Lock :id=key-lock

Layer Switching :id=layer-switching

Leader Key :id=leader-key

Magic Keycodes :id=magic-keycodes

MIDI :id=midi

Mouse Keys :id=mouse-keys

Modifiers :id=modifiers

Mod-Tap Keys :id=mod-tap-keys

Tapping Term Keys :id=tapping-term-keys

RGB Lighting :id=rgb-lighting

RGB Matrix Lighting :id=rgb-matrix-lighting

Thermal Printer :id=thermal-printer

US ANSI Shifted Symbols :id=us-ansi-shifted-symbols

One Shot Keys :id=one-shot-keys

Programmable Button Support :id=programmable-button

Space Cadet :id=space-cadet

Swap Hands :id=swap-hands

Unicode Support :id=unicode-support

66 KiB

Raw Blame History