Mugur 项目使用教程

Mugur 项目使用教程

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

1. 项目目录结构及介绍

Mugur 是一个用于配置 QMK 兼容键盘的键盘配置工具。以下是项目的目录结构及其介绍：

mugur/
├── LICENSE             # 项目许可证文件
├── README.md           # 项目说明文件
├── mugur.el            # Mugur 的主要 Emacs Lisp 文件
└── ...                # 其他可能的配置文件和文档

• LICENSE: 项目的许可协议文件，通常为 GPL-3.0。
• README.md: 项目的主要说明文件，包含项目的简介、功能、配置和使用方法。
• mugur.el: Mugur 的核心文件，包含了所有的配置逻辑和功能实现。

2. 项目的启动文件介绍

Mugur 项目的主要启动文件是 mugur.el。这个文件是 Mugur 的核心，包含了创建键盘配置的所有逻辑。用户可以通过以下步骤来启动和使用 Mugur：

1. 将 mugur.el 文件添加到 Emacs 的加载路径中。
2. 在 Emacs 中加载 mugur.el 文件。
3. 使用 Mugur 提供的函数来定义键盘布局。

例如，以下是一个简单的键盘布局定义：

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

在这个例子中，我们定义了一个名为 "base" 的层，包含键 'a'、'b' 和 'c'，以及一个切换到 "numbers" 层的键。在 "numbers" 层中，我们定义了数字键 1、2 和 3，以及一个宏键，当按下时会发送字符串 "one two three"。

3. 项目的配置文件介绍

Mugur 的配置文件通常是包含在 mugur.el 中的 Emacs Lisp 配置。用户可以根据自己的需求来修改和扩展这些配置。以下是一些常见的配置选项：

• mugur-user-defined-keys: 用于定义用户自定义的键映射。
• mugur-leader-keys: 用于配置 Leader 键的行为。
• mugur-combo-keys: 用于定义组合键的行为。

例如，以下是如何设置用户自定义键映射：

(setf mugur-user-defined-keys
      '((uname "my_badass_username")
        (weird_key (C-c a "right?" ENT))))

在这个配置中，我们定义了两个自定义键映射，uname 和 weird_key，它们分别映射到特定的键组合和宏。

通过修改这些配置文件，用户可以定制自己的键盘配置，以适应不同的使用场景和个人偏好。

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