# 键位图生成小工具

**Repository Path**: northland_studio/keymaper

## Basic Information

- **Project Name**: 键位图生成小工具
- **Description**: 为 Minecraft 整合包作者打造的键位图生成工具
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-02-14
- **Last Updated**: 2026-02-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 🎮 KeyMaper - Minecraft 键位图生成器

<p align="center">
  <img src="icon.png" alt="Logo" width="120" height="120">
</p>

<p align="center">
  <strong>为 Minecraft 整合包作者打造的键位图生成工具</strong>
</p>

<p align="center">
  <a href="https://xuanjian.top/beiyu">
    <img src="https://img.shields.io/badge/北域工作室-Northland%20Studio-blue?style=flat-square" alt="Northland Studio">
  </a>
  <a href="#">
    <img src="https://img.shields.io/badge/版本-1.0.3-green?style=flat-square" alt="Version">
  </a>
  <a href="#">
    <img src="https://img.shields.io/badge/许可证-MIT-yellow?style=flat-square" alt="License">
  </a>
</p>

<p align="center">
  <a href="https://github.com/northland-studio/keymaper">GitHub</a> |
  <a href="https://gitee.com/northland_studio/keymaper">Gitee</a>
</p>

---

## ✨ 功能特性

### 🎯 核心功能
- **📁 自动导入** - 直接读取 Minecraft 的 `options.txt` 文件，自动解析键位配置
- **⌨️ 标准104配列** - 完整支持功能键区、主键区、编辑键区和数字键区
- **⌨️ 87配列** - 紧凑布局，无数字键区
- **🎨 自定义样式** - 自由调整按键颜色、文字颜色、边框样式、字体大小等
- **🔤 字体自选** - 支持多种字体选择（系统默认、Arial、微软雅黑、宋体等）
- **📝 标题定制** - 支持文字标题或 Logo 图片，可自定义对齐方式
- **⚙️ 按键编辑** - 点击预览区的按键即可在右侧编辑其功能
- **💾 预设管理** - 保存和加载键位预设，支持导入/导出 JSON 格式
- **📤 系统级导出** - 使用系统资源管理器选择保存路径，支持 PNG、JPG、SVG 格式
- **🔤 自定义字体** - 支持加载本地字体文件（TTF/OTF/WOFF）
- **🖼️ 背景图片** - 支持自定义背景图片，可调整模糊度和特效
- **✨ 按键特效** - 支持毛玻璃、液态玻璃等视觉特效
- **👁️ 实时预览** - 所见即所得的实时预览效果
- **📐 文字自适应** - 按键功能文字自动换行，自适应按键大小

### 🛠️ 技术特点
- 基于 **Tauri + React + TypeScript** 构建
- 现代化 UI 设计，支持响应式布局
- 本地数据存储，保护用户隐私

---

## 📦 安装与使用

