Skip to content

Commit 9d8c3b5

Browse files
280Zo280Zo
committed
update readme and key mapping names for SVG
1 parent c179913 commit 9d8c3b5

File tree

4 files changed

+25
-18
lines changed

4 files changed

+25
-18
lines changed

‎.github/workflows/draw_keymaps.yaml

+2-1
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,8 @@ jobs:
170170
"&shit": "SHIT SUDO",
171171
"&new_dir": "NEW DIR",
172172
"&py_iter": "PYTHON LOOP",
173-
"&js_iter": "JS LOOP"
173+
"&js_iter": "JS LOOP",
174+
"&studio_unlock": "ZMK Studio"
174175
}
175176
run: |
176177
get_args() {

‎README.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ There are a few things to note about how the pre-built firmware is configured:
3030
- To add support for the PMW3610 low power trackball sensor, badjeff's [zmk-pmw3610-driver](https://github.com/badjeff/zmk-pmw3610-driver), [ZMK Input Behavior Listener](https://github.com/badjeff/zmk-input-behavior-listener?tab=readme-ov-file), and [ZMK Split Peripheral Input Relay](https://github.com/badjeff/zmk-split-peripheral-input-relay) modules are included in the firmware.
3131
- eigatech's [zmk-configs](https://github.com/eigatech/zmk-config?tab=readme-ov-file) played a major role in getting badjeff's drivers and modules fully configured and are a great resource
3232
- A separate branch builds the Bluetooth/USB firmware using [inorichi's driver](https://github.com/inorichi/zmk-pmw3610-driver?tab=readme-ov-file) as an alternative to badjeff's driver.
33-
- Pete Johanson (Creator and lead of the ZMK firmware) developed a feature ([pointers-move-scroll](https://github.com/zmkfirmware/zmk/pull/2027)) that allows mouse keys to move and scroll. A successor feature ([pointers-with-input-processors](https://github.com/zmkfirmware/zmk/pull/2477)) was then developed that allows more flexibility. This firmware is what will eventually be merged into the main ZMK repo, and it's what is used in this repo. Although it's not guranteed to be stable, it hasn't caused any noticible issues. That being said, if you'd prefer to use pointers-move-scroll which is in a stable state, you can update the west.yaml and adapt the config files accordingly.
33+
- Pete Johanson (Creator and lead of the ZMK firmware) developed a feature ([pointers-move-scroll](https://github.com/zmkfirmware/zmk/pull/2027)) that allows mouse keys to move and scroll. A successor feature ([pointers-with-input-processors](https://github.com/zmkfirmware/zmk/pull/2477)) was then developed that allows more flexibility. This feature is what will eventually be merged into the main ZMK branch, and it's what is used by this repo to build the firmware. Although it's not guranteed to be stable, it hasn't caused any noticible issues. That being said, if you'd prefer to use pointers-move-scroll which is in a stable state, you can update the west.yaml and adapt the config files accordingly.
3434

3535
## Flashing the Firmware
3636

@@ -75,6 +75,10 @@ Here are a few tips for a quick start:
7575

7676
[ZMK Studio](https://zmk.studio/) allows users to update functionality during runtime. It's currently in beta, but the physical layout and updated config files are included in the BT/USB firmware for testing. The dongle firmware does not have this integration at the moment.
7777

78+
To change the visual layout of the keys, the physical layout must be updated. This is the charybdis-layouts.dtsi file, which handles the actual physical positions of the keys. Though they may appear to be similar, this is different than the matrix transform file (charybdis.json) which handles the electrical matrix to keymap relationship.
79+
80+
To easily modify the physical layout, or convert a matrix transform file, [caksoylar](https://github.com/caksoylar/zmk-physical-layout-converter) has built the [ZMK physical layouts converter](https://zmk-physical-layout-converter.streamlit.app/).
81+
7882
For more details on how to use ZMK Studio, refer to the [ZMK documentation](https://zmk.dev/docs/features/studio).
7983

8084
### Keymap GUI
@@ -127,10 +131,10 @@ This repo uses the excellent work of caksoylar's [Keymap Drawer](https://keymap-
127131

128132
## Upcoming ZMK Features
129133

130-
ZMK is actively being developed and there are a few features that will be added to these builds as soon as they are released.
134+
ZMK is actively being developed and there are a few features that will be added to these builds if/when they are approved.
131135

132-
- Mouse move and scroll support - [in draft](https://github.com/zmkfirmware/zmk/pull/2477)
133136
- Layer Lock - [Open PR](https://github.com/zmkfirmware/zmk/pull/1984)
137+
- Unicode Support - [Issue](https://github.com/zmkfirmware/zmk/issues/232)
134138

135139
## Credits
136140

‎config/charybdis.keymap

+14-14
Original file line numberDiff line numberDiff line change
@@ -183,18 +183,18 @@
183183

184184
NUM {
185185
bindings = <
186-
&none &none &none &none &none &none &kp SLASH &hm F7 N7 &hm F8 N8 &hm F9 N9 &hm F10 MINUS &none
187-
&kp TAB &none &none &none &kp BACKSPACE &none &kp ASTRK &hm F4 N4 &hm F5 N5 &hm F6 N6 &hm F11 PLUS &none
186+
&trans &none &none &none &none &none &kp SLASH &hm F7 N7 &hm F8 N8 &hm F9 N9 &hm F10 MINUS &none
187+
&trans &none &none &none &kp BACKSPACE &none &kp ASTRK &hm F4 N4 &hm F5 N5 &hm F6 N6 &hm F11 PLUS &trans
188188
&none &none &none &none &none &none &kp DOT &hm F1 N1 &hm F2 N2 &hm F3 N3 &hm F12 EQUAL &none
189-
&trans &none &trans &kp N0 &trans
189+
&none &none &trans &kp N0 &trans
190190
>;
191191
};
192192

193193
NAV {
194194
bindings = <
195195
&none &none &none &none &none &none &none &kp LS(LC(H)) &kp LS(LC(J)) &kp LS(LC(K)) &kp LS(LC(L)) &none
196-
&trans &trans &trans &trans &trans &trans &VSplit &kp LEFT_ARROW &kp DOWN &kp UP &kp RIGHT_ARROW &none
197-
&none &none &none &none &trans &none &HSplit &kp HOME &kp PG_DN &kp PG_UP &kp END &none
196+
&trans &trans &trans &trans &trans &none &VSplit &kp LEFT_ARROW &kp DOWN &kp UP &kp RIGHT_ARROW &none
197+
&none &none &none &none &none &none &HSplit &kp HOME &kp PG_DN &kp PG_UP &kp END &none
198198
&none &none &trans &trans &trans
199199
>;
200200
};
@@ -210,27 +210,27 @@
210210

211211
GAME {
212212
bindings = <
213-
&kp N1 &kp TAB &kp Q &kp W &kp E &kp R &none &none &none &none &none &to 0
213+
&kp N1 &kp TAB &kp Q &kp W &kp E &kp R &none &none &none &none &none &none
214214
&kp N2 &kp LCTRL &kp A &kp S &kp D &kp F &none &none &none &none &none &none
215215
&kp N3 &kp LSHFT &kp Z &kp X &kp C &kp V &none &none &none &none &none &none
216-
&trans &kp SPACE &kp LEFT_ALT &none &none
216+
&none &kp SPACE &kp LEFT_ALT &none &none
217217
>;
218218
};
219219

220220
PHOTOS {
221221
bindings = <
222-
&trans &kp LA(LC(LS(Z))) &kp LA(LC(LS(E))) &kp LA(LC(LS(A))) &kp LA(LC(LS(S))) &kp LA(LC(LS(B))) &none &none &none &none &none &trans
223-
&kp LC(LA(E)) &kp LEFT &kp DOWN &kp UP &kp RIGHT &kp LCTRL &none &none &none &none &none &none
224-
&kp LS(DELETE) &kp LA(LS(A)) &kp LA(KP_N1) &kp LA(KP_N2) &kp LA(KP_N3) &none &none &none &none &none &none &to 0
225-
&trans &none &trans &trans &trans
222+
&trans &kp LA(LC(LS(Z))) &kp LA(LC(LS(E))) &kp LA(LC(LS(A))) &kp LA(LC(LS(S))) &kp LA(LC(LS(B))) &none &none &none &none &none &none
223+
&kp LC(LA(E)) &kp LEFT &kp DOWN &kp UP &kp RIGHT &kp LCTRL &none &none &none &none &none &trans
224+
&kp LS(DELETE) &kp LA(LS(A)) &kp LA(KP_N1) &kp LA(KP_N2) &kp LA(KP_N3) &none &none &none &none &none &none &none
225+
&trans &trans &trans &trans &trans
226226
>;
227227
};
228228

229229
EXTRAS {
230230
bindings = <
231-
&kp C_SLEEP &shrug &lgtm &gcm &none &kp C_BRIGHTNESS_INC &bt BT_SEL 0 &bt BT_SEL 1 &bt BT_SEL 2 &bt BT_SEL 3 &none &kp C_AL_COFFEE
232-
&kp C_POWER &shit &py_iter &js_iter &none &kp C_BRIGHTNESS_DEC &out OUT_TOG &kp C_PREVIOUS &kp C_PLAY_PAUSE &kp C_STOP &kp C_NEXT &none
233-
&bt BT_CLR &none &none &none &none &clip_hist &new_dir &kp C_VOLUME_DOWN &kp C_VOLUME_UP &kp K_MUTE &kp PRINTSCREEN &studio_unlock
231+
&kp C_POWER &shrug &lgtm &gcm &none &kp C_BRIGHTNESS_INC &bt BT_SEL 0 &bt BT_SEL 1 &bt BT_SEL 2 &bt BT_SEL 3 &out OUT_TOG &bt BT_CLR
232+
&kp C_SLEEP &shit &py_iter &js_iter &none &kp C_BRIGHTNESS_DEC &none &kp C_PREVIOUS &kp C_PLAY_PAUSE &kp C_STOP &kp C_NEXT &none
233+
&kp C_AL_COFFEE &none &none &none &none &clip_hist &new_dir &kp K_MUTE &kp C_VOLUME_DOWN &kp C_VOLUME_UP &kp PRINTSCREEN &studio_unlock
234234
&none &none &none &none &none
235235
>;
236236
};

‎keymap-drawer/config.yaml

+2
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,8 @@ parse_config:
237237
LA(KP_N2): "PENDING"
238238
LA(KP_N3): "ACCEPT"
239239
F12: "DEV TOOLS"
240+
BRIGHTNESS INC: "BRIGHT ▲"
241+
BRIGHTNESS DEC: "BRIGHT ▼"
240242
zmk_combos: {}
241243
zmk_preamble: "#define KEYMAP_DRAWER"
242244
zmk_additional_includes: []

0 commit comments

Comments
 (0)