# UselessCapsLock

**Repository Path**: AiGenApps/useless-caps-lock

## Basic Information

- **Project Name**: UselessCapsLock
- **Description**: 对于我来说，大写锁没有用，所以有了这个软件。
For me, caps locks are rarely used, so this software was created.
- **Primary Language**: Go
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-12-04
- **Last Updated**: 2024-12-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# UselessCapsLock

#### 介绍
对于我来说，大写锁没有用，所以有了这个软件。
For me, caps locks are rarely used, so this software was created.
软件核心功能：按键映射。

#### 界面展示
![按键映射配置界面](./images/screenshot.png)
主界面支持多组按键映射配置，可以灵活设置按键之间的映射关系。

![设置界面](./images/settings.png)
设置界面提供了：
- 开机自启动
- 启动时自动打开配置界面

#### 软件架构
- GUI框架：
  - 配置界面：Web界面 (HTML + CSS + JavaScript)
  - 系统托盘：systray
- 核心功能：
  - 按键映射：全局键盘钩子
- 跨平台支持：
  - Windows ✓
  - MacOS (计划中)
  - Linux (计划中)

#### 安装教程
1. 下载最新版本的发布包
2. 由于程序使用了系统级的键盘监听，可能会被杀毒软件误报。这是正常现象，您可以：
   - 添加信任或白名单
   - 点击"更多信息" -> "仍要运行"来运行程序
3. 解压后运行可执行文件
4. 程序将在系统托盘中显示图标

> ⚠️ 安全说明：本程序是开源的键盘映射工具，源代码完全公开透明。程序仅进行键盘按键的重映射，不会收集或传输任何用户数据。

#### 使用说明
1. 程序启动后会在系统托盘显示图标
2. 点击托盘图标打开配置界面
3. 在配置界面中：
   - 选择源按键
   - 选择目标映射按键
   - 点击保存应用更改
4. 配置会自动保存，下次启动时自加载

> ⚠️ 注意：请勿与其他按键映射软件同时使用，可能会导致部分按键失效。

#### 参与贡献
1. Fork 本仓库
2. 新建分支
3. 提交代码
4. 新建 Pull Request

#### 特技
- 支持热重载配置
- 低资源占用
- 简单易用的界面

#### 版本管理
项目使用 Git hooks 自动维护版本号：
- 版本号格式：`YY.MMDD.HHMMSS`
- 示例：`23.1204.154500` 表示 2023年12月4日15点45分00秒
- 每次提交自动增加修订号(patch)
- 版本号存储在 `version` 文件中
- 打包时自动使用最新版本号

#### 开发说明
1. 首次克隆后需要初始化 Git hooks：
   ```bash
   # Windows
   scripts\init-hooks.bat
   
   # Linux/MacOS
   chmod +x scripts/git-hooks/pre-commit
   git config core.hooksPath scripts/git-hooks
   ```
2. 版本号说明：
   - 格式为：YY.MMDD.HHMMSS
   - 每次提交时自动更新为当前时间
   - YY: 年份后两位
   - MMDD: 月日
   - HHMMSS: 时分秒
3. 手动更新版本号：
   ```bash
   # Windows
   scripts\update-version.bat
   
   # Linux/MacOS
   YEAR=$(date +%y); MMDD=$(date +%m%d); HHMMSS=$(date +%H%M%S); echo "$YEAR.$MMDD.$HHMMSS" > version
   ```