Add RMK Support

[willpuckett]

Would it be possible to add support for RMK keymaps (keyboard.toml)?

[caksoylar]

I suppose so, though I am not very familiar and I haven't seen the demand come up much. It seems to be complicated by the fact that keymaps can be defined in toml, overridden in rs, then reconfigured via Vial at runtime. Supporting only a toml-based parser doesn't seem difficult but I am not sure if it is useful enough.

[willpuckett]

Screenshotting the layout in Vial doesn't display combos anywhere nearly as nicely as keymap-drawer does. Understandable if there's insufficient interest though!

[caksoylar]

If you get a chance, can you try https://yal-tools.github.io/vial-to-keymap-drawer/ and see if the Vial keymap export works with it, similar to QMK?

[willpuckett]

That's a great idea I tried it a few ago and am getting an assertion error, first about the combos, but then still even after I delete them all...

Also tried the Kanata import in the web app and getting

ValueError: Unknown defsrc item "`"!

(I have an ISO keyboard)

[caksoylar]

Can you share the vial export (.vil) file? I can give it a try too.

Kanata import would not work, I assume its syntax is very different.

[willpuckett]

Sorry to let this issue languish. I had issues loading the keycap-drawer web app it doesn't seem to want to work in safari.

As you suggested, I ran the exported .vil (see below) through vial-to-keymap-drawer, then processed that json in keymap-drawer.

{"version": 1, "uid": 16882930253541522617, "layout": [[["KC_B", "KC_F", "KC_D", "KC_L"], ["KC_P", "KC_O", "KC_U", "KC_Y"], ["LCTL_T(KC_C)", "LALT_T(KC_S)", "LGUI_T(KC_T)", "LSFT_T(KC_R)"], ["RSFT_T(KC_N)", "RGUI_T(KC_A)", "RALT_T(KC_I)", "RCTL_T(KC_H)"], ["KC_V", "KC_G", "KC_M", "KC_W"], ["KC_DOT", "KC_COMMA", "KC_QUOTE", "OSM(MOD_LSFT)"], ["LT2(KC_BSPACE)", "LT1(KC_SPACE)", "KC_E", "KC_ENTER"]], [["KC_KP_ENTER", "KC_KP_7", "KC_KP_8", "KC_KP_9"], ["KC__VOLDOWN", "0x7f", "KC__VOLUP", "KC_TRNS"], ["KC_KP_0", "KC_KP_4", "KC_KP_5", "KC_KP_6"], ["KC_LEFT", "KC_DOWN", "KC_UP", "KC_RIGHT"], ["KC_KP_DOT", "KC_KP_1", "KC_KP_2", "KC_KP_3"], ["KC_HOME", "KC_PGDOWN", "KC_PGUP", "KC_END"], ["KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS"]], [["KC_F12", "KC_F7", "KC_F8", "KC_F9"], ["KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS"], ["KC_F11", "KC_F4", "KC_F5", "KC_F6"], ["KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS"], ["KC_F10", "KC_F1", "KC_F2", "KC_F3"], ["KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS"], ["KC_TRNS", "KC_TRNS", "KC_TRNS", "KC_TRNS"]], [["KC_Y", "KC_U", "KC_O", "KC_P"], ["KC_L", "KC_D", "KC_F", "KC_B"], ["LCTL_T(KC_H)", "LALT_T(KC_I)", "LGUI_T(KC_A)", "LSFT_T(KC_N)"], ["RSFT_T(KC_R)", "RGUI_T(KC_T)", "RALT_T(KC_S)", "RCTL_T(KC_C)"], ["KC_K", "KC_QUOTE", "KC_COMMA", "KC_DOT"], ["KC_W", "KC_M", "KC_G", "KC_V"], ["LT2(KC_ENTER)", "LT1(KC_E)", "KC_SPACE", "KC_BSPACE"]]], "encoder_layout": [[], [], [], []], "layout_options": -1, "macro": [[], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], []], "vial_protocol": 6, "via_protocol": 9, "tap_dance": [["KC_NO", "KC_NO", "KC_NO", "KC_NO", 200], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", 200], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", 200], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", 200], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", 200], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", 200], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", 200], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", 200]], "combo": [["KC_D", "KC_L", "KC_F", "KC_NO", "KC_ESCAPE"], ["LSFT_T(KC_R)", "RSFT_T(KC_N)", "KC_NO", "KC_NO", "KC_CAPSLOCK"], ["LALT_T(KC_S)", "LGUI_T(KC_T)", "LSFT_T(KC_R)", "KC_NO", "OSL(3)"], ["LCTL_T(KC_C)", "LALT_T(KC_S)", "KC_NO", "KC_NO", "KC_TAB"], ["KC_W", "KC_M", "KC_NO", "KC_NO", "KC_MINUS"], ["KC_DOT", "KC_COMMA", "KC_NO", "KC_NO", "KC_SLASH"], ["KC_QUOTE", "OSM(MOD_LSFT)", "KC_NO", "KC_NO", "KC_SCOLON"], ["KC_P", "KC_O", "KC_NO", "KC_NO", "KC_BSLASH"], ["KC_DOT", "OSM(MOD_LSFT)", "KC_NO", "KC_NO", "KC_LBRACKET"], ["KC_COMMA", "KC_QUOTE", "KC_NO", "KC_NO", "KC_RBRACKET"], ["KC_V", "KC_G", "KC_NO", "KC_NO", "KC_Q"], ["KC_G", "KC_M", "KC_NO", "KC_NO", "KC_J"], ["KC_V", "KC_W", "KC_NO", "KC_NO", "KC_Z"], ["KC_U", "KC_Y", "KC_NO", "KC_NO", "KC_K"], ["KC_B", "LCTL_T(KC_C)", "KC_NO", "KC_NO", "KC_1"], ["KC_F", "LALT_T(KC_S)", "KC_NO", "KC_NO", "KC_2"], ["KC_D", "LGUI_T(KC_T)", "KC_NO", "KC_NO", "KC_3"], ["KC_L", "LSFT_T(KC_R)", "KC_NO", "KC_NO", "KC_4"], ["LT2(KC_BSPACE)", "LT1(KC_SPACE)", "KC_NO", "KC_NO", "KC_5"], ["KC_E", "KC_ENTER", "KC_NO", "KC_NO", "KC_6"], ["KC_P", "RSFT_T(KC_N)", "KC_NO", "KC_NO", "KC_7"], ["KC_O", "RGUI_T(KC_A)", "KC_NO", "KC_NO", "KC_8"], ["KC_U", "RALT_T(KC_I)", "KC_NO", "KC_NO", "KC_9"], ["KC_Y", "RCTL_T(KC_H)", "KC_NO", "KC_NO", "KC_0"], ["KC_V", "LCTL_T(KC_C)", "KC_NO", "KC_NO", "LGUI(KC_Z)"], ["KC_G", "LALT_T(KC_S)", "KC_NO", "KC_NO", "LGUI(KC_X)"], ["KC_M", "LGUI_T(KC_T)", "KC_NO", "KC_NO", "LGUI(KC_C)"], ["KC_W", "LSFT_T(KC_R)", "KC_NO", "KC_NO", "LGUI(KC_V)"], ["KC_DOT", "RSFT_T(KC_N)", "KC_NO", "KC_NO", "KC_LEFT"], ["KC_COMMA", "RGUI_T(KC_A)", "KC_NO", "KC_NO", "KC_DOWN"], ["KC_QUOTE", "RALT_T(KC_I)", "KC_NO", "KC_NO", "KC_UP"], ["KC_K", "RCTL_T(KC_H)", "KC_NO", "KC_NO", "KC_RIGHT"], ["KC_B", "KC_F", "KC_NO", "KC_NO", "KC_W"], ["KC_F", "KC_D", "KC_NO", "KC_NO", "KC_M"], ["KC_D", "KC_L", "KC_NO", "KC_NO", "KC_G"], ["KC_B", "KC_D", "KC_NO", "KC_NO", "KC_X"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"], ["KC_NO", "KC_NO", "KC_NO", "KC_NO", "KC_NO"]], "key_override": [], "settings": {}}

