@drashna's QMK Community Modules

These rely on QMK Firmware 0.28.0 or later, merged in 2025q1.

In order to use these community modules with a build of QMK, this repo should be added to your external userspace as a submodule.

cd /path/to/your/external/userspace
git submodule add https://github.com/drashna/qmk_modules.git modules/drashna
git submodule update --init --recursive

Each child directory is a separate module, and has instructions on how to add it to your build.

Debugging Modules

These are modules that add additional debug functionality.

Module	Description
Console Keylogging	Adds the FAQ Debugging console code as a module.
I2C Scanner	Adds an i2c scanner as a community module.

Display Modules

These are modules that add additional functionality to displays (both OLED driver, and Quantum Painter)

Module	Description
Bongocats	Gods, help me.
Display Menu	Adds support for @drashna's custom on-screen display code.
QP Helpers	Adds useful functions for Quantum Painter based displays. Mostly, this includes a simple line graph, currently.

Hardware Modules

These are modules that extend hardware functionality, such as extending (unused) hardware functionality or add drivers for new hardware.

Module	Description
KVM Helper	Improves USB stability when using a keyboard through a KVM switch by detecting stuck enumeration states and performing a soft reset to recover.
RTC	Adds support for hardware RTC functionality (RP2040 built in RTC not working).
Spacemouse Module	Add basic support for UART based Spacemouse Module. Lacks pointing device support intentionally, as it could be used for many other things too.
Watchdog	Adds hardware watchdog support as a community module. Additional config required.

Pointing Device Modules

These are modules that add additional functionality to displays (both OLED driver, and Quantum Painter)

Module	Description
Drag Scroll	Adds Drag Scrolling support as a module.
Pointing Device Accel	Adds maccel/pointing device acceleration support, ported directly from Burkfers and Wimad's implementation.
Pointing Device Gestures	Adds a module that allows triggering behavior based on which of the cardinal and ordinal direction moved.
Pointing Device Smoothing	Smooths out jittery pointing device reports using an Exponential Moving Average (EMA).
Wiggle Ball	Adds a module that triggers a behavior when wiggling the ball/mouse.

Display Helper Modules

These are modules that add additional functionality to displays (both OLED driver, and Quantum Painter)

Module	Description
Keyboard Lock	Adds a module that allows for disabling USB complete. Eg, a "cat mode".
Layer Map	Adds support for display rendering of active keyboard layout.

Typing/Keycode Modules

Module	Description
DnD Key	Adds the Do Not Disturb keycode from the HID system page.
Guarded Reset	Prevents reset keycodes from triggering without behing held for set specific time.
Typing Stats	A comprehensive keyboard usage tracking module for QMK that collects detailed typing statistics and stores them persistently in EEPROM. Copied from dmyoung9 and put into a module.
Unicode Typing	Adds support for communal unicode typing modes as a community module.
WPM Stats	A copy of dmyoung9's wpm stats prior to oled hardcoding stuff.

RGB Modules

These are modules that add additional functionality to displays (both OLED driver, and Quantum Painter)

Module	Description
Better RGB Keys	RGB keycodes that you can hold down to cycle through the values.
SignalRGB	Proof of concept for SignalRGB support as a community module.

OpenRGB is no longer supported here, as support has officially been picked up by OpenRGB!!

In development

These modules are either not working properly yet (and are listed here for visibility) or are unsupported while waiting on PR merges/code changes. While it may be possible to rework these to function currently, .... eh.

Module	Status	Description
Autocorrect	Tested	A rewrite of the autocorrect feature to much larger library sizes, and multiple libraries.
FT6x36 Touch Sensor	WIP (not working)	Add support for the FT6x36 Capacitive touch sensor.