Keycodes.md

   1 # Overview
   2
   3 When defining a [keymap](https://github.com/qmk/qmk_firmware/blob/master/doc/keymap.md) each key needs a valid key definition. This page documents the symbols that correspond to keyboard scan codes that are available to you in QMK. They can be used by themselves or in combination with one of the [many functions available](https://github.com/qmk/qmk_firmware/wiki#going-beyond-the-keycodes) to customize your board.
   4
   5 # The Keycodes
   6
   7 ## Letters and Numbers
   8
   9 |KC_1|KC_2|KC_3|KC_4|KC_5|KC_6|KC_7|KC_8|
  10 |----|----|----|----|----|----|----|----|
  11 |KC_9|KC_0|KC_F1|KC_F2|KC_F3|KC_F4|KC_F5|KC_F6|
  12 |KC_F7|KC_F8|KC_F9|KC_F10|KC_F11|KC_F12|KC_F13|KC_F14|
  13 |KC_F15|KC_F16|KC_F17|KC_F18|KC_F19|KC_F20|KC_F21|KC_F22|
  14 |KC_F23|KC_F24|KC_A|KC_B|KC_C|KC_D|KC_E|KC_F|
  15 |KC_G|KC_H|KC_I|KC_J|KC_K|KC_L|KC_M|KC_N|
  16 |KC_O|KC_P|KC_Q|KC_R|KC_S|KC_T|KC_U|KC_V|
  17 |KC_W|KC_X|KC_Y|KC_Z|||||
  18
  19 ## Punctuation
  20
  21 |Long Name|Short Name|Description|
  22 |---------|----------|-----------|
  23 |KC_ENTER|KC_ENT|Return (ENTER)|
  24 |KC_ESCAPE|KC_ESC|ESCAPE|
  25 |KC_BSPACE|KC_BSPC|DELETE (Backspace)|
  26 |KC_TAB||Tab|
  27 |KC_SPACE|KC_SPC|Spacebar|
  28 |KC_MINUS|KC_MINS|- and (underscore)|
  29 |KC_EQUAL|KC_EQL|= and +|
  30 |KC_LBRACKET|KC_LBRC|[ and {|
  31 |KC_RBRACKET|KC_RBRC|] and }|
  32 |KC_BSLASH|KC_BSLS|\\ and \||
  33 |KC_NONUS_HASH|KC_NUHS|Non-US # and ~|
  34 |KC_NONUS_BSLASH|KC_NUBS|Non-US \ and |
  35 |KC_INT1|KC_RO|JIS \\ and \||
  36 |KC_INT2|KC_KANA|International216|
  37 |KC_INT3|KC_JYEN|Yen Symbol (¥)|
  38 |KC_SCOLON|KC_SCLN|; and :|
  39 |KC_QUOTE|KC_QUOT|‘ and “|
  40 |KC_GRAVE|KC_GRV|Grave Accent and Tilde|
  41 |KC_COMMA|KC_COMM|, and <|
  42 |KC_DOT||. and >|
  43 |KC_SLASH|KC_SLSH|/ and ?|
  44 |KC_CAPSLOCK|KC_CAPS|Caps Lock|
  45
  46 ## Modifiers
  47
  48 |Long Name|Short Name|Description|
  49 |---------|----------|-----------|
  50 |KC_LCTRL|KC_LCTL|LeftControl|
  51 |KC_LSHIFT|KC_LSFT|LeftShift|
  52 |KC_LALT||LeftAlt|
  53 |KC_LGUI||Left GUI(Windows/Apple/Meta key)|
  54 |KC_RCTRL|KC_RCTL|RightControl|
  55 |KC_RSHIFT|KC_RSFT|RightShift|
  56 |KC_RALT||RightAlt|
  57 |KC_RGUI||Right GUI(Windows/Apple/Meta key)|
  58 |KC_LOCKING_CAPS||Locking Caps Lock12|
  59 |KC_LOCKING_NUM||Locking Num Lock12|
  60 |KC_LOCKING_SCROLL||Locking Scroll Lock12|
  61 |KC_INT4|KC_HENK|JIS Henken|
  62 |KC_INT5|KC_MHEN|JIS Muhenken|
  63
  64 ## Commands
  65
  66 |Long Name|Short Name|Description|
  67 |---------|----------|-----------|
  68 |KC_PSCREEN|KC_PSCR|PrintScreen1|
  69 |KC_SCKLOCK|KC_SLCK|Scroll Lock11|
  70 |KC_PAUSE|KC_PAUS|Pause1|
  71 |KC_INSERT|KC_INS|Insert1|
  72 |KC_HOME||Home1|
  73 |KC_PGUP||PageUp1|
  74 |KC_DELETE|KC_DEL|Delete Forward|
  75 |KC_END||End1|
  76 |KC_PGDOWN|KC_PGDN|PageDown1|
  77 |KC_RIGHT|KC_RGHT|RightArrow1|
  78 |KC_LEFT||LeftArrow1|
  79 |KC_DOWN||DownArrow1|
  80 |KC_UP||UpArrow1|
  81 |KC_APPLICATION|KC_APP|Application10|
  82 |KC_POWER||Power9|
  83 |KC_EXECUTE||Execute|
  84 |KC_HELP||Help|
  85 |KC_MENU||Menu|
  86 |KC_SELECT||Select|
  87 |KC_STOP||Stop|
  88 |KC_AGAIN||Again|
  89 |KC_UNDO||Undo|
  90 |KC_CUT||Cut|
  91 |KC_COPY||Copy|
  92 |KC_PASTE||Paste|
  93 |KC_FIND||Find|
  94 |KC__MUTE||Mute|
  95 |KC__VOLUP||Volume Up|
  96 |KC__VOLDOWN||Volume Down|
  97 |KC_ALT_ERASE||Alternate Erase7|
  98 |KC_SYSREQ||SysReq/Attention1|
  99 |KC_CANCEL||Cancel|
 100 |KC_CLEAR||Clear|
 101 |KC_PRIOR||Prior|
 102 |KC_RETURN||Return|
 103 |KC_SEPARATOR||Separator|
 104 |KC_OUT||Out|
 105 |KC_OPER||Oper|
 106 |KC_CLEAR_AGAIN||Clear/Again|
 107 |KC_CRSEL||CrSel/Props|
 108 |KC_EXSEL||ExSel|
 109 |KC_SYSTEM_POWER|KC_PWR|System Power Down|
 110 |KC_SYSTEM_SLEEP|KC_SLEP|System Sleep|
 111 |KC_SYSTEM_WAKE|KC_WAKE|System Wake|
 112 |KC_AUDIO_MUTE|KC_MUTE||
 113 |KC_AUDIO_VOL_UP|KC_VOLU||
 114 |KC_AUDIO_VOL_DOWN|KC_VOLD||
 115 |KC_MEDIA_NEXT_TRACK|KC_MNXT||
 116 |KC_MEDIA_PREV_TRACK|KC_MPRV||
 117 |KC_MEDIA_STOP|KC_MSTP||
 118 |KC_MEDIA_PLAY_PAUSE|KC_MPLY||
 119 |KC_MEDIA_SELECT|KC_MSEL||
 120 |KC_MAIL|KC_MAIL||
 121 |KC_CALCULATOR|KC_CALC||
 122 |KC_MY_COMPUTER|KC_MYCM||
 123 |KC_WWW_SEARCH|KC_WSCH||
 124 |KC_WWW_HOME|KC_WHOM||
 125 |KC_WWW_BACK|KC_WBAK||
 126 |KC_WWW_FORWARD|KC_WFWD||
 127 |KC_WWW_STOP|KC_WSTP||
 128 |KC_WWW_REFRESH|KC_WREF||
 129 |KC_WWW_FAVORITES|KC_WFAV||
 130
 131 ## Numpad
 132
 133 |Long Name|Short Name|Description|
 134 |---------|----------|-----------|
 135 |KC_NUMLOCK|KC_NLCK|Keypad Num Lock and Clear11|
 136 |KC_KP_SLASH|KC_PSLS|Keypad /|
 137 |KC_KP_ASTERISK|KC_PAST|Keypad *|
 138 |KC_KP_MINUS|KC_PMNS|Keypad -|
 139 |KC_KP_PLUS|KC_PPLS|Keypad +|
 140 |KC_KP_ENTER|KC_PENT|Keypad ENTER5|
 141 |KC_KP_1|KC_P1|Keypad 1 and End|
 142 |KC_KP_2|KC_P2|Keypad 2 and Down Arrow|
 143 |KC_KP_3|KC_P3|Keypad 3 and PageDn|
 144 |KC_KP_4|KC_P4|Keypad 4 and Left Arrow|
 145 |KC_KP_5|KC_P5|Keypad 5|
 146 |KC_KP_6|KC_P6|Keypad 6 and Right Arrow|
 147 |KC_KP_7|KC_P7|Keypad 7 and Home|
 148 |KC_KP_8|KC_P8|Keypad 8 and Up Arrow|
 149 |KC_KP_9|KC_P9|Keypad 9 and PageUp|
 150 |KC_KP_0|KC_P0|Keypad 0 and Insert|
 151 |KC_KP_DOT|KC_PDOT|Keypad . and Delete|
 152 |KC_KP_EQUAL|KC_PEQL|Keypad =|
 153 |KC_KP_COMMA|KC_PCMM|Keypad Comma27|
 154 |KC_KP_EQUAL_AS400||Keypad Equal Sign29|
 155
 156 ## Special Keys
 157
 158 |Long Name|Short Name|Description|
 159 |---------|----------|-----------|
 160 |KC_NO||Ignore this key. (NOOP) |
 161
 162 ## Mousekey
 163
 164 |Long Name|Short Name|Description|
 165 |---------|----------|-----------|
 166 |KC_MS_UP|KC_MS_U|Mouse Cursor Up|
 167 |KC_MS_DOWN|KC_MS_D|Mouse Cursor Down|
 168 |KC_MS_LEFT|KC_MS_L|Mouse Cursor Left|
 169 |KC_MS_RIGHT|KC_MS_R|Mouse Cursor Right|
 170 |KC_MS_BTN1|KC_BTN1|Mouse Button 1|
 171 |KC_MS_BTN2|KC_BTN2|Mouse Button 2|
 172 |KC_MS_BTN3|KC_BTN3|Mouse Button 3|
 173 |KC_MS_BTN4|KC_BTN4|Mouse Button 4|
 174 |KC_MS_BTN5|KC_BTN5|Mouse Button 5|
 175 |KC_MS_WH_UP|KC_WH_U|Mouse Wheel Up|
 176 |KC_MS_WH_DOWN|KC_WH_D|Mouse Wheel Down|
 177 |KC_MS_WH_LEFT|KC_WH_L|Mouse Wheel Left|
 178 |KC_MS_WH_RIGHT|KC_WH_R|Mouse Wheel Right|
 179 |KC_MS_ACCEL0|KC_ACL0|Mouse Acceleration 0|
 180 |KC_MS_ACCEL1|KC_ACL1|Mouse Acceleration 1|
 181 |KC_MS_ACCEL2|KC_ACL2|Mouse Acceleration 2|