This repository serves as an example for extending the base fingerpunch keyboards to add your own keymap and extend/override the config and/or devicetree.
Steps to create a similar set up:
- Go to https://github.com/zmkfirmware/unified-zmk-config-template and click "Use this template", and "Create a new repository"
- Choose a name for your repository
- Copy the contents of the
config/west.ymlin this repository into the same file in your new repository. Please review the comments in that file to see if you want to make any changes. - Copy the keymap of your choice from the appropriate zmk-fingerpunch-keyboards shield for your keyboard
- Modify your keymap
- Update
build.ymlin your repo to build the keyboard with the controller of your choice. You can use any zmk supported controller, or one of the fingerpunch controllers found in the zmk-fingerpunch-controllers boards. - Note: You can look at the zmk-fingerpunch-keyboards build.yml to see all sorts of tested build combinations
Commit your changes, and wait for the github actions run to complete. Your firmware is ready!
Note
This example also includes adding a cirque trackpad, mostly to highlight a more complex example using the ffkb_v2.conf and ffkb_v2.overlay, or the rock_on_v1.conf and rock_on_v1.overlay. It also includes using Pete's cirque-input-module, defined in the config/west.yml. If you're simply overriding a keymap, and otherwise building a fingerpunch board, with or without a VIK module, then you don't need any of these things. This will likely be the case for most people using this guide.
west build --pristine -b "nice_nano_v2" -- -DSHIELD="ffkb_v2" -DZMK_CONFIG='/home/sadek/zmk-config-fp-example/config' -DZMK_EXTRA_MODULES='/home/sadek/zmk-fingerpunch-keyboards;/home/sadek/zmk-fingerpunch-controllers;/home/sadek/zmk-fingerpunch-vik;/home/sadek/cirque-input-module'
west build --pristine -b "nice_nano_v2" -- -DSHIELD="rock_on_v1" -DZMK_CONFIG='/home/sadek/zmk-config-fp-example/config' -DZMK_EXTRA_MODULES='/home/sadek/zmk-fingerpunch-keyboards;/home/sadek/zmk-fingerpunch-controllers;/home/sadek/zmk-fingerpunch-vik;/home/sadek/cirque-input-module'