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