以下是为 **YOLO Game UI Capture System** 设计的 **专业级、可扩展、生产就绪的项目目录结构(Project Structure)**,严格遵循 Python 工程最佳实践(PEP 420 implicit namespaces + src layout),并为每个 `.py` 文件提供 **精准功能定位、模块职责、依赖关系与使用说明**。所有路径均适配 Windows/macOS/Linux,支持 `pip install -e .` 开发安装。
---
```markdown
# 📁 项目目录结构(v1.0)
```
yolo-ui-capture/ # 项目根目录(建议用此名,语义清晰)
├── pyproject.toml # ✅ 标准化构建配置(替代 setup.py)
├── README.md # ✅ 架构总览 + 快速启动
├── ARCHITECTURE.md # ✅ 上文已生成的完整架构文档
├── requirements.txt # ✅ 生产依赖(精简版,不含 dev 工具)
├── dev-requirements.txt # ✅ 开发依赖(black, pytest, mypy)
├── .gitignore # ✅ 已预置:__pycache__, *.pyc, logs/, dataset/, weights/
├── src/ # ✅ PEP 420 推荐:源码根目录(避免隐式命名空间污染)
│ └── yolo_ui_capture/ # ✅ 包名(snake_case,符合 PEP 8)
│ ├── __init__.py # ✅ 空文件,声明包;可导出核心类:`from yolo_ui_capture import YOLOCapture`
│ │
│ ├── core/ # 🔑 核心运行时模块(无外部依赖)
│ │ ├── __init__.py
│ │ ├── capture.py # 🎯 全屏/ROI 截图引擎(mss + ctypes 线程安全封装)
│ │ ├── window.py # 🖼️ Windows 原生窗口管理(CreateWindowExW / SetLayeredWindowAttributes)
│ │ └── utils.py # ⚙️ 通用工具:DPI 感知、分辨率获取、FPS 计算器
│ │
│ ├── model/ # 🧠 模型推理与封装层
│ │ ├── __init__.py
│ │ ├── yolo.py # 🤖 YOLOv8/v10 推理统一接口(自动选择最优 backend)
│ │ └── base.py # 🧩 抽象基类 `BaseDetector`(为 future SAM/GroundingDINO 预留)
│ │
│ ├── annotation/ # 🏷️ 标注生成与数据集管理
│ │ ├── __init__.py
│ │ ├── saver.py # 💾 自动保存 JPG + YOLO TXT / COCO JSON(含 train/val 划分)
│ │ └── roi.py # 🖱️ ROI 模式交互:鼠标事件回调 + 矩形绘制(非阻塞)
│ │
│ ├── ui/ # 🖥️ 可视化与用户交互
│ │ ├── __init__.py
│ │ ├── display.py # 📺 OpenCV 窗口管理 + FPS overlay + 键盘事件分发
│ │ └── overlay.py # 🌈 透明图层绘制(检测框/类别标签/状态栏)
│ │
│ └── app.py # 🚀 主应用入口(组合所有模块,定义 CLI 参数)
│
├── dataset/ # 📂 自动生成(由 saver.py 创建,.gitignore 已排除)
│ ├── images/
│ │ ├── train/
│ │ └── val/
│ ├── labels/
│ │ ├── train/
│ │ └── val/
│ └── data.yaml # 📝 训练配置模板(需用户填写 nc/names)
│
├── weights/ # 📦 模型权重(默认下载 yolov10n.pt,可替换为自训练模型)
│ └── yolov10n.pt # ✅ 官方预训练权重(首次运行自动下载)
│
├── logs/ # 📜 运行日志(按日期分割,保留 7 天)
│ └── yolo_ui_capture_2024-06-15.log
│
└── examples/ # 🧪 示例脚本(非必需,但强烈推荐)
├── train_custom_model.py # 🛠️ 完整训练流程示例(含数据增强、早停、验证)
├── deploy_onnx.py # 🚀 ONNX 推理示例(脱离 ultralytics 依赖)
└── bind_to_game_window.py # 🎮 游戏窗口绑定示例(FindWindow + SetWindowPos)
```
---
## 📄 每个 `.py` 文件详细说明(按模块分组)
### 🔹 `src/yolo_ui_capture/core/`
| 文件 | 职责 | 关键特性 | 依赖 | 使用场景 |
|------|------|----------|------|----------|
| `capture.py` | **全屏/ROI 图像捕获引擎** | • 线程内创建 `mss.mss()` 实例(彻底解决 `srcdc` bug)<br>• 支持 `monitor={left,top,width,height}` 动态 ROI<br>• 内置帧队列(`queue.Queue(maxsize=2)`)防堆积 | `mss`, `numpy`, `threading` | 所有需要截图的模块(`app.py`, `saver.py`) |
| `window.py` | **Windows 原生窗口控制** | • `ctypes.user32.CreateWindowExW` 替代 `pywin32`(规避 `This param must be None`)<br>• `SetLayeredWindowAttributes` 实现透明 overlay<br>• DPI 感知注册(`SetProcessDpiAwareness(1)`) | `ctypes`, `win32api`(仅用于分辨率) | `app.py` 初始化 overlay 窗口 |
| `utils.py` | **底层工具函数** | • `_get_primary_monitor_physical_resolution()`(绕过缩放比例)<br>• `FPSCounter` 类(线程安全计数)<br>• `scale_bbox()`(归一化坐标转换) | `win32api`, `time` | 被 `capture.py` / `display.py` / `overlay.py` 共同调用 |
### 🔹 `src/yolo_ui_capture/model/`
| 文件 | 职责 | 关键特性 | 依赖 | 使用场景 |
|------|------|----------|------|----------|
| `yolo.py` | **YOLO 推理统一接口** | • 自动检测 CUDA 并选择 `device="cuda"` 或 `"cpu"`<br>• 封装 `model.predict()` 为 `detect(frame: np.ndarray) -> List[Detection]`<br>• 支持 `yolov10n.pt` / `yolov8s.pt` / `yolov8n-seg.pt` | `ultralytics`, `torch` | `app.py` 调用推理,`overlay.py` 获取检测结果 |
| `base.py` | **检测器抽象基类** | • 定义 `detect()`, `export()`, `benchmark()` 标准接口<br>• 为未来集成 `GroundingDINO` / `SAM` 提供契约 | `abc` | 仅当需扩展新模型时继承(如 `sam_detector.py`) |
### 🔹 `src/yolo_ui_capture/annotation/`
| 文件 | 职责 | 关键特性 | 依赖 | 使用场景 |
|------|------|----------|------|----------|
| `saver.py` | **数据集自动构建器** | • `save_image_and_label()`:按哈希值 8:2 划分 train/val<br>• 支持 `format="yolo"`(默认)或 `"coco"`<br>• 自动创建缺失目录(`os.makedirs(..., exist_ok=True)`) | `cv2`, `pathlib`, `hashlib` | `app.py` 响应 F1/F2 键事件 |
| `roi.py` | **ROI 交互控制器** | • `cv2.setMouseCallback()` 绑定 `on_mouse_event`<br>• 实时绘制半透明选区矩形(`cv2.rectangle(..., -1)`)<br>• 返回 `(x,y,w,h)` 供 `capture.py` 使用 | `cv2`, `numpy` | `app.py` 启用 ROI 模式时加载 |
### 🔹 `src/yolo_ui_capture/ui/`
| 文件 | 职责 | 关键特性 | 依赖 | 使用场景 |
|------|------|----------|------|----------|
| `display.py` | **主显示窗口管理** | • `cv2.namedWindow()` + `cv2.resizeWindow()`<br>• `cv2.waitKey(10)` 键盘事件分发(F1/F2/F3/ESC)<br>• 线程安全 `frame_queue.get_nowait()` 取帧 | `cv2`, `queue` | `app.py` 的显示循环主体 |
| `overlay.py` | **检测结果可视化层** | • `draw_detections()`:在 canvas 上绘制带颜色的 bbox + label<br>• 支持 `show_confidence=True/False`<br>• 自动适配 ROI 缩放坐标(调用 `utils.scale_bbox()`) | `cv2`, `numpy`, `yolo_ui_capture.utils` | `display.py` 调用以叠加检测框 |
### 🔹 `src/yolo_ui_capture/app.py`(主入口)
| 特性 | 说明 |
|------|------|
| **核心职责** | 组合 `core.capture` / `model.yolo` / `annotation.saver` / `ui.display` 四大模块,定义 CLI 参数与生命周期 |
| **CLI 支持** | `python -m yolo_ui_capture --model yolov10n.pt --conf 0.4 --device cuda`(通过 `argparse`) |
| **生命周期** | `start()` → 启动三线程 → `stop()` → 安全释放资源(`cv2.destroyAllWindows()`, `user32.DestroyWindow()`) |
| **错误防护** | `try/except` 包裹所有关键操作,日志记录完整 traceback,确保 `stop()` 总被调用 |
---
## 🛠️ `pyproject.toml` 样例(标准化构建)
```toml
[build-system]
requires = ["setuptools>=45", "wheel", "setuptools_scm[toml]>=6.2"]
build-backend = "setuptools.build_meta"
[project]
name = "yolo-ui-capture"
version = "1.0.0"
description = "Real-time YOLO UI detection for games and applications"
authors = [{name = "Your Name", email = "you@example.com"}]
readme = "README.md"
requires-python = ">=3.9"
classifiers = [
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: Microsoft :: Windows",
]
dependencies = [
"opencv-python>=4.8.0",
"numpy>=1.24.0",
"mss>=9.0.0",
"pywin32>=305",
"ultralytics>=8.2.0",
"torch>=2.0.0",
]
[project.optional-dependencies]
dev = ["black==24.4.0", "pytest==8.2.0", "mypy==1.10.0"]
[project.urls]
Homepage = "https://github.com/yourname/yolo-ui-capture"
Repository = "https://github.com/yourname/yolo-ui-capture"
```
> ✅ 此配置支持:
> - `pip install -e .`(开发模式,修改代码立即生效)
> - `pip install yolo-ui-capture`(发布后)
> - `python -m yolo_ui_capture --help`(自动识别 CLI)
---
## 📌 目录设计原则总结
| 原则 | 如何体现 | 价值 |
|------|----------|------|
| **关注点分离** | `core/`(采集)、`model/`(AI)、`annotation/`(数据)、`ui/`(交互)严格隔离 | 修改标注逻辑不影响推理性能 |
| **可测试性** | 每个模块可独立 `import` + `pytest`(如 `test_capture.py` 可 mock `mss`) | 单元测试覆盖率 > 80% |
| **可扩展性** | `model/base.py` 抽象接口 + `examples/` 预留扩展点 | 3 行代码接入 SAM(`class SAMDetector(BaseDetector)`) |
| **生产就绪** | `logs/` 自动轮转、`dataset/` 自动创建、`.gitignore` 精确排除 | 开箱即用,无需手动配置路径 |
| **跨平台友好** | `src/` 结构 + `pathlib` 路径操作 + `os.name` 条件分支 | 后续 macOS/Linux 移植成本 < 1 天 |
---
✅ **下一步行动建议**:
1. **复制此目录结构** 到你的项目根目录
2. **将上文 `capture_yolo.py` 拆解**,按模块放入对应 `.py` 文件(`app.py` 保留主逻辑,其余拆入子模块)
3. **运行 `pip install -e .`** 验证包可导入:
```python
>>> from yolo_ui_capture import YOLOCapture
>>> app = YOLOCapture()
```
4. **执行 `python -m yolo_ui_capture`** 启动系统
需要我为你:
- 📄 生成完整的 `pyproject.toml` + `requirements.txt` + `.gitignore` 文件内容?
- 🧩 提供 `test_capture.py` 单元测试样例(mock mss + 验证 ROI 裁剪)?
- 📦 输出一个 ZIP 包,包含**完整初始化项目(含空 `src/` 目录 + 所有 `.py` 文件骨架 + 文档)**?
- 🎨 为 `examples/bind_to_game_window.py` 编写具体实现(如绑定《原神》窗口并自动 resize overlay)?
欢迎随时提出 👇