mirror of
https://github.com/yusufipk/YTChatHub.git
synced 2026-09-11 19:06:14 +00:00
22 lines
1.3 KiB
Markdown
22 lines
1.3 KiB
Markdown
# Project Brief
|
||
|
||
## Vision
|
||
Build a desktop-operated, open-source YouTube Live chat client that delivers a fast, reliable stream of messages and allows a streamer to spotlight a selected chat message on an OBS-ready overlay.
|
||
|
||
## Core Requirements
|
||
- Mirror chat from a single YouTube Live stream with low latency and high stability.
|
||
- Provide an operator dashboard to browse, search, and filter live chat messages.
|
||
- Enable one-click selection of a message and broadcast it to an overlay page consumable in OBS.
|
||
- Keep setup approachable: clone repo, configure environment variables/OAuth, and run locally.
|
||
- Prioritize performance and resilience over advanced user management or multi-stream support.
|
||
|
||
## Constraints
|
||
- Runs on the streamer’s personal computer; no external hosting assumed.
|
||
- No end-user authentication beyond stored YouTube OAuth credentials.
|
||
- Must tolerate YouTube API rate limits and intermittent network issues without crashing.
|
||
|
||
## Success Criteria
|
||
- **Responsive Dashboard**: The operator dashboard remains responsive during long streams (>4 hours) without memory leaks.
|
||
- **Instant Overlay Updates**: The OBS overlay updates in real-time when a message is selected.
|
||
- **Comprehensive Documentation**: The project includes a detailed README and a well-maintained Memory Bank to facilitate easy setup and contribution.
|