This ZMK configuration is for a keyboard with a rotary encoder and a pointer device available at xcmkb, panadakb and AliExpress
Additionally, you'll need some switches and keycaps.
- Switches: I prefer the Yellow Gateron Pro Hot Swap 5Pin 50g Switches bought from AliExpress
- Keycaps: You can order your custom keycap set for the configuration from YUZU keycaps
This configuration is inspired by Miryoku and contains a sleek looking customized nice!view shield inspired by nice_view_gem and it also generates a keymap for reference
Total cost: $154 (~$182 with tax and shipping)
- Fork this repository
- Click the Actions tab and make sure the workflow is enabled
- Update the remotes in
config/west.yml
this will use theboards/arm/
andboards/shield
folder in your repo - Rebuild firmware using Github Actions and setup Keymap Editor as explained in Sofle Wireless setup
- Once the build is finished the new keymap drawing will be automatically updated in this README
- Download the firmware.zip file generated by Github Actions. This contains 4 files (1 for zmk studio, 1 for reseting the board, updated config for left half and right half)
- Connect the left half of the keyboard to your PC using usb and put it in bootloader mode by double clicking the button next to the on/off switch. This will mount the device on your PC, then copy the left half uf2 file(
nice_view_gem-eyelash_corne_left-zmk.uf2
) to this drive and it will automatically unmount once finished - Do the same now with the right half of the keyboard and copy the
nice_view_gem-eyelash_corne_right-zmk.uf2
file - This should load the new firmware on your system
If you already have a ZMK config repository, you can add this one as a module instead of forking
If desired, edit your config/west.yml
to switch back to zmkfirmware
's main
branch:
diff --git a/config/west.yml b/config/west.yml
index ac30a68..70ad540 100644
--- a/config/west.yml
+++ b/config/west.yml
@@ -13,8 +13,8 @@ manifest:
- name: zmk
- remote: petejohanson
- revision: feat/pointers-with-input-processors
+ remote: zmkfirmware
+ revision: main
import: app/west.yml
self:
path: config