ramforth/MultiChatOverlay
3
2
Fork 0
Code Issues 7 Pull Requests Actions Packages Projects Releases Wiki Activity

Add USAGE.md for user guide

Browse Source
This commit is contained in:
Jo Eskil
2025-11-13 17:04:53 +01:00
parent 930910985c
commit bf912deb1b
1 changed files with 41 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
USAGE.md Normal file
View File

@@ -0,0 +1,41 @@
# MultiChat Overlay Usage Guide
This guide explains how to log in to the MultiChat Overlay service and connect your streaming accounts to generate a personalized chat overlay.
## 1. Logging In
To use the MultiChat Overlay, you first need to log in with your streaming platform account.
1. **Access the Login Page:** Open your web browser and navigate to the service's login page (e.g., `http://localhost:8000/login`).
2. **Choose Your Platform:** On the login page, you will see options to log in with different streaming platforms.
3. **Authorize MultiChat Overlay:**
* Click on the "Login with Twitch" button.
* You will be redirected to Twitch's authorization page. Review the permissions requested by MultiChat Overlay and click "Authorize" to grant access.
* After successful authorization, you will be redirected back to the MultiChat Overlay dashboard.
## 2. Connecting Services
Currently, only Twitch is supported for connection. YouTube integration will be added in a future update.
### Connecting Twitch
Once you have logged in with your Twitch account, your Twitch channel will automatically be connected. You can verify this on your dashboard.
## 3. Your Personalized Overlay
After logging in and connecting your services, you will find your unique overlay URL on the dashboard.
1. **Copy Overlay URL:** On the dashboard, locate and copy the provided "Overlay URL". This URL is unique to your account.
2. **Add to OBS (or other streaming software):**
* In OBS Studio, add a new "Browser Source".
* Paste your copied Overlay URL into the "URL" field of the Browser Source properties.
* Adjust the width and height of the browser source to match your desired overlay size.
* Click "OK".
Your chat overlay should now appear in your streaming software, displaying messages from your connected Twitch channel.
## 4. Future Integrations (Coming Soon)
* **YouTube Integration:** Connect your YouTube channel to aggregate chat from both platforms.
* **Customization Options:** Personalize the look and feel of your chat overlay directly from the dashboard.
* **Moderator & Host Panels:** Access dedicated panels for advanced moderation and stream management.