1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
# Keymap Editor
A browser app (plus NodeJS server) to edit ZMK keymaps. This has been a solo
project but in a workable state for quite a while now, and new features are in
development all the time.
**Try it live!** Go to the [keymap-editor] and try it out with the built-in
[zmk-config-corne-demo] before setting up your own repo.
## Features
### Current
* WYSIWYG keycode and layer editing.
* Keymap bindings formatting
* If the (non-standard) `row` and `col` attributes are specified in
`info.json` they will be used to render the generated files in a more human-
readable format that matches the physical layout of the keyboard. Note that
these values are not the row and column of the wiring matrix which may be
different to use GPIO pins more efficiently.
* **\[NEW\]** Automatic formatting of `.keymap` file
* Build status/link: for those relying on GitHub actions to build their keyboard
firmware, the editor will now display the most recent build result and provide
a link to the results in GitHub. It also gets `workflow_run` events in real-
time so you can get live progress from within the editor.
* **\[NEW\]** [Combo editing](./screenshots/editor-screenshot-combos.png)
* Fairly recent development. This allows you to assign a key bind and select
input keys visually using a scaled down mapping of the keymap layout.
* Supports further configuration of the `timeout`, `slow-release`, and
`layers` properties.
* **\[NEW\]** [Macro editing](./screenshots/editor-screenshot-macros.png)
* Still in beta, but this feature enables editing macros defined in your
`.keymap` file (as well as creating new ones of course) and assigning them
as custom behaviours in your keymap.
* Will eventually support reading macros from included `.dtsi` files.
* **\[NEW\]** [Dark mode!](./screenshots/editor-screenshot-darkmode.png)
* Not really my thing but it seems important to people.
* Set the theme manually or let your OS/browser set the default.
* **\[NEW\]** [Automatic layout generation](./screenshots/layout-example.png)
* If you don't want to create a layout from scratch you can have the editor
attempt to generate one automatically.
* This requires you to either have devicetree source in the repository or to
be editing a keymap for a keyboard available in the ZMK repository.
* **\[NEW\]** Support for custom behaviour definitions
* Custom behaviors in your keymap (like homerow mods!) can be bound to keys
in your keymap (and combos, and macros!).
* For now these behaviors cannot be edited directly.
### In Progress
Currently working on moving towards parsing the devicetree syntax in `.keymap`
files. A lot of ZMK features are going to be a challenge to implement, but just
by being able to reliably read and write devicetree code it will be possible to
use the editor to modify layer bindings without overwriting sections it doesn't
recognize (for example, combos and custom configured behaviours).
### Planned features
* **Devicetree parsing** -- this is kind of the default but it needs refinement
* **Upstream repos** -- this will make it possible to edit keymaps for keyboards
defined in remote repositories (such as the core ZMK repo). Once this is in
place the automatic layout generation will Just Work for most people... or at
least enough to get started with the editor.
* **Rotary encoders**, but I don't have a plan for a clean UI design
* **Behaviour configuration** to make things like homerow mods possible
* **Keymap diagram export** I'd like to be able to reference keymap diagrams in
the repository's `README.md` and have the editor update those diagrams upon
comitting the changes. I'm searching for efficient ways to reuse the React
components to generate SVG data instead but its tricky.
#### What else?
If you have thoughts on what needs to be fixed to support _your_ keyboard or to
make this a useful tool for users, let me know.
I'm not committing to taking this on myself, and as a hobbyist I don't have any
commercially available keyboards to test out and provide specific support, but
I'm happy to have discussions on where this (or another tool) can go.
Do you have an idea you'd like to see implemented that might not work for this
specific use case? _Talk to me_. I went to a lot of trouble building this and I
can share a lot of that experience. Even if we don't have the same needs a lot
of things can be supported modularly.
## Setup
You've got a couple of options:
### Local
You can clone this repo and your zmk-config and run the editor locally. Changes
are saved to the keymap files in your local repository and you can commit and
push them to as desired to trigger the GitHub Actions build.
Read more about [local setup](running-locally.md)
### Web
This editor has a GitHub integration. You can load the web app and grant it
access to your zmk-config repo. Changes to your keymap are committed right back
to the repository so you only ever need to leave the app to download firmware.
Try it now:
1. Fork [zmk-config-corne-demo] on GitHub
2. Go to [keymap-editor] and authorize it to access your forked repo.
Read more about the [GitHub integration](api/services/github/README.md)
## License
The code in this repo is available under the MIT license.
The collection of ZMK keycodes is taken from the ZMK documentation under the MIT
license as well.
[keymap-editor]: https://nickcoutsos.github.io/keymap-editor/
[zmk-config-corne-demo]: https://github.com/nickcoutsos/zmk-config-corne-demo
|
