Allows QMK keymaps to be written in (what I find to be) a nicer way, compiling to the standard keymap.c.
The idea is that keymaps are defined visually, and additional configuration such as combos are grouped with their layers.
cargo install --git https://github.com/frnsys/kblA layout file might look like this, with each layer separated by ---:
ALPHA
G M L Y F U
D S T N R I A E O '
W C P H , .
⇧ ⌫ ⏎ ␣
holds:
⌫: Meta
⏎: Layer(NAVCTL)
␣: Ctrl
T: Layer(SYMBOL)
E: Layer(NUMBER)
combos:
[E, O]: ":"
[S, N]: Esc
[A, O]: =
[G, M]: Q
[W, C]: Z
[C, P]: V
[S, T]: B
[A, E]: K
[M, L]: J
[F, U]: [X, Layer(SYSTEM)]
shifts:
",": "-"
".": _
"'": '"'
---
SYMBOL
c ⬚ p # [ ]
/ * ∅ ` ~ @ { ( ) }
⬚ ⬚ ⬚ ? < >
⇥ & ! ;
defs:
c: Ctrl(C)
p: Ctrl(V)
---
NUMBER
1 2 3 ¸ ⬚ ˆ
^ 4 5 6 $ € + ∅ % ´
7 8 9 ˋ ⬚ ¨
0 | ⬚ \
---
NAVCTL
⇲ ⍐ ⇱ ❮ ↑ ❯
⇧ 1 2 3 ↶ ⎶ ← ↓ → ⊕
⏷ ▶ ⏶ ◱ ✛ ⌕
⍜ ⍈ ∅ ⬚
defs:
1: Meta(1) # Desktop 1
2: Meta(2) # Desktop 2
3: Meta(3) # Desktop 3
❮: Alt([) # Prev term tab
❯: Alt(]) # Next term tab
⊕: Alt(T) # New tab
⎶: Alt(-) # Horizontal split
◱: Alt(M) # Maximize term window
✛: Alt(W) # Focus term window
⌕: Alt(') # Fuzzy search
⍐: Meta(Ctrl(K)) # Focus monitor
⍈: Meta(H) # Focus window
↶: Ctrl(Z) # Undo
⇱: Meta(Shift(←)) # Size up window
⇲: Meta(Shift(→)) # Size down window
⍜: Meta(␣) # Launcher
▶: Meta(=) # Play/pause music
combos:
[⏷, ⏶]: ⨯ # Mute
shifts:
⍐: Meta(Ctrl(M)) # Move window to monitor
1: Meta(Shift(1)) # Move window to desktop 1
2: Meta(Shift(2)) # Move window to desktop 2
3: Meta(Shift(3)) # Move window to desktop 3
▶: Meta(=) # Play/pause mpv
⏶: ☼ # Brightness up
⏷: ☾ # Brightness down
⊕: Alt(E) # Terminal scrollback history
⎶: Alt(\) # Terminal vertical split
↶: Ctrl(Shift(Z)) # Redo
which can then be compiled:
kbl layout.kbl > /path/to/my/qmk/keymaps/keymap.cTo include literal C into the generated file you can add a final section starting with === and include the C code after it, e.g.:
===
// Disable Liatris power LED
#include "gpio.h"
void keyboard_pre_init_user(void) {
gpio_set_pin_output(24);
gpio_write_pin_high(24);
}
- The visual layout definition relies on each key being defined by a single character. As such many keys are mapped to special characters, e.g. "␣" for "space". Refer to
keys.rsto see these mappings.- Note that
⬚is used to indicate an unassigned key.
- Note that
- This only supports a small portion of QMK features; i.e. the ones that I use. So far this includes tap-hold, shift key overrides, and combos.
- The layer config is parsed as YAML, so the usual YAML caveats apply. In particular there are some characters which will need to be quoted, such as
:,-, and"; basically any characters that are special for YAML.