qmk_firmware/docs/quantum_keycodes.md

# Quantum Keycodes

Quantum keycodes allow for easier customisation of your keymap than the basic ones provide, without having to define custom actions.

All keycodes within quantum are numbers between `0x0000` and `0xFFFF`. Within your `keymap.c` it may look like you have functions and other special cases, but ultimately the C preprocessor will translate those into a single 4 byte integer. QMK has reserved `0x0000` through `0x00FF` for standard keycodes. These are keycodes such as `KC_A`, `KC_1`, and `KC_LCTL`, which are basic keys defined in the USB HID specification. 

On this page we have documented keycodes between `0x00FF` and `0xFFFF` which are used to implement advanced quantum features. If you define your own custom keycodes they will be put into this range as well.

## QMK keycodes

|Name|Description|
|----|-----------|
|`RESET`|Put the keyboard into DFU mode for flashing|
|`DEBUG`|Toggles debug mode|
|`KC_GESC`/`GRAVE_ESC`|Acts as escape when pressed normally but when pressed with Shift or GUI will send a ```|
|`KC_LSPO`|Left shift when held, open paranthesis when tapped|
|`KC_RSPC`|Right shift when held, close paranthesis when tapped|
|`KC_LEAD`|The [leader key](feature_leader_key.md)|
|`KC_LOCK`|The [lock key](feature_key_lock.md)|
|`FUNC(n)`/`F(n)`|Call `fn_action(n)` (deprecated)|
|`M(n)`|to call macro n|
|`MACROTAP(n)`|to macro-tap n idk FIXME|
restructure keycode docs 2017-06-29 04:15:07 +00:00			`# Quantum Keycodes`

break up keymaps and quantum keycodes into files by feature 2017-08-07 00:51:42 +00:00			`Quantum keycodes allow for easier customisation of your keymap than the basic ones provide, without having to define custom actions.`

Flesh out the quantum_keycodes documentation 2017-06-29 06:52:08 +00:00			All keycodes within quantum are numbers between `0x0000` and `0xFFFF`. Within your `keymap.c` it may look like you have functions and other special cases, but ultimately the C preprocessor will translate those into a single 4 byte integer. QMK has reserved `0x0000` through `0x00FF` for standard keycodes. These are keycodes such as `KC_A`, `KC_1`, and `KC_LCTL`, which are basic keys defined in the USB HID specification.

break up keymaps and quantum keycodes into files by feature 2017-08-07 00:51:42 +00:00			On this page we have documented keycodes between `0x00FF` and `0xFFFF` which are used to implement advanced quantum features. If you define your own custom keycodes they will be put into this range as well.
Flesh out the quantum_keycodes documentation 2017-06-29 06:52:08 +00:00
Update a bunch of docs 2017-07-03 08:30:36 +00:00			`## QMK keycodes`
Flesh out the quantum_keycodes documentation 2017-06-29 06:52:08 +00:00
			`\|Name\|Description\|`
			`\|----\|-----------\|`
			\|`RESET`\|Put the keyboard into DFU mode for flashing\|
			\|`DEBUG`\|Toggles debug mode\|
correct tilde to grave 2017-08-13 19:20:04 +00:00			\|`KC_GESC`/`GRAVE_ESC`\|Acts as escape when pressed normally but when pressed with Shift or GUI will send a ```\|
Flesh out the quantum_keycodes documentation 2017-06-29 06:52:08 +00:00			\|`KC_LSPO`\|Left shift when held, open paranthesis when tapped\|
			\|`KC_RSPC`\|Right shift when held, close paranthesis when tapped\|
Doc updates from going through every file 2017-08-07 03:57:57 +00:00			\|`KC_LEAD`\|The [leader key](feature_leader_key.md)\|
Restructure the hardware and feature docs to make things easier to find (#1888) * fix #1313 by documenting more config.h options * Clean up and organize documentation 2017-10-25 03:34:28 +00:00			\|`KC_LOCK`\|The [lock key](feature_key_lock.md)\|
Doc updates from going through every file 2017-08-07 03:57:57 +00:00			\|`FUNC(n)`/`F(n)`\|Call `fn_action(n)` (deprecated)\|
Flesh out the quantum_keycodes documentation 2017-06-29 06:52:08 +00:00			\|`M(n)`\|to call macro n\|
			\|`MACROTAP(n)`\|to macro-tap n idk FIXME\|