Keymap Drawer：键盘布局可视化神器完全指南

Keymap Drawer：键盘布局可视化神器完全指南

【免费下载链接】keymap-drawerVisualize keymaps that use advanced features like hold-taps and combos, with automatic parsing项目地址: https://gitcode.com/gh_mirrors/ke/keymap-drawer

项目概述

Keymap Drawer是一款强大的开源工具，能够将QMK和ZMK键位映射解析成清晰的SVG矢量图形。该工具特别强化了对按住加点击和组合键的支持，让复杂的键盘布局变得直观易懂。

核心功能特性

Keymap Drawer具备以下核心功能：

• 智能解析引擎：自动处理按住加点击和组合键逻辑，支持从现有固件配置快速生成布局图
• 高度自定义：使用人类可读的YAML格式配置键位图，自由调整符号、颜色和字体
• 双模式支持：提供命令行工具和Web应用两种使用方式
• 多样化输出：支持导出高质量的SVG图形，适合各种分辨率和用途
• 物理布局自由度高：支持任意物理键盘布局设计，包括正交布局和旋转键位

快速入门指南

安装方法

推荐使用pipx进行安装，这样可以创建独立的运行环境：

pipx install keymap-drawer

安装完成后，就可以使用keymap命令了：

keymap --help

从现有配置启动

使用keymap parse命令可以将现有的QMK或ZMK键位映射文件解析为YAML格式：

ZMK配置解析：

keymap parse -c 10 -z ~/zmk-config/config/cradio.keymap >sweep_keymap.yaml

QMK配置解析：

qmk c2json ~/qmk_firmware/keyboards/ferris/keymaps/username/keymap.c | keymap parse -c 10 -q - >sweep_keymap.yaml

生成SVG图形

解析完成后，使用keymap draw命令生成SVG图形：

keymap draw sweep_keymap.yaml >sweep_keymap.ortho.svg

高级定制技巧

自定义SVG图标

Keymap Drawer支持使用SVG图标作为图例，可以通过$$source:id$$格式引用远程图标库：

layers: Media: - ["", "$$mdi:volume-mute$$", "", "", ""]

支持的图标源包括：

• Material Design Icons (mdi)
• Google Material Symbols (material)
• Tabler Icons (tabler)
• Phosphor Icons (phosphor)
• Font Awesome (fa)

配置个性化样式

通过配置文件可以自定义绘制参数：

keymap dump-config >my_config.yaml

编辑配置文件后，可以应用到解析和绘制过程中：

keymap -c my_config.yaml parse [...] >my_keymap.yaml keymap -c my_config.yaml draw [...] my_keymap.yaml >my_keymap.svg

复杂组合键布局

对于非相邻键或3键以上的复杂组合，可以通过指定align和offset属性来优化位置：

combos: - {p: [0, 10, 20], k: RST, a: left} - {p: [4, 5], k: BOOT, a: top}

实际应用示例

以下是一个完整的键位映射配置示例：

layout: qmk_keyboard: corne_rotated layout_name: LAYOUT_split_3x5_3 layers: Base: - [Q, W, F, P, B, J, L, U, Y, "'"] - [{h: Ctrl, t: A}, {h: Gui, t: R}, {h: Alt, t: S}, {h: Shift, t: T}, G, M, {h: Shift, t: N}, {h: Alt, t: E}, {h: Gui, t: I}, {h: Ctrl, t: O}] - [Z, X, C, D, V, K, H, {t: ',', s: '<'}, {t: ., s: '>'}, {t: /, s: '?'}]

自动化工作流

对于使用ZMK配置仓库的用户，可以设置自动化工作流来解析和绘制键位映射：

name: Draw ZMK keymaps on: push: paths: - "config/*.keymap" - "config/*.dtsi" - "keymap_drawer.config.yaml" jobs: draw: uses: caksoylar/keymap-drawer/.github/workflows/draw-zmk.yml@main with: keymap_patterns: "config/*.keymap" config_path: "keymap_drawer.config.yaml" output_folder: "keymap-drawer"

项目优势

相比传统的键盘布局编辑器，Keymap Drawer采用更程序化的处理方式，将物理键盘布局与键位映射逻辑解耦，大大提高了效率和准确性。

• 程序化管理：区别于传统手动编辑，提高了处理复杂布局的能力
• 智能定位：自动为非相邻键组合绘制连接线
• 无缝集成：与现有固件配置完美兼容
• 持续更新：活跃的开源社区提供持续的技术支持

Keymap Drawer为键盘爱好者和开发者提供了一个不可或缺的工具，无论是想要打造独一无二的键盘配置，还是进行产品设计验证，都能满足你的需求。

【免费下载链接】keymap-drawerVisualize keymaps that use advanced features like hold-taps and combos, with automatic parsing项目地址: https://gitcode.com/gh_mirrors/ke/keymap-drawer