question: what is used to generate the layout image?

[mattmarcello]

might be cool to add to produce this as a build artifact by default?

[urob]

I am currently creating the layout manually. Here's the source code if you want to modify: http://www.keyboard-layout-editor.com/#/gists/06469e3337fa76f1c6e95229f5c58522

At some point, I am going to move over to use https://github.com/caksoylar/keymap-drawer to automate things, but I haven't found time yet to set things up to work end-to-end.

There's now an example workflow (#76) showing how to automate the keymap using keymap-drawer. TL;DR: just draw does everything if you are using my local build environment (#74).

[angularsen]

So based on #68 (comment) I found a way to generate this manually, that probably can be automated if the physical layout can be described in the .keymap file somehow?

pip install pcpp
cd config # In your zmk-config repo root
pcpp --passthru-unfound-includes your-file.keymap > flat.keymap # Flatten the keymap

1. Go to https://keymap-drawer.streamlit.app/
2. Parse from ZMK keymap > Browse file and select flat.keymap created above > Parse from file
3. You will get an error saying the physical layout must be described, add layout: to the yaml, for example layout: {cols_thumbs_notation: 33333+3 3+33333} for split with 5 columns, 3 rows and 3 thumb buttons each. More details on layout syntax here.

[angularsen]

Not as pretty as the one in the README, and I don't see things like long press for HOME/END etc. But it's a start at least.

[urob]

Let me flag some work-in-progress that adds support to keymap-drawer for configs that rely on Zephyr modules (such as the v2 branch of zmk-helpers used in this repo).

1. #105 adds support for zmk-helpers-v2 when running keymap-drawer locally (currently merged but not yet released)
2. #107 adds support for zmk-helpers-v2 when running keymap-drawer through Github Actions (currently waiting to be merged)

Once these PRs are both merged and released, using keymap-drawer with this repo should be hopefully much simpler. For an example how to already use them now, check out @stijnveenman's zmk-config.

Based on their work, I also did some first exploring myself to get the local workflow running. This for now requires a custom build of keymap-drawer (since #105 isn't released yet) but otherwise works fine. I haven't tried tuning the resulting images at all though...

[urob]

With some delay, I finally got the keymap-drawer workflow polished and fully automated. See this discussion for details: #76

[autoferrit]

has there been any effort on using keymap drawer? the nodefree repo that this uses seems to be incompatible as there is no root node in the keymap file.

[angularsen]

#33 (reply in thread)

[urob]

has there been any effort on using keymap drawer? the nodefree repo that this uses seems to be incompatible as there is no root node in the keymap file.

Keymap drawer should work (it does for me). It is smart enough to include all necessary files and expand all macros.

Two potential stumbling points:

1. Make sure to run it on the root file (eg corneish_zen.keymap). Running it in base.keymap doesn't work since base is intended to be included in another keymap file.

2. If you include the nodefree-repo as submodule, the online version of keymap drawer will currently fail (there's already a PR that fixes this). In either case, running keymap drawer locally works

[urob]

Quick update: Since version 0.18.0 keymap-drawer also supports using zmk-helpers both as a Zephyr module. I added some instructions here with details:
https://github.com/urob/zmk-helpers/blob/main/docs/keymap_drawer.md