that created this keymap yaml

layout: {"cols_thumbs_notation":"3333+2 2+3333"}
layers:
  L0:
    - B
    - F
    - D
    - L
    - P
    - O
    - U
    - Y
    - {"t":"C","h":"LCTL"}
    - {"t":"S","h":"LALT"}
    - {"t":"T","h":"LGUI"}
    - {"t":"R","h":"LSFT"}
    - {"t":"N","h":"RSFT"}
    - {"t":"A","h":"RGUI"}
    - {"t":"I","h":"RALT"}
    - {"t":"H","h":"RCTL"}
    - V
    - G
    - M
    - W
    - {"s":">","t":"."}
    - {"s":"<","t":","}
    - {"s":"\"","t":"'"}
    - {"t":"MOD_LSFT","s":"OSM+"}
    - {"t":"Bksp","h":"MO L2"}
    - {"t":"Space","h":"MO L1"}
    - E
    - Enter
  L1:
    - "Num\nEnter"
    - "7"
    - "8"
    - "9"
    - "Vol -\nAlt"
    - "0x7f"
    - "Vol +\nAlt"
    - "▽"
    - "0"
    - "4"
    - "5"
    - "6"
    - Left
    - Down
    - Up
    - Right
    - "."
    - "1"
    - "2"
    - "3"
    - Home
    - "Page\nDown"
    - "Page\nUp"
    - End
    - "▽"
    - {"t":"","type":"held"}
    - "▽"
    - "▽"
  L2:
    - F12
    - F7
    - F8
    - F9
    - "▽"
    - "▽"
    - "▽"
    - "▽"
    - F11
    - F4
    - F5
    - F6
    - "▽"
    - "▽"
    - "▽"
    - "▽"
    - F10
    - F1
    - F2
    - F3
    - "▽"
    - "▽"
    - "▽"
    - "▽"
    - {"t":"","type":"held"}
    - "▽"
    - "▽"
    - "▽"
  L3:
    - Y
    - U
    - O
    - P
    - L
    - D
    - F
    - B
    - {"t":"H","h":"LCTL"}
    - {"t":"I","h":"LALT"}
    - {"t":"A","h":"LGUI"}
    - {"t":"N","h":"LSFT"}
    - {"t":"R","h":"RSFT"}
    - {"t":"T","h":"RGUI"}
    - {"t":"S","h":"RALT"}
    - {"t":"C","h":"RCTL"}
    - K
    - {"s":"\"","t":"'"}
    - {"s":"<","t":","}
    - {"s":">","t":"."}
    - W
    - M
    - G
    - V
    - {"t":"Enter","h":"MO L2"}
    - {"t":"E","h":"MO L1"}
    - Space
    - Bksp
