howto, tasks and readme update

This commit is contained in:
2025-11-16 17:04:19 +01:00
parent e31ccbbb19
commit 62ee9ad954
3 changed files with 171 additions and 2 deletions

View File

@@ -1,5 +1,28 @@
# MultiChatOverlay
A multi-user, web-based chat overlay service for streamers on platforms like Twitch and YouTube.
MultiChatOverlay is a web-based, multi-platform chat overlay service designed for streamers. The goal is to create a "SaaS" (Software as a Service) project where users can log in with their platform accounts (Twitch, YouTube, etc.) and get a single, unified, and customizable chat overlay for their stream.
This service aggregates chat from connected accounts into a customizable browser source for use in streaming software.
This project is currently in **Phase 1: Initial Development**.
## 🚀 Project Goal
* **Unified Chat:** Aggregate chat from multiple platforms (starting with Twitch & YouTube) into one browser source.
* **Customization:** Allow users to save their own custom CSS and use templates.
* **Interaction:** Provide "single message focus" and other moderation tools for streamers and their teams.
* **Self-Hosted:** The service is hosted by the project owner (you) and provided to users.
## 💻 Technology Stack
* **Backend:** Python 3.9+ (FastAPI)
* **Database:** SQLite (initially, for simplicity) with SQLAlchemy
* **Chat Listeners:** `twitchio` (Twitch), `pytchat` (YouTube)
* **Frontend:** Vanilla HTML5, CSS3, and JavaScript (Fetch API, WebSockets)
* **Authentication:** OAuth2 for all external platforms.
## 📖 Development & Contribution
This project follows a professional development workflow. Gitea is our single source of truth.
* **Want to contribute?** See our `CONTRIBUTING.md` file for the complete setup guide and workflow rules.
* **Looking for a task?** See the `TASKS.md` file for a list of current jobs, broken down by phase.
* **Want the full plan?** See the `DEVELOPMENT_PLAN.md` for the complete project roadmap.