qmk_keymaps/README.md

QMK custom keymaps

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:

• DZ60RGB-WKL Hot-Swap PCB
• USB Drive Flash Manual (New Flash Manual)
• moyi4681/firmware

Compile

make dztech_dz60rgb_wkl
# Output is dztech_dz60rgb_wkl_v2_1_haunt98.bin

Keymap

qmkasciigen

asciiart

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 step:

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

• Introduction
• Keymap FAQ
• Keymap Overview
• Keycodes Overview
• Modifier Keys
• Quantum Keycodes
• Layers

More than Basic

• Debugging FAQ
• How to Customize Your Keyboard's Behavior
• List of Useful Core Functions To Make Your Keyboard Better
• Userspace: Sharing Code Between Keymaps

Do

• Bootmagic Lite: I use QK_BOOT with EE_CLR.
• Contact bounce / contact chatter
  • Measure and reduce keyboard input latency with QMK on the Kinesis Advantage (2021)
  • QMK debounce masterclass
  • Keyboard Matrix Scanning and Debouncing
• Grave Escape: Useful on layout <= 60%, because of missing Fn row.
• Mod-Tap: To replace CAPSLOCK with CTRL when hold and ESC when tap.
• Tap-Hold Configuration Options
• Tap Dance: A Single Key Can Do 3, 5, or 100 Different Things: I use it for safely QK_BOOT.
• Space Cadet: The Future, Built In: Quickly press (, ).
  • A Modern Space Cadet

Don't

• Magic Keycodes
• Command
• Mouse keys
• One Shot Keys
• RGB Matrix Lighting
• Auto Shift: Why Do We Need a Shift Key?: Conflict with space cadet when using vim :w -> :)w.
• A guide to home row mods: Hard to get it right, so ignore it for now.

Build/Optimize

• Configuring QMK
• Squeezing the most out of AVR
• Reducing firmware size
• Configuring QMK (VIA)

More

• Programming On 34 Keys
• Miryoku
• Pascal Getreuer's QMK keymap
• filterpaper/qmk_userspace
• RP2040 Controller is now the default option: Limit of ATmega32U4 aka Pro Micro:
  • Limited storage
  • Do not work well with USB-C to USB-C cable.

Tools:

• bloznelis/kbt

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:

• yskoht/keymapviz
• caksoylar/keymap-drawer

Karabiner-Elements

Copycat QMK features with software.

• Modern Space Cadet (rev 3)

TODO

• How to flash
• Add stock firmware/docs
• Add qmk lint
• Visualize
• qmkasciigen
  • Use flag
  • Add docs
  • Get data directly from qmk
  • Split transform keycodes to raw binding/transform (same as keymap-drawer)
  • Unicode support ?