文档: 添加中文 README 并更新 gitignore 配置

This commit is contained in:
2026-01-01 14:38:41 +08:00
parent 930fa1f4c6
commit 4e5dbf8ad8
2 changed files with 54 additions and 0 deletions

5
.gitignore vendored
View File

@@ -4,3 +4,8 @@ __pycache__/
.idea/ .idea/
.vscode/ .vscode/
*.log *.log
# Build artifacts
build/
dist/
*.spec

49
README.md Normal file
View File

@@ -0,0 +1,49 @@
# 太鼓达人自制谱编辑器 (Taiko Editor)
这是一个基于 Python/Pygame 开发的现代风格太鼓达人自制谱编辑器。支持深色主题、时间轴编辑、实时录制和 TJA 格式导出。
## 功能特性
* **现代 UI 设计**: 采用类似 Bcut (必剪) 的深色 NLE 风格界面。
* **可视化时间轴**: 支持缩放、滚动、拖拽音符。
* **实时录制**:
* 在播放时按下 `F`/`J` (咚) 和 `D`/`K` (咔) 进行录制。
* 支持同时按下检测 (例如 F+J = 大咚)。
* **多难度管理**: 支持 Easy/Normal/Hard/Oni/Edit 多个难度层级。
* **中文支持**: 内置字体管理器,自动适配系统中的微软雅黑/黑体等中文字体。
* **TJA 导出**: 编辑完成后可直接导出标准 TJA 格式文件。
## 运行方式
### 源码运行
需要安装 Python 3.10+ 和相关依赖:
```bash
pip install -r requirements.txt
python main.py
```
### 使用打包好的程序
下载 Release 中的 `TaikoEditor.exe` 直接运行即可。
## 操作指南
* **左侧素材库**: 拖拽音符到时间轴。
* **时间轴**:
* `左键`: 选择音符 / 拖拽。
* `右键`: 删除音符。
* `Ctrl + 滚轮`: 缩放时间轴。
* `滚轮`: 左右移动时间轴。
* **录制模式**: 点击预览窗口的播放按钮,跟随音乐按下键盘即可。
## 开发与构建
如果要自行打包为 exe 文件:
```bash
pip install pyinstaller
pyinstaller --noconsole --onefile --name "TaikoEditor" main.py
```
打包产物位于 `dist/` 目录。