Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 1.7 KB

File metadata and controls

39 lines (28 loc) · 1.7 KB

Usage and Troubleshooting Guides

This file is the central index for practical setup and diagnosis. Keep detailed instructions in separate files under docs/guides/ so this index stays short.

Start Here

Guide Use when
First launch checklist You are starting a fresh build or fresh unpacked release.
Backend selection and checks You need to choose DML vs CUDA, or diagnose basic backend behavior.
Common recipes You want ready-to-copy config snippets and benchmark commands.
Troubleshooting order You need a short checklist for unknown problems.

Capture and Performance

Guide Use when
UDP capture over LAN You want to receive MJPEG frames over UDP from another PC or process.
Capture diagnostics You are reading [CaptureDiag] output or checking CPU/GPU capture paths.
Circle FOV You are configuring the circular FOV limiter and overlay preview.
Data collection You are collecting training data or checking its performance impact.

Controls and UI

Guide Use when
Input methods You are setting up Win32, Razer, Teensy, or other control paths.
Overlay and GUI behavior You are tuning preview, game overlay, or latency compensation.

Development

Guide Use when
Build workflow You are rebuilding local code or dependencies.

Core references: