]> git.donarmstrong.com Git - qmk_firmware.git/blob - docs/keycodes.md
Fix location of where the make command should be run
[qmk_firmware.git] / docs / keycodes.md
1 # Overview
2
3 When defining a [keymap](keymap.md) each key needs a valid key definition.
4
5 This page documents the symbols that correspond to keycodes that are available to you in QMK.
6
7 ## Basic keycodes (`0x00` - `0xFF`)
8
9 [Basic keycodes](basic_keycodes.md) in QMK are based on [HID Usage Keyboard/Keypad Page(0x07)](http://www.usb.org/developers/hidpage/Hut1_12v2.pdf) with following exceptions:
10
11 * `KC_NO` = 0 for no action
12 * `KC_TRNS` = 1 for layer transparency
13 * internal special keycodes in the `0xA5-DF` range (tmk heritage).
14
15 ## Quantum keycodes (`0x0100` - `0xFFFF`)
16
17 [Quantum keycodes](quantum_keycodes.md) allow for easier customisation of your keymap than the basic ones provide, without having to define custom actions.