zmk-keymapjust for fun

A KDE Plasma widget that shows the keymap on your ZMK keyboard.

Three layers of a Corne keymap drawn as tiles: Base, Lower, and Raise, with rotated thumb keys and the layer keys highlighted in gold. — A Corne's three layers. Resize the widget and the tiles re-flow.

What it does

Reads the keymap straight off the keyboard over ZMK Studio's USB connection, so the cheatsheet always matches the firmware. No zmk-config repo or keymap-drawer run to keep in sync.

Every layer is a tile on the board's real physical layout, arranged in whichever grid gives the biggest keys for the widget's shape, in your Plasma color scheme. The keymap is cached, so the widget keeps working with the keyboard unplugged.

What you need

KDE Plasma 6 and python3
ZMK firmware with Studio over USB: CONFIG_ZMK_STUDIO=y and the studio-rpc-usb-uart snippet
A key bound to &studio_unlock
Access to the keyboard's serial port, usually the uucp or dialout group

Install

Download .plasmoid

Right-click the desktop and choose Add Widgets… › Get New… › Install Widget From Local File…, add ZMK Keymap, plug the keyboard in over USB, and click Read from Keyboard.

Setup details and troubleshooting are in the README.

Just for fun

Built for my own desk and shared as-is: no issues, no pull requests, no roadmap. Fork it and make it yours under the MIT license; keep the copyright notice, and a link back is appreciated.

← apps.andymolenda.com