No description
  • C 92.9%
  • Shell 5.7%
  • Makefile 1.4%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Jonathan Warykowski ba376a1148
All checks were successful
CI / firmware (push) Has been skipped
CI / test (push) Successful in 9s
feat: keybars community module for QMK (#1)
Reviewed-on: #1
2026-11-01 13:01:27 +00:00
.github/workflows feat: keybars community module for QMK (#1) 2026-11-01 13:01:27 +00:00
docs feat: keybars community module for QMK (#1) 2026-11-01 13:01:27 +00:00
example/zsa_moonlander feat: keybars community module for QMK (#1) 2026-11-01 13:01:27 +00:00
keybars feat: keybars community module for QMK (#1) 2026-11-01 13:01:27 +00:00
scripts feat: keybars community module for QMK (#1) 2026-11-01 13:01:27 +00:00
test feat: keybars community module for QMK (#1) 2026-11-01 13:01:27 +00:00
.gitignore feat: keybars community module for QMK (#1) 2026-11-01 13:01:27 +00:00
CHANGELOG.md feat: keybars community module for QMK (#1) 2026-11-01 13:01:27 +00:00
LICENSE chore: licence 2026-10-20 20:22:59 +11:00
README.md feat: keybars community module for QMK (#1) 2026-11-01 13:01:27 +00:00
RELEASING.md feat: keybars community module for QMK (#1) 2026-11-01 13:01:27 +00:00

keybars-qmk

A QMK community module that lets keybars Pro light a keyboard's keys and take over a key for an action: while the app has armed a key, pressing it runs the action instead of typing the letter. It talks raw HID; the protocol is small, and if the app goes quiet for 3 seconds every key goes back to normal.

Needs firmware you build yourself (QMK Configurator and Oryx don't take community modules) and QMK with community module API 1.1.0 or later.

Use it

Add the repository as a submodule under your userspace's (or qmk_firmware's) modules/jwarykowski:

git submodule add https://code.warykowski.io/jwarykowski/keybars-qmk.git modules/jwarykowski

then name it in your keymap's keymap.json, beside a keymap.c if you have one:

{
    "modules": ["jwarykowski/keybars"]
}

example/zsa_moonlander is the Moonlander's default keymap with it added.

Keys the app can never arm: modifiers and layer keys on the base layer, QK_BOOT, and any your keymap refuses:

bool keybars_never_arm_user(uint8_t row, uint8_t col) {
    return row == 5; // the thumb cluster
}

With VIA

VIA answers raw HID too. Define KEYBARS_NO_RAW_HID_RECEIVE in config.h and hand keybars its reports first from wherever your keymap receives them; keybars_raw_hid_receive returns false for reports that aren't keybars'.

Develop

make -C test runs the protocol's tests on the computer (with ASan and UBSan; CC=clang if gcc lacks them). The QMK side is keybars/keybars.c; everything else is keybars/keybars_core.c, which doesn't need QMK.

CI runs the tests; on a tag, or run by hand, it also builds example/zsa_moonlander on QMK master and ZSA's fork (scripts/firmware.sh). RELEASING.md has how to tag a version.

Licence

GPL-2.0-or-later, as QMK.