ZMK-Helpers 使用指南

ZMK-Helpers 使用指南

zmk-helpersConvenience macros simplifying ZMK's keymap configuration项目地址:https://gitcode.com/gh_mirrors/zm/zmk-helpers

项目目录结构及介绍

ZMK-Helpers 是一个简化ZMK键盘映射配置的便利宏集合，位于 https://github.com/urob/zmk-helpers.git。该仓库遵循清晰的组织结构，帮助用户高效地集成自定义行为、键位布局和国际字符支持到他们的ZMK固件中。

主要目录介绍

• include/zmk-helpers: 包含核心助手宏文件如 helper.h 和针对特定键盘布局的键位标签，以及不同语言的Unicode字符集。
  • helper.h: 核心头文件，提供了定义行为、组合键、层等的便利宏。
  • <language>.dtsi: 如 german.dtsi，包含用于输入非英文字符的Unicode字符定义。
• docs: 文档部分，可能包括用户指南或迁移指南等。
• .gitattributes, .editorconfig, .prettierrc: 版本控制和代码风格配置文件。
• LICENSE: 许可证文件，描述了软件的使用许可条款。
• README.md: 项目概述和快速入门说明。

项目的启动文件介绍

在ZMK固件项目中，没有传统意义上的“启动文件”，但关键的集成点在于你的ZMK配置中的关键map文件以及west.yml。当你想利用zmk-helpers时，主要入口是通过在你的键位映射文件中包含helper.h，通常是这样的过程：

1. 在你的ZMK配置（通常是config目录下）通过西向管理器(west)配置文件west.yml引入这个项目作为子模块或者远程库。
2. 在键位映射(.c)文件顶部添加如下包含语句来启用ZMK-Helpers的功能：

   #define HOST_OS 2
   #include "zmk-helpers/helper.h"
   

   （具体包含哪些辅助文件取决于需求，例如国际化字符支持还需引入相应的Unicode字符文件）

项目的配置文件介绍

west.yml

west.yml是用于管理ZMK配置的文件，它定义了远程存储库和项目依赖。对于集成zmk-helpers，你需要在manifest:下面添加remote和对应的project，确保你的配置包含以下类似条目：

remotes:
  - name: urob
    url-base: https://github.com/urob

projects:
  - name: zmk-helpers
    remote: urob
    revision: main
    self:
      path: config/zmk-helpers

这一配置使得West可以下载并集成zmk-helpers到你的项目配置中。

键位映射配置文件

虽然不直接称为“配置文件”，键位映射的.c文件或相关配置文件（比如特定键位的行为定义），是实际应用zmk-helpers宏的地方。通过源码包含和使用这些助手宏，你可以无需深入底层细节就能定义复杂的键盘行为和布局。

通过以上介绍，你应该能够理解如何导航和配置zmk-helpers以增强你的ZMK固件项目功能。记得查阅具体的宏文档和示例来最大化其使用效益。

zmk-helpersConvenience macros simplifying ZMK's keymap configuration项目地址:https://gitcode.com/gh_mirrors/zm/zmk-helpers