EyeTrackVR 项目使用教程

1. 项目目录结构及介绍

EyeTrackVR 项目的目录结构如下：

EyeTrackVR/
├── EyeTrackApp/
│   ├── __init__.py
│   ├── main.py
│   └── ...
├── repo-tools/
│   ├── tool1.py
│   ├── tool2.py
│   └── ...
├── .gitignore
├── CODE_OF_CONDUCT.md
├── LICENSE
├── README.md
├── SECURITY.md
├── poetry.lock
└── pyproject.toml

目录结构介绍

• EyeTrackApp/: 包含项目的主要应用程序代码。

  • __init__.py: 初始化文件。
  • main.py: 主启动文件。
  • 其他相关代码文件。

• repo-tools/: 包含项目使用的工具代码。

  • tool1.py, tool2.py: 各种工具脚本。

• .gitignore: Git 忽略文件配置。

• CODE_OF_CONDUCT.md: 行为准则文件。

• LICENSE: 项目许可证文件（GPL-3.0）。

• README.md: 项目介绍和使用说明。

• SECURITY.md: 安全相关说明。

• poetry.lock: Poetry 依赖锁定文件。

• pyproject.toml: Poetry 项目配置文件。

2. 项目启动文件介绍

项目的启动文件位于 EyeTrackApp/main.py。该文件是 EyeTrackVR 应用程序的主入口点。

main.py 文件介绍

# EyeTrackApp/main.py

def main():
    # 主程序逻辑
    pass

if __name__ == "__main__":
    main()

• main() 函数: 这是应用程序的主函数，包含了启动 EyeTrackVR 的主要逻辑。
• if name == "main":: 确保该脚本作为主程序运行时才会执行 main() 函数。

3. 项目配置文件介绍

项目的配置文件主要位于 pyproject.toml 和 poetry.lock。

pyproject.toml 文件介绍

[tool.poetry]
name = "EyeTrackVR"
version = "0.1.0"
description = "Open source and affordable VR eye tracker platform for VRChat via OSC and UDP protocol."
authors = ["Your Name <[e-mail]>"]
license = "GPL-3.0"

[tool.poetry.dependencies]
python = "^3.8"
# 其他依赖项

[tool.poetry.dev-dependencies]
# 开发依赖项

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

• [tool.poetry]: 项目的基本信息，包括名称、版本、描述、作者和许可证。
• [tool.poetry.dependencies]: 项目依赖的 Python 包。
• [tool.poetry.dev-dependencies]: 开发环境依赖的 Python 包。
• [build-system]: 构建系统配置。

poetry.lock 文件介绍

poetry.lock 文件由 Poetry 自动生成，用于锁定项目依赖的具体版本，确保在不同环境中依赖的一致性。

总结

通过本教程，您应该对 EyeTrackVR 项目的目录结构、启动文件和配置文件有了基本的了解。希望这些信息能帮助您更好地理解和使用该项目。