qmk_keymaps/README.md

6.5 KiB

QMK custom keymaps

Go QMK

dztech/dz60rgb_wkl

V2.1: ATmega32U4 (AVR), takes .bin files Started shipping in June 2021 as a slightly modified version of v2.

Stock

Stock firmware is dztech_dz60rgb_wkl/stock/new dztech_dz60rgb_wkl_v3_via.bin. Can be flashed with QMK Toolbox.

Links:

Compile

make dztech_dz60rgb_wkl
# Output is dztech_dz60rgb_wkl_v2_1_haunt98.bin

Keymap

qmkasciigen

asciiart

caksoylar/keymap-drawer

caksoylar_keymap_drawer

Install

Locate firmware file after compile successfully or download from QMK action workflow

Put keyboard into bootloader mode in 2 ways:

  • Press QK_BOOT.
  • Unplug cable, then hold ESC and plug cable.

Use QMK Toolbox to flash.

Maintain

Step by steps:

  1. Make changes to keymaps: *.c, *.h, *.mk
  2. Push changes to GitHub
  3. Download firmware + keymaps JSON
  4. Replace repo keymaps JSON
  5. Visualize keymap: make draw

You don't need to install QMK CLI but still need QMK Toolbox.

Features

Basic

More than Basic

Do

Don't

Build/Optimize

Interesting

Tools:

qmkasciigen

Install:

go install github.com/haunt98/qmk_keymaps/cmd/qmkasciigen@latest

Usage:

# Generate from QMK repo
# Keymap must be JSON (exist keymap.json)
qmkasciigen -qmk-keyboard ymdk/id75 -qmk-keymap via -out ascii.txt

# Generate from local keymap.json
qmkasciigen -qmk-keyboard dztech/dz60rgb_wkl/v2_1 -qmk-keymap-file dztech_dz60rgb_wkl/keymaps_json/haunt98/keymap.json -out ascii.txt

Thanks:

TODO

  • How to flash
  • Add stock firmware/docs
  • Add qmk lint
  • Visualize
  • qmkasciigen
    • Use flag
    • Add docs
    • Get data directly from qmk
    • Use backspace/back depends on space allow