QMK has lots of features to explore, and a good deal of reference documentation to dig through. Most features are taken advantage of by modifying your keymap, and changing the keycodes. Need help? Check out the support page to see how you can get help using QMK. There are a lot of ways you can contribute to the QMK Community.

Make it yours with a completely customizable, powerful, and enjoyable firmware experience. Supporting over 3000 keyboards, with compatibility expanding frequently. Providing helpful, encouraging, and kind support and feedback for users and integrators. This project is maintained by QMK collaborators and contributors like you!

There are three main types of configuration files in QMK: This page will only discuss the first two types, config.h and rules.mk. While not all settings have data-driven equivalents yet, keyboard makers are encouraged to utilize the info.json file to set the metadata for their boards when possible. See the info.json Format page for more details.

This page documents the symbols that correspond to keycodes that are available to you in QMK. This is a reference only. Each group of keys links to the page documenting their functionality in more detail. See also: Basic Keycodes. 1 and ! / and ? 1.

QMK has lots of features to explore, and a good deal of reference documentation to dig through. Most features are taken advantage of by modifying your keymap, and changing the keycodes. Need help? Check out the support page to see how you can get help using QMK.

QMK Firmware fills the role of that software, detecting button presses and passing that information on to the host computer. When you build your custom keymap, you are creating an executable program for your keyboard. QMK tries to put a lot of power into your hands by making easy things easy, and hard things possible.

Open-source keyboard firmware for Atmel AVR and Arm USB families - qmk/qmk_firmware

Open-source keyboard firmware for Atmel AVR and Arm USB families - qmk/qmk_firmware

SonixQMK is an open source community porting QMK to the Sonix SN32 series. The community maintains forks of QMK tools on SonixQMK Firmware, SonixQMK Toolbox, as well as original tools like SonixFlasher, Jumploader, a database of compatible keyboards, and this documentation with the help of community members like you. Get Started

What is QMK Firmware? QMK (Quantum Mechanical Keyboard) is an open source community centered around developing computer input devices. The community encompasses all sorts of input devices, such as keyboards, mice, and MIDI devices.