qmk_firmware/docs/features.md

# QMK Features

QMK has a staggering number of features for building your keyboard. It can take some time to understand all of them and determine which one will achieve your goal.


* [Advanced Keycodes](feature_advanced_keycodes.md) - Change layers, dual-action keys, and more. Go beyond typing simple characters.
* [Audio](feature_audio.md) - Connect a speaker to your keyboard for audio feedback, midi support, and music mode.
* [Auto Shift](feature_auto_shift.md) - Tap for the normal key, hold slightly longer for its shifted state.
* [Backlight](feature_backlight.md) - LED lighting support for your keyboard.
* [Bluetooth](feature_bluetooth.md) - BlueTooth support for your keyboard.
* [Bootmagic](feature_bootmagic.md) - Adjust the behavior of your keyboard using hotkeys.
* [Combos](feature_combo.md) - Custom actions for multiple key holds.
* [Command](feature_command.md) - Runtime version of bootmagic (Formerly known as "Magic").
* [Debounce API](feature_debounce_type.md) - Customization of debouncing algorithms, and the ability to add more/custom debouncing. 
* [Dynamic Macros](feature_dynamic_macros.md) - Record and playback macros from the keyboard itself.
* [Encoders](feature_encoders.md) - Rotary encoders! 
* [Grave Escape](feature_grave_esc.md) - Lets you use a single key for Esc and Grave. 
* [Haptic Feedback](feature_haptic_feedback.md) - Add haptic feedback drivers to your board.
* [HD44780 LCD Display](feature_hd44780.md) - Support for LCD character displays using the HD44780 standard.
* [Key Lock](feature_key_lock.md) - Lock a key in the "down" state.
* [Layouts](feature_layouts.md) - Use one keymap with any keyboard that supports your layout.
* [Leader Key](feature_leader_key.md) - Tap the leader key followed by a sequence to trigger custom behavior.
* [LED Matrix](feature_led_matrix.md) - LED Matrix single color lights for per key lighting (Single Color, not RGB).
* [Macros](feature_macros.md) - Send multiple key presses when pressing only one physical key.
* [Mouse keys](feature_mouse_keys.md) - Control your mouse pointer from your keyboard.
* [OLED Driver](feature_oled_driver.md) - Add OLED screens to your keyboard.
* [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys) - Sticky Keys, lets you hit a key rather than holding it.
* [Pointing Device](feature_pointing_device.md) - Framework for connecting your custom pointing device to your keyboard.
* [PS2 Mouse](feature_ps2_mouse.md) - Driver for connecting a PS/2 mouse directly to your keyboard.
* [RGB Light](feature_rgblight.md) - RGB lighting for your keyboard.
* [RGB Matrix](feature_rgb_matrix.md) - RGB Matrix lights for per key lighting.
* [Space Cadet](feature_space_cadet.md) - Use your left/right shift keys to type parenthesis and brackets.
* [Stenography](feature_stenography.md) - Put your keyboard into Plover mode for stenography use.
* [Swap Hands](feature_swap_hands.md) - Mirror your keyboard for one handed usage.
* [Tap Dance](feature_tap_dance.md) - Make a single key do as many things as you want.
* [Terminal](feature_terminal.md) - CLI interface to the internals of your keyboard.
* [Thermal Printer](feature_thermal_printer.md) - Connect a thermal printer to your keyboard to be able to toggle on a printed log of everything you type.
* [Unicode](feature_unicode.md) - Unicode input support.
* [Userspace](feature_userspace.md) - Share code between different keymaps and keyboards.
* [Velocikey](feature_velocikey.md) - Allows changes in RGB animation speed based on WPM/Typing speed.
testing out new home 2017-06-29 18:13:44 +02:00			`# QMK Features`

Fix some of the more obvious typos 2017-12-09 06:49:07 +01:00			`QMK has a staggering number of features for building your keyboard. It can take some time to understand all of them and determine which one will achieve your goal.`
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 05:34:28 +02:00

Dedupe shifted keycodes listing 2018-08-06 05:08:26 +02:00			`* [Advanced Keycodes](feature_advanced_keycodes.md) - Change layers, dual-action keys, and more. Go beyond typing simple characters.`
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 05:34:28 +02:00			`* [Audio](feature_audio.md) - Connect a speaker to your keyboard for audio feedback, midi support, and music mode.`
Added missing RGB and Auto Shift in main feature list. Also standardized on period at the end of each feature list item. 2017-10-29 07:02:49 +01:00			`* [Auto Shift](feature_auto_shift.md) - Tap for the normal key, hold slightly longer for its shifted state.`
			`* [Backlight](feature_backlight.md) - LED lighting support for your keyboard.`
