Full List
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
Linux1
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_BSPACE
KC_BSPC
Delete (Backspace)
KC_TAB
Tab
KC_SPACE
KC_SPC
Spacebar
KC_MINUS
KC_MINS
- and _
KC_EQUAL
KC_EQL
= and +
KC_LBRACKET
KC_LBRC
[ and {
KC_RBRACKET
KC_RBRC
] and }
KC_BSLASH
KC_BSLS
\ and \|
KC_NONUS_HASH
KC_NUHS
Non-US # and ~
KC_SCOLON
KC_SCLN
; and :
KC_QUOTE
KC_QUOT
' and "
KC_GRAVE
KC_GRV, KC_ZKHK
` and ~, JIS Zenkaku/Hankaku
KC_COMMA
KC_COMM
, and <
KC_DOT
. and >
KC_SLASH
KC_SLSH
/ and ?
KC_CAPSLOCK
KC_CLCK, 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_PSCREEN
KC_PSCR
Print Screen
✔2
KC_SCROLLLOCK
KC_SLCK, KC_BRMD
Scroll Lock, Brightness Down (macOS)
✔2
KC_PAUSE
KC_PAUS, KC_BRK, KC_BRMU
Pause, Brightness Up (macOS)
✔2
KC_INSERT
KC_INS
Insert
KC_HOME
Home
KC_PGUP
Page Up
KC_DELETE
KC_DEL
Forward Delete
KC_END
End
KC_PGDOWN
KC_PGDN
Page Down
KC_RIGHT
KC_RGHT
Right Arrow
KC_LEFT
Left Arrow
KC_DOWN
Down Arrow
KC_UP
Up Arrow
KC_NUMLOCK
KC_NLCK
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_BSLASH
KC_NUBS
Non-US \ and \|
KC_APPLICATION
KC_APP
Application (Windows Context Menu Key)
KC_POWER
System Power
✔3
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__MUTE
Mute
KC__VOLUP
Volume Up
KC__VOLDOWN
Volume Down
KC_LOCKING_CAPS
KC_LCAP
Locking Caps Lock
KC_LOCKING_NUM
KC_LNUM
Locking Num Lock
KC_LOCKING_SCROLL
KC_LSCR
Locking Scroll Lock
KC_KP_COMMA
KC_PCMM
Keypad ,
KC_KP_EQUAL_AS400
Keypad = on AS/400 keyboards
KC_INT1
KC_RO
JIS \ and _
KC_INT2
KC_KANA
JIS Katakana/Hiragana
KC_INT3
KC_JYEN
JIS ¥ and \|
KC_INT4
KC_HENK
JIS Henkan
KC_INT5
KC_MHEN
JIS Muhenkan
KC_INT6
JIS Numpad ,
KC_INT7
International 7
KC_INT8
International 8
KC_INT9
International 9
KC_LANG1
KC_HAEN
Hangul/English
KC_LANG2
KC_HANJ
Hanja
KC_LANG3
JIS Katakana
KC_LANG4
JIS Hiragana
KC_LANG5
JIS Zenkaku/Hankaku
KC_LANG6
Language 6
KC_LANG7
Language 7
KC_LANG8
Language 8
KC_LANG9
Language 9
KC_ALT_ERASE
KC_ERAS
Alternate Erase
KC_SYSREQ
SysReq/Attention
KC_CANCEL
Cancel
KC_CLEAR
KC_CLR
Clear
KC_PRIOR
Prior
KC_RETURN
Return
KC_SEPARATOR
Separator
KC_OUT
Out
KC_OPER
Oper
KC_CLEAR_AGAIN
Clear/Again
KC_CRSEL
CrSel/Props
KC_EXSEL
ExSel
KC_LCTRL
KC_LCTL
Left Control
KC_LSHIFT
KC_LSFT
Left Shift
KC_LALT
KC_LOPT
Left Alt (Option)
KC_LGUI
KC_LCMD, KC_LWIN
Left GUI (Windows/Command/Meta key)
KC_RCTRL
KC_RCTL
Right Control
KC_RSHIFT
KC_RSFT
Right Shift
KC_RALT
KC_ROPT, KC_ALGR
Right Alt (Option/AltGr)
KC_RGUI
KC_RCMD, KC_RWIN
Right GUI (Windows/Command/Meta key)
KC_SYSTEM_POWER
KC_PWR
System Power Down
✔3
KC_SYSTEM_SLEEP
KC_SLEP
System Sleep
✔3
KC_SYSTEM_WAKE
KC_WAKE
System Wake
✔3
KC_AUDIO_MUTE
KC_MUTE
Mute
KC_AUDIO_VOL_UP
KC_VOLU
Volume Up
✔4
KC_AUDIO_VOL_DOWN
KC_VOLD
Volume Down
✔4
KC_MEDIA_NEXT_TRACK
KC_MNXT
Next Track
✔5
KC_MEDIA_PREV_TRACK
KC_MPRV
Previous Track
✔5
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
✔5
KC_MEDIA_REWIND
KC_MRWD
Previous Track
✔6
✔5
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.

Quantum Keycodes :id=quantum-keycodes

See also: Quantum Keycodes
Key
Aliases
Description
RESET
Put the keyboard into bootloader mode for flashing
DEBUG
Toggle debug mode
EEPROM_RESET
EEP_RST
Reinitializes the keyboard's EEPROM (persistent memory)

Audio Keys :id=audio-keys

See also: Audio
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

Backlighting :id=backlighting

See also: Backlighting
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

Bluetooth :id=bluetooth

See also: Bluetooth
Key
Description
OUT_AUTO
Automatically switch between USB and Bluetooth