combos:
  - {"p":[2,3,1],"k":"Esc","l":["L0"]}
  - {"p":[5,4,6],"k":"Esc","l":["L3"]}
  - {"p":[11,12],"k":"Caps\nLock","l":["L0"]}
  - {"p":[9,10,11],"k":"OSL L3","l":["L0"]}
  - {"p":[8,9],"k":"Tab","l":["L0"]}
  - {"p":[19,18],"k":{"s":"_","t":"-"},"l":["L0"]}
  - {"p":[20,21],"k":{"s":"_","t":"-"},"l":["L3"]}
  - {"p":[20,21],"k":{"s":"?","t":"/"},"l":["L0"]}
  - {"p":[19,18],"k":{"s":"?","t":"/"},"l":["L3"]}
  - {"p":[22,23],"k":{"s":":","t":";"},"l":["L0"]}
  - {"p":[4,5],"k":{"s":"|","t":"\\"},"l":["L0"]}
  - {"p":[3,2],"k":{"s":"|","t":"\\"},"l":["L3"]}
  - {"p":[20,23],"k":{"s":"{","t":"["},"l":["L0"]}
  - {"p":[21,22],"k":{"s":"}","t":"]"},"l":["L0"]}
  - {"p":[18,17],"k":{"s":"}","t":"]"},"l":["L3"]}
  - {"p":[16,17],"k":"Q","l":["L0"]}
  - {"p":[23,22],"k":"Q","l":["L3"]}
  - {"p":[17,18],"k":"J","l":["L0"]}
  - {"p":[22,21],"k":"J","l":["L3"]}
  - {"p":[16,19],"k":"Z","l":["L0"]}
  - {"p":[23,20],"k":"Z","l":["L3"]}
  - {"p":[6,7],"k":"K","l":["L0"]}
  - {"p":[1,0],"k":"K","l":["L3"]}
  - {"p":[0,8],"k":{"s":"!","t":"1"},"l":["L0"]}
  - {"p":[1,9],"k":{"s":"@","t":"2"},"l":["L0"]}
  - {"p":[2,10],"k":{"s":"#","t":"3"},"l":["L0"]}
  - {"p":[3,11],"k":{"s":"$","t":"4"},"l":["L0"]}
  - {"p":[24,25],"k":{"s":"%","t":"5"},"l":["L0"]}
  - {"p":[26,27],"k":{"s":"^","t":"6"},"l":["L0"]}
  - {"p":[4,12],"k":{"s":"&","t":"7"},"l":["L0"]}
  - {"p":[5,13],"k":{"s":"*","t":"8"},"l":["L0"]}
  - {"p":[6,14],"k":{"s":"(","t":"9"},"l":["L0"]}
  - {"p":[7,15],"k":{"s":")","t":"0"},"l":["L0"]}
  - {"p":[16,8],"k":{"t":"Z","s":"LGUI+"},"l":["L0"]}
  - {"p":[17,9],"k":{"t":"X","s":"LGUI+"},"l":["L0"]}
  - {"p":[18,10],"k":{"t":"C","s":"LGUI+"},"l":["L0"]}
  - {"p":[19,11],"k":{"t":"V","s":"LGUI+"},"l":["L0"]}
  - {"p":[20,12],"k":"Left","l":["L0"]}
  - {"p":[21,13],"k":"Down","l":["L0"]}
  - {"p":[22,14],"k":"Up","l":["L0"]}
  - {"p":[0,1],"k":"W","l":["L0"]}
  - {"p":[7,6],"k":"W","l":["L3"]}
  - {"p":[1,2],"k":"M","l":["L0"]}
  - {"p":[6,5],"k":"M","l":["L3"]}
  - {"p":[2,3],"k":"G","l":["L0"]}
  - {"p":[5,4],"k":"G","l":["L3"]}
  - {"p":[0,2],"k":"X","l":["L0"]}
  - {"p":[7,5],"k":"X","l":["L3"]}

which works well.

My goal was to be able to do this in a GitHub action, so I created #187 to add an rmk parser to keymap-drawer. I have only tested it with my keymap, and will post to have others give it a whirl as well.

Thanks 🪣's!