Add missing links to features page and sidebar section 2019-05-21 22:15:59 +02:00			`* [Bluetooth](feature_bluetooth.md) - BlueTooth support for your keyboard.`
Added missing RGB and Auto Shift in main feature list. Also standardized on period at the end of each feature list item. 2017-10-29 07:02:49 +01:00			`* [Bootmagic](feature_bootmagic.md) - Adjust the behavior of your keyboard using hotkeys.`
Fixed incorrect link to feature_combo.md in features.md docs file. Was linked to feature_combos.md, but _sidebar.md, _summary.md, and config_options.md all link to feature_combo.md. Assuming that it should not be pluralized. (#4411) 2018-11-13 01:46:01 +01:00			`* [Combos](feature_combo.md) - Custom actions for multiple key holds.`
Update Features page to reflect all of the features linked in the sidebar/summary 2018-10-28 17:29:18 +01:00			`* [Command](feature_command.md) - Runtime version of bootmagic (Formerly known as "Magic").`
Fix links Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> 2019-05-23 05:55:52 +02:00			`* [Debounce API](feature_debounce_type.md) - Customization of debouncing algorithms, and the ability to add more/custom debouncing.`
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 05:34:28 +02:00			`* [Dynamic Macros](feature_dynamic_macros.md) - Record and playback macros from the keyboard itself.`
Fix Encoder documentation (#4861) 2019-01-18 16:33:43 +01:00			`* [Encoders](feature_encoders.md) - Rotary encoders!`
Update Features page to reflect all of the features linked in the sidebar/summary 2018-10-28 17:29:18 +01:00			`* [Grave Escape](feature_grave_esc.md) - Lets you use a single key for Esc and Grave.`
Add missing links to features page and sidebar section 2019-05-21 22:15:59 +02:00			`* [Haptic Feedback](feature_haptic_feedback.md) - Add haptic feedback drivers to your board.`
Integrating Peter Fleury's HD44780 LCD library (#3209) * integrated Peter Fleury's LCD library for HD44780 LCDs * fixed typo * cleanup finished * add documentation * added HD44780 documentation * removed keyboard from .gitmodules * resolved merge conflict * removed edit of kira75s rules.mk made by merge * moved hd44780 to drivers/avr * Added licence info to hd44780 files * Added link to hd44780 docs. 2018-07-15 19:31:45 +02:00			`* [HD44780 LCD Display](feature_hd44780.md) - Support for LCD character displays using the HD44780 standard.`
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 05:34:28 +02:00			`* [Key Lock](feature_key_lock.md) - Lock a key in the "down" state.`
			`* [Layouts](feature_layouts.md) - Use one keymap with any keyboard that supports your layout.`
			`* [Leader Key](feature_leader_key.md) - Tap the leader key followed by a sequence to trigger custom behavior.`
Add LED Matrix to Features list for easy reference (#5280) 2019-03-04 00:29:29 +01:00			`* [LED Matrix](feature_led_matrix.md) - LED Matrix single color lights for per key lighting (Single Color, not RGB).`
Added missing RGB and Auto Shift in main feature list. Also standardized on period at the end of each feature list item. 2017-10-29 07:02:49 +01:00			`* [Macros](feature_macros.md) - Send multiple key presses when pressing only one physical key.`
			`* [Mouse keys](feature_mouse_keys.md) - Control your mouse pointer from your keyboard.`
Fix links Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> 2019-05-23 05:55:52 +02:00			`* [OLED Driver](feature_oled_driver.md) - Add OLED screens to your keyboard.`
Fix typo 2019-05-23 19:29:18 +02:00			`* [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys) - Sticky Keys, lets you hit a key rather than holding it.`
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 05:34:28 +02:00			`* [Pointing Device](feature_pointing_device.md) - Framework for connecting your custom pointing device to your keyboard.`
Fix some of the more obvious typos 2017-12-09 06:49:07 +01:00			`* [PS2 Mouse](feature_ps2_mouse.md) - Driver for connecting a PS/2 mouse directly to your keyboard.`
Added missing RGB and Auto Shift in main feature list. Also standardized on period at the end of each feature list item. 2017-10-29 07:02:49 +01:00			`* [RGB Light](feature_rgblight.md) - RGB lighting for your keyboard.`
Make sure new features (RGB Matrix) are actually listed 2018-05-16 04:24:47 +02:00			`* [RGB Matrix](feature_rgb_matrix.md) - RGB Matrix lights for per key lighting.`
[Docs] Fix Space Cadet link (#5825) Fix broken Space Cadet link in Features list 2019-05-09 06:45:00 +02:00			`* [Space Cadet](feature_space_cadet.md) - Use your left/right shift keys to type parenthesis and brackets.`
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 05:34:28 +02:00			`* [Stenography](feature_stenography.md) - Put your keyboard into Plover mode for stenography use.`
Make sure new features (RGB Matrix) are actually listed 2018-05-16 04:24:47 +02:00			`* [Swap Hands](feature_swap_hands.md) - Mirror your keyboard for one handed usage.`
Added missing RGB and Auto Shift in main feature list. Also standardized on period at the end of each feature list item. 2017-10-29 07:02:49 +01:00			`* [Tap Dance](feature_tap_dance.md) - Make a single key do as many things as you want.`
			`* [Terminal](feature_terminal.md) - CLI interface to the internals of your keyboard.`
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 05:34:28 +02:00			`* [Thermal Printer](feature_thermal_printer.md) - Connect a thermal printer to your keyboard to be able to toggle on a printed log of everything you type.`
			`* [Unicode](feature_unicode.md) - Unicode input support.`
Added missing RGB and Auto Shift in main feature list. Also standardized on period at the end of each feature list item. 2017-10-29 07:02:49 +01:00			`* [Userspace](feature_userspace.md) - Share code between different keymaps and keyboards.`
Fix links Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> 2019-05-23 05:55:52 +02:00			`* [Velocikey](feature_velocikey.md) - Allows changes in RGB animation speed based on WPM/Typing speed.`