# ReLink-Eye

**Repository Path**: itjee/ReLink-Eye

## Basic Information

- **Project Name**: ReLink-Eye
- **Description**: 基于YOLO的高性能实时目标检测与追踪系统，专为游戏辅助、安防监控、穿戴设备等场景设计
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2026-04-27
- **Last Updated**: 2026-04-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# relink-eye - YOLO视觉分析工具集

基于YOLO的高性能实时目标检测与追踪系统，专为游戏辅助、安防监控、穿戴设备等场景设计。

![License](https://img.shields.io/badge/license-MIT-blue.svg)
![Python](https://img.shields.io/badge/python-3.8+-blue.svg)
![PyTorch](https://img.shields.io/badge/pytorch-2.0+-orange.svg)

## 🚀 功能特性

### 核心功能
- **实时目标检测**：支持YOLOv5/v7/v8/v9/YOLO11，GPU/CPU加速
- **多目标追踪**：SORT/DeepSORT/ByteTrack算法，卡尔曼滤波
- **多源输入**：摄像头、屏幕捕获、RTSP/RTMP流、视频文件
- **可视化界面**：PyQt桌面GUI，支持自定义主题

### 高级特性
- **游戏辅助模式**：FPS游戏风格UI，准星、扫描特效
- **屏幕捕获**：实时监控游戏画面，支持OBS虚拟摄像头
- **移动端API**：RESTful API + WebSocket实时流
- **自定义训练**：支持自定义数据集，格式转换工具

### 部署选项
- 💻 **桌面端**：完整GUI界面
- 📱 **移动端**：HTTP/WebSocket API供App调用
- ⌚ **穿戴设备**：轻量模式，低延迟
- 🌐 **云服务**：Docker部署

## 📦 安装

### 环境要求
- Python >= 3.8
- PyTorch >= 2.0
- CUDA >= 11.7 (推荐，用于GPU加速)

### 快速安装

```bash
# 克隆仓库
git clone https://github.com/yzdalhj/ReLink-Eye.git
cd relink-eye

# 创建虚拟环境
python -m venv venv
source venv/bin/activate  # Linux/Mac
# 或 venv\Scripts\activate  # Windows

# 安装依赖
pip install -r requirements.txt

# 安装项目
pip install -e .
```

### 可选依赖

```bash
# GPU加速 (TensorRT)
pip install tensorrt pycuda

# GUI界面
pip install PyQt6

# API服务器
pip install fastapi uvicorn

# 屏幕捕获
pip install mss
```

## 🎯 快速开始

### 1. 摄像头实时检测

```bash
# 基础检测
relink camera --model yolov8n.pt

# 游戏模式（FPS风格UI）
relink camera --model yolov8n.pt --gaming --conf 0.3

# 启用追踪
relink camera --model yolov8n.pt --tracking
```

### 2. 屏幕检测（游戏辅助）

```bash
# 检测屏幕内容（如游戏画面）
relink screen --model yolov8n.pt --gaming --scale 0.5

# 指定区域
relink screen --model yolov8n.pt --region 0 0 1920 1080
```

### 3. 启动图形界面

```bash
relink gui
```

### 4. 启动API服务器

```bash
# 启动HTTP/WebSocket服务器
relink server --model yolov8n.pt --port 8000

# 测试API
curl -X POST -F "file=@test.jpg" http://localhost:8000/detect/image
```

## 📖 使用示例

### Python API

```python
from relink import YOLODetector, CameraCapture

# 创建检测器
detector = YOLODetector(
    model_path="yolov8n.pt",
    confidence_threshold=0.5,
    device='auto'  # 自动选择GPU
)

# 打开摄像头
capture = CameraCapture(camera_id=0)
capture.open()

# 实时检测
while True:
    frame_data = capture.read()
    if frame_data:
        result = detector.detect(frame_data.data)
        print(f"检测到 {len(result.detections)} 个目标，FPS: {result.fps:.1f}")
```

### 屏幕捕获检测

```python
from relink import YOLODetector
from relink.streaming.capture import ScreenCapture

detector = YOLODetector("yolov8n.pt")
capture = ScreenCapture()  # 捕获全屏
capture.open()

while True:
    frame_data = capture.read()
    if frame_data:
        result = detector.detect(frame_data.data)
        # 处理结果...
```

### 目标追踪

```python
from relink import YOLODetector, ObjectTracker

detector = YOLODetector("yolov8n.pt")
tracker = ObjectTracker(max_age=30, min_hits=3)

# 每帧更新
detections = detector.detect(frame)
tracks = tracker.update(detections.detections)

for track in tracks:
    print(f"追踪ID: {track.track_id}, 位置: {track.bbox}")
```

## 📚 文档

### 在线文档

访问完整文档网站获取详细指南：

📖 **[relink-eye 文档](https://your-docs-url.com)**

### 本地启动文档

```bash
cd docs
npm install
npm run docs:dev
```

然后在浏览器打开 http://localhost:5173

### 文档内容

- **指南**
  - [快速开始](docs/guide/getting-started.md)
  - [安装说明](docs/guide/installation.md)
  - [检测器使用](docs/guide/detector.md)
  - [目标追踪](docs/guide/tracker.md)
  - [游戏辅助模式](docs/guide/gaming-assist.md)
  - [API服务器](docs/guide/api-server.md)

- **API参考**
  - [YOLODetector](docs/api/detector.md)
  - [ObjectTracker](docs/api/tracker.md)
  - [视频捕获](docs/api/capture.md)
  - [REST端点](docs/api/rest-endpoints.md)

- **示例**
  - [基础检测](examples/basic_detection.py)
  - [屏幕检测](examples/screen_detection.py)
  - [目标追踪](examples/tracking_example.py)
  - [API客户端](examples/api_client_example.py)

## 🎮 游戏辅助功能

### FPS模式特性
- 红色高亮框 + 角标
- 自定义准星和扫描特效
- 超低延迟优化（< 16ms）
- 支持自定义目标类别

```python
from relink.utils.visualization import Visualizer, Theme

# 使用游戏主题
visualizer = Visualizer(Theme.gaming())

# 绘制带特效的检测框
display = detector.draw_detections(frame, result)
display = visualizer.draw_hud(display, {'fps': 60, 'detection_count': 5})
display = visualizer.apply_scan_effect(display, scan_pos)
```

## 📱 移动端集成

### REST API

```python
import requests

# 上传图像检测
with open('image.jpg', 'rb') as f:
    response = requests.post(
        'http://server:8000/detect/image',
        files={'file': f}
    )
    result = response.json()
```

### WebSocket实时流

```javascript
// JavaScript客户端示例
const ws = new WebSocket('ws://server:8000/ws/detect');

ws.onopen = () => {
    // 发送视频帧 (Base64编码)
    ws.send(JSON.stringify({
        type: 'frame',
        data: base64ImageData
    }));
};

ws.onmessage = (event) => {
    const result = JSON.parse(event.data);
    console.log(`检测到 ${result.detection_count} 个目标`);
};
```

### Android App示例

见 `examples/android/` 目录

## 🏋️ 训练自定义模型

### 1. 准备数据

```bash
# 转换数据集格式
relink convert \
    --input-dir ./my_dataset_coco \
    --output-dir ./my_dataset_yolo \
    --input-format coco \
    --classes classes.txt \
    --split
```

### 2. 训练

```bash
relink train \
    --data ./my_dataset_yolo/data.yaml \
    --model-type yolov8 \
    --model-size n \
    --epochs 100 \
    --batch-size 16
```

### 3. 导出模型

```python
from relink.models.trainer import ModelTrainer, TrainingConfig

trainer = ModelTrainer(TrainingConfig())

# 导出ONNX
trainer.export_model('best.pt', format='onnx')

# 导出TensorRT（GPU加速）
trainer.export_model('best.pt', format='engine', half=True)
```

## ⚙️ 配置文件

编辑 `configs/default.yaml` 自定义设置：

```yaml
detector:
  confidence_threshold: 0.5
  nms_threshold: 0.45
  device: "auto"

tracker:
  enabled: true
  max_age: 30
  
gaming:
  fps_mode:
    enabled: true
    target_classes: ["person", "head"]
```

## 🏗️ 项目结构

```
relink/
├── core/               # 核心模块
│   ├── detector.py     # YOLO检测器
│   └── tracker.py      # 目标追踪
├── streaming/          # 视频流捕获
│   └── capture.py      # 多源捕获
├── gui/                # 图形界面
│   └── desktop.py      # PyQt界面
├── models/             # 模型训练
│   └── trainer.py      # 训练工具
├── mobile_api/         # 移动端API
│   └── server.py       # FastAPI服务
├── utils/              # 工具函数
│   ├── visualization.py
│   └── helpers.py
└── configs/            # 配置文件
```

## 🖥️ 系统要求

| 平台 | 最低配置 | 推荐配置 |
|-----|---------|---------|
| CPU | Intel i5 / AMD Ryzen 5 | Intel i7 / AMD Ryzen 7 |
| GPU | - | NVIDIA GTX 1060+ / RTX 3060+ |
| RAM | 8GB | 16GB+ |
| 存储 | 2GB | 10GB+ |

## 🤝 贡献

欢迎提交Issue和PR！

## 📄 许可证

MIT License

## 🙏 致谢

- [Ultralytics YOLO](https://github.com/ultralytics/ultralytics)
- [OpenCV](https://opencv.org/)
- [FastAPI](https://fastapi.tiangolo.com/)