NuDelta 开源项目教程

NuDelta 开源项目教程

nudelta Open source NuPhy Console alternative 项目地址: https://gitcode.com/gh_mirrors/nu/nudelta

1. 项目介绍

NuDelta 是一个开源的 NuPhy 控制台替代品，通过逆向工程键盘的 USB 协议创建。该项目支持 NuPhy Air75 和 Halo75 键盘，适用于 Windows 10+、macOS 11+ 和 Linux 系统。NuDelta 允许用户加载和保存键盘映射配置，支持备份和导出键盘映射为二进制格式，并提供命令行界面（CLI）来操作这些功能。

2. 项目快速启动

2.1 环境准备

• 操作系统: Windows 10 或更高版本、macOS 11 或更高版本、Linux 2.6.39 或更高版本（glibc 2.17 或更高版本）
• 处理器: x86-64
• 开发工具: C++17 编译器（推荐 Clang 或 MSVC）、CMake、Node 14+（带 Yarn）、Git

2.2 克隆项目并初始化子模块

git clone https://github.com/donn/nudelta.git
cd nudelta
git submodule update --init --recursive

2.3 构建项目

rm -rf build
yarn
yarn build-native  # 构建 CLI / 库
yarn build         # 构建 GUI

2.4 运行 CLI

在 Linux 上，您需要使用 sudo 来运行 CLI。在 macOS 上，您需要授予终端应用程序输入监控权限。Windows 上不需要特殊权限。

# 加载自定义配置文件
nudelta -l /path/to/your_remap.yml

# 重置键盘映射到默认设置
nudelta -r

3. 应用案例和最佳实践

3.1 自定义键盘映射

NuDelta 允许用户通过 YAML 配置文件自定义键盘映射。以下是一个简单的配置示例：

keys:
  capslock: esc

您可以在 res/air75/indices_win.yml 中找到可替换的键列表，在 res/air75/default_keymap_win.yml 中找到替换键码的列表。

3.2 备份和恢复键盘映射

使用 NuDelta 的 CLI，您可以轻松备份当前的键盘映射，并在需要时恢复它：

# 备份当前键盘映射
nudelta -b /path/to/backup.bin

# 从备份文件恢复键盘映射
nudelta -r /path/to/backup.bin

4. 典型生态项目

NuDelta 作为一个开源项目，可以与其他开源工具和项目结合使用，以增强其功能和扩展其应用场景。以下是一些可能的生态项目：

• QMK Firmware: 一个开源的键盘固件，支持自定义键盘映射和宏。NuDelta 可以与 QMK 结合使用，提供更高级的键盘自定义功能。
• AutoHotkey: 一个用于 Windows 的脚本语言，可以自动化键盘和鼠标操作。NuDelta 可以与 AutoHotkey 结合，实现更复杂的键盘映射和自动化任务。
• Karabiner-Elements: 一个用于 macOS 的键盘自定义工具，支持复杂的键盘映射和宏。NuDelta 可以与 Karabiner-Elements 结合，提供跨平台的键盘自定义解决方案。

通过这些生态项目的结合，NuDelta 可以为用户提供更强大的键盘自定义和自动化功能。

nudelta Open source NuPhy Console alternative 项目地址: https://gitcode.com/gh_mirrors/nu/nudelta