### 下载安装
1. 前往 [GitHub Releases](https://github.com/northland-studio/keymaper/releases) 或 [Gitee Releases](https://gitee.com/northland_studio/keymaper/releases) 页面下载最新版本
2. 运行安装程序，按提示完成安装
3. 启动应用程序即可使用

### 使用方法

#### 1️⃣ 导入配置
- 点击「布局」标签页
- 选择「从 options.txt 导入」
- 选择你的 Minecraft 配置文件夹中的 `options.txt` 文件

#### 2️⃣ 编辑按键功能
- 在预览区点击任意按键
- 右侧会自动切换到「按键编辑」标签
- 输入功能名称并点击「更新功能」

#### 3️⃣ 自定义样式
- 点击「样式」标签页
- 调整按键颜色、文字颜色、边框样式、字体等
- 实时预览效果

#### 4️⃣ 设置标题
- 点击「标题」标签页
- 选择文字或图片标题
- 自定义对齐方式和字体

#### 5️⃣ 导出键位图
- 点击「导出」标签页
- 选择导出格式（PNG/JPG/SVG）
- 调整质量和缩放比例
- 点击「导出键位图」按钮
- 系统资源管理器会弹出，选择保存位置

---

## 🏗️ 开发构建

### 环境要求
- Node.js >= 18
- Rust >= 1.70
- npm 或 yarn

### 安装依赖
```bash
npm install
```

### 开发模式
```bash
npm run tauri dev
```

### 构建应用
```bash
npm run tauri build
```

构建完成后，可执行文件将位于 `src-tauri/target/release/` 目录下。

---

## 📁 项目结构

```
keymap-generation-tool/
├── src/                    # 前端源代码
│   ├── components/         # React 组件
│   │   ├── KeyboardRenderer.tsx    # 键盘渲染组件
│   │   └── ControlPanel.tsx        # 控制面板组件
│   ├── data/               # 数据文件
│   │   └── keyboardLayouts.ts      # 键盘布局定义
│   ├── types/              # TypeScript 类型定义
│   │   └── index.ts
│   ├── utils/              # 工具函数
│   │   ├── optionsParser.ts        # options.txt 解析器
│   │   ├── storage.ts              # 本地存储管理
│   │   └── export.ts               # 导出功能
│   ├── App.tsx             # 主应用组件
│   └── main.tsx            # 入口文件
├── src-tauri/              # Tauri 后端代码
│   ├── src/                # Rust 源代码
│   │   └── lib.rs          # 主库文件
│   ├── Cargo.toml          # Rust 依赖配置
│   └── tauri.conf.json     # Tauri 配置
├── public/                 # 静态资源
└── package.json
```

---

## 📝 更新日志

### v1.0.3 (2025-02-14)
- ✨ 新增取消选中按键功能，方便导出无高亮状态的键位图
- ✨ 新增清空背景图按钮
- ✨ 新增标题独立字体选择功能
- ✨ 新增标题自定义字体文件加载
- 🔧 修复导出图片使用正确字体的问题
- 🔧 修复标题字体无法独立选择的问题

### v1.0.2 (2025-02-14)
- ✨ 新增自定义字体文件加载功能（支持 TTF/OTF/WOFF 格式）
- ✨ 新增背景图片功能，支持自定义背景图
- ✨ 新增背景模糊度调节（0-20px）
- ✨ 新增背景特效（模糊、毛玻璃、液态玻璃）
- ✨ 新增按键特效（毛玻璃、液态玻璃）
- 🔧 修复预设和导出标签的emoji，改用符号（★、↓）

### v1.0.1 (2025-02-14)
- ✨ 新增标准104配列键盘布局（功能键区、主键区、编辑键区、数字键区）
- ✨ 新增按键交互功能：点击按键即可在右侧编辑
- ✨ 新增文字自适应边框机制，支持自动换行
- ✨ 新增字体自选功能（系统默认、Arial、微软雅黑、宋体等）
- ✨ 使用 Tauri 底层 API 实现系统资源管理器导出，可选择任意保存位置
- 🔧 修复官网链接无法点击的问题
- 🔧 移除UI中的emoji，改用符号和文字

### v1.0.0 (2025-02-14)
- 🎉 首次发布
- ✨ 基础键位图生成功能
- ✨ 支持导入 Minecraft options.txt
- ✨ 多种键盘布局
- ✨ 样式自定义
- ✨ 预设管理
- ✨ 多格式导出

---

## 🤝 贡献指南

欢迎提交 Issue 和 Pull Request！

1. Fork 本仓库
2. 创建你的功能分支 (`git checkout -b feature/AmazingFeature`)
3. 提交你的更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 打开一个 Pull Request

---

## 📄 许可证

本项目基于 [MIT](LICENSE) 许可证开源。

---

## 🙏 致谢

- [Tauri](https://tauri.app/) - 构建跨平台桌面应用的框架
- [React](https://react.dev/) - 用户界面库
- [Vite](https://vitejs.dev/) - 下一代前端构建工具

---

<p align="center">
  Made with ❤️ by <a href="https://xuanjian.top/beiyu">北域工作室 Northland Studio</a>
</p>