Mugur键盘配置生成器使用教程

Mugur键盘配置生成器使用教程

mugur Configurator for QMK compatible keyboards 项目地址: https://gitcode.com/gh_mirrors/mu/mugur

1. 项目介绍

Mugur是一个键盘配置生成器，专为QMK（ Quantum Mechanical Keyboard）兼容键盘设计。它能够接收键盘的层和键的列表，并生成等效的QMK C代码，这样用户就可以轻松地将配置刷写到键盘上。Mugur支持QMK的基本键码、Mod-tap、修饰键、一键发送、层切换、宏、按键连击、 Leader键和组合键等多种功能。此外，如果某个Emacs函数有键位绑定，用户可以直接将函数名作为键位使用。

2. 项目快速启动

环境准备

在开始之前，请确保你的系统中已经安装了以下软件：

• Emacs（建议版本26或以上）
• QMK固件工具链

克隆项目

首先，从你的命令行界面克隆Mugur项目：

git clone https://github.com/mihaiolteanu/mugur.git
cd mugur

配置Mugur

在Emacs中打开mugur.el文件，并根据你的键盘和需求进行配置。

生成C代码

使用Mugur配置文件生成QMK固件所需的C代码：

(mugur-mugur
 '(
   ("base" "a b c (LT numbers d)")
   ("numbers" "1 2 3")
   ("one two three")
   ))

上述代码示例定义了一个包含两个层的键盘布局。在“base”层中，有键'a'、'b'、'c'和一个层切换键，它在按下时激活“numbers”层，在轻触时发送'd'。在“numbers”层中，有数字'1'、'2'和'3'，以及一个宏键，当按下时发送字符串"one two three"。

编译和刷写固件

将生成的C代码集成到你的QMK固件项目中，编译并刷写到你的键盘。

3. 应用案例和最佳实践

案例一：自定义层切换

对于复杂的键盘布局，用户可能会需要快速在多个层之间切换。使用Mugur，可以通过简单的配置实现层切换，提高使用效率。

("base" ("a b (TG numbers)" "c (TG symbols)" "d (TG nav)"))

在这个配置中，按下'a'键将切换到“numbers”层，按下'c'键切换到“symbols”层，按下'd'键切换到“nav”层。

案例二：宏命令的使用

在游戏中或执行复杂命令时，宏命令可以大大提高操作速度。使用Mugur定义宏命令，可以简化键位操作。

("gaming" ("w (C-w)" "a (C-a)" "s (C-s)" "d (C-d)"))

上述配置中，当在“gaming”层时，按下'w'、'a'、's'、'd'键将分别发送带有Ctrl修饰符的对应按键，这对于游戏中的快速移动非常有用。

4. 典型生态项目

Mugur作为QMK生态系统的一部分，可以与其他开源项目相结合，以提供更丰富和个性化的键盘体验。例如，与qmk-configurator项目结合，用户可以通过图形界面来配置键盘，然后再使用Mugur生成底层C代码。此外，社区中还涌现出了许多基于Mugur的键盘布局分享项目，用户可以借鉴和定制这些布局来适合自己的需求。

mugur Configurator for QMK compatible keyboards 项目地址: https://gitcode.com/gh_mirrors/mu/mugur