docs: Add initial README.md
This commit is contained in:
30
README.md
Normal file
30
README.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Multi-Platform Chat Overlay
|
||||
|
||||
A self-hosted tool to aggregate chat from multiple streaming platforms (YouTube, Twitch) and display it in a customizable OBS overlay. This project also provides a suite of tools for both the streamer (host) and their moderators to manage the chat.
|
||||
|
||||
## Core Features
|
||||
|
||||
* **Combined Chat:** Aggregates chat from YouTube and Twitch into a single feed.
|
||||
* **OBS Overlay:** A customizable web-based overlay to display the chat in your stream.
|
||||
* **Host Control Panel:** A dockable OBS panel for the streamer to:
|
||||
* Highlight important messages to feature them on the overlay.
|
||||
* View a queue of messages tagged by moderators.
|
||||
* Dismiss queued messages after they have been addressed.
|
||||
* **Moderator Panel:** A separate, secure web page for moderators to:
|
||||
* View the combined chat feed.
|
||||
* "Tag" or "Queue" important messages for the host's attention.
|
||||
|
||||
## Technology Stack
|
||||
|
||||
* **Backend:** Python 3.9+ with FastAPI and WebSockets.
|
||||
* **Frontend:** HTML5, CSS3, and vanilla JavaScript.
|
||||
* **Chat Libraries:** `pytchat` for YouTube and `TwitchIO` for Twitch.
|
||||
|
||||
## Getting Started
|
||||
|
||||
_(Instructions will be added here once the initial version is complete)_
|
||||
|
||||
1. Clone the repository.
|
||||
2. Install Python dependencies.
|
||||
3. Run the backend server.
|
||||
4. Add the frontend components to OBS as Browser Sources/Docks.
|
||||
Reference in New Issue
Block a user