Project Babble 安装与使用教程

1. 项目目录结构及介绍

Project Babble 是一个开源的口部追踪方法，适用于 VR 设备。项目的目录结构如下：

ProjectBabble/
├── BabbleApp/
│   ├── ...
├── scripts/
│   ├── ...
├── unitybuild/
│   ├── ...
├── github/workflows/
│   ├── ...
├── idea/
│   ├── ...
├── .gitignore
├── Babble.png
├── LICENSE.md
├── README.md
├── poetry.lock
├── pyproject.toml
└── requirements.txt

目录结构介绍

• BabbleApp/: 包含项目的主要应用程序代码。
• scripts/: 包含项目的脚本文件，用于自动化任务。
• unitybuild/: 包含与 Unity 相关的构建文件。
• github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• idea/: 包含与 IntelliJ IDEA 相关的配置文件。
• .gitignore: Git 忽略文件配置。
• Babble.png: 项目的图标或相关图片。
• LICENSE.md: 项目的开源许可证文件。
• README.md: 项目的说明文档。
• poetry.lock: Poetry 依赖锁定文件。
• pyproject.toml: Poetry 项目配置文件。
• requirements.txt: Python 依赖列表文件。

2. 项目启动文件介绍

项目的启动文件通常位于 BabbleApp/ 目录下。具体启动文件可能包括：

• main.py: 主程序入口文件，负责初始化和启动应用程序。
• app.py: 应用程序的核心逻辑文件，处理口部追踪的算法和逻辑。

启动步骤

1. 确保已安装所有依赖项，可以通过运行 pip install -r requirements.txt 来安装。
2. 进入 BabbleApp/ 目录。
3. 运行 python main.py 启动应用程序。

3. 项目配置文件介绍

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

• pyproject.toml: 使用 Poetry 管理项目的依赖和构建配置。
• requirements.txt: 列出了项目所需的所有 Python 依赖项。

配置文件说明

• pyproject.toml:

  • [tool.poetry]: 定义了项目的元数据，如名称、版本、作者等。
  • [tool.poetry.dependencies]: 列出了项目所需的 Python 依赖项及其版本。
  • [tool.poetry.dev-dependencies]: 列出了开发环境所需的依赖项。

• requirements.txt:

  • 列出了项目运行所需的所有 Python 包及其版本。

配置步骤

1. 使用 Poetry 安装依赖：poetry install。
2. 如果使用 requirements.txt，则运行 pip install -r requirements.txt。

通过以上步骤，您可以成功安装并启动 Project Babble 项目。