36 lines
1.8 KiB
Markdown
36 lines
1.8 KiB
Markdown
# MultiChatOverlay
|
|
|
|
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 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](CONTRIBUTING.md) file for the complete setup guide and workflow rules.
|
|
* **Looking for a task?** See the [TASKS.md](TASKS.md) file for a list of current jobs, broken down by phase.
|
|
* **Want the full plan?** See the [DEVELOPMENT_PLAN.md](DEVELOPMENT_PLAN.md) for the complete project roadmap.
|
|
|
|
## ⁉️ Acknowledgements
|
|
|
|
For the project we are using Discord 💬 and Nextcloud ☁️ for communications.
|
|
* ☁️ [Nextcloud](https://cloud9.ramforth.net/)
|
|
* 💬 [Discord](https://discord.gg/Zaxp6ch9hs)
|
|
|
|
👨💻 - Coded on and for Linux - 2025 |