Tickeys 项目使用教程

1. 项目目录结构及介绍

Tickeys 项目的目录结构如下：

Tickeys/
├── Tickeys.app/
│   └── Contents/
│       ├── Resources/
│       │   └── data/
│       ├── SharedSupport/
│       └── src/
├── assets/
├── readme_images/
├── .editorconfig
├── .gitignore
├── Cargo.lock
├── Cargo.toml
├── LICENSE
├── README.md
├── Tickeys new.icns
├── build-product.sh
├── build.rs
└── changelog.md

目录结构介绍

• Tickeys.app/: 应用程序的主目录，包含应用程序的内容和资源。
  • Contents/: 应用程序的主要内容目录。
    • Resources/: 包含应用程序的资源文件，如数据文件和图标。
      • data/: 包含自定义音效的配置文件和音频文件。
    • SharedSupport/: 共享支持文件。
    • src/: 源代码目录，包含 Rust 代码。
• assets/: 项目资产文件，如图片、样式表等。
• readme_images/: 包含 README 文件中使用的图片。
• .editorconfig: 编辑器配置文件，用于统一代码风格。
• .gitignore: Git 忽略文件配置。
• Cargo.lock: Cargo 依赖锁定文件。
• Cargo.toml: Cargo 项目配置文件，定义项目的依赖和元数据。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• Tickeys new.icns: 应用程序图标文件。
• build-product.sh: 构建产品的脚本文件。
• build.rs: 构建脚本文件。
• changelog.md: 项目变更日志文件。

2. 项目启动文件介绍

Tickeys 项目的启动文件是 Tickeys.app/Contents/MacOS/Tickeys。这个文件是应用程序的可执行文件，负责启动 Tickeys 应用程序并加载配置和资源。

启动文件介绍

• Tickeys.app/Contents/MacOS/Tickeys: 这是 Tickeys 应用程序的主可执行文件。双击此文件或通过命令行运行它，即可启动 Tickeys 应用程序。

3. 项目配置文件介绍

Tickeys 项目的配置文件主要位于 Tickeys.app/Contents/Resources/data/ 目录下。主要的配置文件是 schemes.json，它定义了键盘音效的配置。

配置文件介绍

• schemes.json: 这个文件定义了键盘音效的配置，包括音效文件的路径、按键与音效的映射关系等。

schemes.json 示例

[
  {
    "name": "myDrum",
    "display_name": "My Drum",
    "files": ["1.wav", "2.wav", "3.wav", "4.wav", "space.wav", "backspace.wav", "enter.wav"],
    "non_unique_count": 4,
    "key_audio_map": {
      "36": 6,
      "49": 4,
      "51": 5
    }
  }
]

• name: 音效方案的名称，必须与音效文件目录名称一致。
• display_name: 音效方案的显示名称。
• files: 音效文件列表。
• non_unique_count: 前 N 个音效文件自动映射到按键。
• key_audio_map: 按键代码与音效文件索引的映射关系。

通过编辑 schemes.json 文件，用户可以自定义键盘音效方案。