Awesome ZMK

A collection of useful resources, drivers, behaviors, tools, and more for the ZMK firmware.

Table of Contents

• Official Resources
• Behaviors
• Drivers
• Other Resources

---

Official Resources

• Official website
• Source code
• Discord

Tools

• keymap-drawer - Visualizes keymaps that use advanced features like hold-taps and combos, with automatic parsing.
• keymap-editor - Graphical keymap editor.
• zmk-locale-generator - Python module to generate localized keyboard layout headers for ZMK Firmware.

Behaviors

• dhruvinsh/zmk-tri-state - Tri-state (swapper) implementation.
• dhruvinsh/zmk-num-word - Num-word implementation.
• badjeff/zmk-split-peripheral-input-relay - This module adds an input relay to the input subsystem for ZMK. This would allow, for example, sending trackpoint events from the peripheral to the center split.
• badjeff/zmk-split-peripheral-output-relay - This module adds an output relay for ZMK. This allows sending events from the central to peripherals, for example, to trigger haptic feedback or LEDs on certain events.
• badjeff/zmk-behavior-insomnia - Insomnia Behavior for ZMK. This module prevents the board from entering sleep mode if BLE is connected, useful for multi-peripheral setups to avoid continuous BLE advertisement scanning.
• urob/zmk-auto-layer - Auto-layer (including num-word) implementation.
• urob/zmk-adaptive-key - A ZMK module adding a adaptive-key behavior.
• urob/zmk-leader-key - A ZMK module adding a leader-key behavior.
• ssbb/zmk-antecedent-morph - ZMK Antecedent Morph Behavior aka Adaptive Keys.
• ssbb/zmk-deadkey-slayer - A ZMK module to drop illegal keycodes.
• ssbb/zmk-listeners- ZMK module to invoke behaviors on certain events.

Drivers

• caksoylar/zmk-rgbled-widget - A ZMK module to add battery & BT indicators using an RGB LED (like in Xiao BLEs).
• badjeff/zmk-drv2605-driver - DRV2605 haptic feedback driver.
• badjeff/zmk-pmw3610-driver - PMW3610 sensor driver.
• badjeff/zmk-adns9800-driver - ADNS9800 sensor driver.
• badjeff/kb_zmk_ps2_mouse_trackpoint_driver - PS/2 trackpoint driver fork updated for mainline ZMK.
• inorichi/zmk-pmw3610-driver - PMW3610 sensor driver.
• infused-kim/zmk-ps2-mouse-trackpoint-driver - PS/2 trackpoint driver.
• petejohanson/ec-support-zmk-module - Electrostatic Capacitive (Topre) matrix scan implementation.

Other

• Hammerbeam Slideshow - A zmk module to implement a slideshow of 30 of Hammerbeam's 1 bit art on the peripheral (right) nice!view display.
• nice!view Elemental - A bold while minimalistic interface for your keyboard's display.

Guides

• ZMK design guide - A short hardware-designguide for ZMK keyboards.
• Maintaining a personal ZMK fork - A cookbook approach to maintaining a personal ZMK fork.