QMK Userspace

This repository contains my QMK keymaps for my Keychron K3 Max keyboard. The main repository for the QMK firmware is available here.

Currently implemented keymaps:

• NeoQWERTZ (no full support yet, see below)

Notes for each keymap

As stated before, all keymaps are for the Keychron K3 Max. Because of that the keymaps are based on the Keychron fork of the QMK firmware. You can find the source code here.

When flashing the keyboard, read the QMK documentation and have a look at the Keychron guide.

The keyboard supports runtime customization with VIA, though only with the Keychron configurator, not with the official VIA app.

NeoQWERTZ

The base for this layout is the QWERTZ version of the (for german layout) ergonomical optimized Neo layout.

Additionally, this includes also the default layout from Keychron for Windwows on layers 0 and 1. The NeoQWERTZ layout is on layers 2 and up. To switch between them, the hardware switch on the keyboard can be used.

Attention! This implementation for QMK does not contain all symbols and layers defined by the original NeoQWERTZ layout.

Limitations:

• Layer 2 does not contain
  • the symbols on the numbers
  • the in german unused accents
  • the longer dashes and "big" dot on comma, dot and minus
• Layer 3
  • does not contain the unicode characters
  • has the § on 3
  • has the € on 4
• Layer 4 does not contain the unicode characters
• Layer 5 and 6 are fully omitted

Howto build locally

1. Create a directory for QMK mkdir qmk && cd qmk
2. Create a Pytohn virtual environment in this folder python3 -m venv .venv && source .venv/bin/activate
3. Install QMK python3 -m pip install qmk
4. Setup QMK environment qmk setup --home ./qmk_firmware --branch wireless_playground Keychron/qmk_firmware
   • Allow the setup to set your QMK home to ./qmk_firmware
   • During development the branch above was referred by offical Keychron website but does not build with QMK userspace v1.1
   • Use wls_2025q1 instead, after it's merged, wireless_playground should also work fine
5. Clone this repository git clone git@github.com:ByteSturm/qmk_userspace.git
6. Set the QMK userspace overlay cd qmk_userspace/ && qmk config user.overlay_dir="$(pwd)"
7. Verify the overlay is correctly configured qmk config user.overlay_dir
8. Compile the firmware
   • Build all qmk userspace-compile
   • Build a specific keymap
     • NeoQWERTZ qmk compile -kb keychron/k3_max/iso/rgb -km via_neoqwertz