RocksmithConvert 项目使用教程

1. 项目目录结构及介绍

RocksmithConvert 项目的目录结构如下：

rocksmithconvert/
├── docs/
│   └── ...
├── platypus/
│   └── ...
├── src/
│   └── rocksmithconvert/
│       ├── assets/
│       ├── convert_gui.py
│       ├── mainwindow.py
│       └── qt_wrapper.py
├── tests/
│   └── ...
├── .gitignore
├── LICENSE
├── Pyrocksmith-LICENSE
├── README.md
├── requirements-dev.txt
├── requirements-m1.txt
└── requirements.txt

目录结构介绍：

• docs/: 存放项目文档文件。
• platypus/: 存放与 Platypus 相关的文件。
• src/: 项目的源代码目录，包含主要的 Python 文件和资源文件。
  • rocksmithconvert/: 主要的 Python 代码目录。
    • assets/: 存放项目所需的资源文件。
    • convert_gui.py: 项目的启动文件，负责图形用户界面的初始化和运行。
    • mainwindow.py: 主窗口的 Python 文件，由 convert_gui.py 调用。
    • qt_wrapper.py: 用于兼容 PyQt5 和 PyQt6 的包装器文件。
• tests/: 存放项目的测试文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目的主许可证文件。
• Pyrocksmith-LICENSE: 与 Pyrocksmith 相关的许可证文件。
• README.md: 项目的说明文档。
• requirements-dev.txt: 开发环境所需的依赖包列表。
• requirements-m1.txt: 适用于 Apple Silicon 的依赖包列表。
• requirements.txt: 项目运行所需的依赖包列表。

2. 项目启动文件介绍

项目的启动文件是 src/rocksmithconvert/convert_gui.py。该文件负责初始化图形用户界面（GUI）并启动应用程序。

主要功能：

• 初始化 GUI: 使用 PyQt5 或 PyQt6 创建主窗口。
• 处理文件转换: 通过拖放文件到应用程序窗口，实现 Rocksmith 2014 CDLC 文件在 PC 和 MAC 之间的转换。
• 配置保存: 保存用户设置，以便下次启动时恢复。

3. 项目配置文件介绍

项目的配置文件主要包括以下几个：

• requirements.txt: 列出了项目运行所需的 Python 依赖包。
• requirements-dev.txt: 列出了开发环境所需的额外依赖包。
• requirements-m1.txt: 列出了适用于 Apple Silicon 的额外依赖包。

配置文件内容示例：

# requirements.txt
PyQt5==5.13.2
pyinstaller
git+https://github.com/0x0L/rocksmith.git

配置文件的作用：

• requirements.txt: 用于安装项目运行所需的 Python 包。
• requirements-dev.txt: 用于开发环境，包含测试和开发工具的依赖。
• requirements-m1.txt: 用于 Apple Silicon 设备，包含特定平台的依赖。

通过这些配置文件，开发者可以轻松地设置和运行项目，确保在不同环境下的一致性。