OBS Chat Overlay for StreamerBot
- HTML 79.8%
- JavaScript 20.2%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
Renovate Bot
a5c23f4c4b
Welcome to [Renovate](https://github.com/renovatebot/renovate)! This is an onboarding PR to help you understand and configure settings before regular Pull Requests begin. 🚦 To activate Renovate, merge this Pull Request. To disable Renovate, simply close this Pull Request unmerged. 📚 See our [Reading List](https://docs.renovatebot.com/reading-list/) for relevant documentation you may be interested in reading. 🔡 Do you want to change how Renovate upgrades your dependencies? Add your custom config to `renovate.json` in this branch. Renovate will update the Pull Request description the next time it runs. --- ### Detected Package Files * `.github/workflows/codeql.yml` (github-actions) * `renovate.json` (renovate-config) ### Configuration Summary Based on the default config's presets, Renovate will: - Start dependency updates only once this onboarding PR is merged - Enable Renovate Dependency Dashboard creation. - Use semantic commit type `fix` for dependencies and `chore` for all others if semantic commits are in use. - Ignore `node_modules`, `bower_components`, `vendor` and various test/tests (except for nuget) directories. - Group known monorepo packages together. - Use curated list of recommended non-monorepo package groupings. - Show only the Age and Confidence Merge Confidence badges for pull requests. - Apply crowd-sourced package replacement rules. - Apply crowd-sourced workarounds for known problems with packages. - Ensure that every dependency pinned by digest and sourced from Forgejo contains a link to the commit-to-commit diff - Ensure that every dependency pinned by digest and sourced from Gitea contains a link to the commit-to-commit diff - Ensure that every dependency pinned by digest and sourced from GitHub.com and Github enterprise contains a link to the commit-to-commit diff - Ensure that every dependency pinned by digest and sourced from GitLab.com contains a link to the commit-to-commit diff - Correctly link to the source code for golang.org/x packages - Link to pkg.go.dev/... for golang.org/x packages' title - Provide a link to octochangelog's improved breakdown for Renovate's changelogs - Pin Docker digests. - Pin `github-action` digests. - Enable Renovate configuration migration PRs when needed. - Pin dependency versions for development dependencies. - Recommended configuration for abandoned packages, treating packages without a release for 1 year as abandoned, while taking into account community-sourced overrides. - Wait until the npm package is three days old before raising the update. This a) introduces a short delay to allow for malware researchers and scanners to (possibly) detect any malicious behaviour in packages, and b) prevents the maintainer and/or NPM from unpublishing a package you already upgraded to, breaking builds. - Run lock file maintenance (updates) early Monday mornings. --- ### What to Expect With your current configuration, Renovate will create 4 Pull Requests: <details> <summary>Pin dependencies</summary> - Schedule: ["at any time"] - Branch name: `renovate/pin-dependencies` - Merge into: `main` - Upgrade [actions/checkout](https://github.com/actions/checkout) to `a37ce9120846195fa4ece8f58b268e6043cb2f26` - Upgrade [github/codeql-action](https://github.com/github/codeql-action) to `b8d3b6e8af63cde30bdc382c0bc28114f4346c88` - Upgrade [https://code.forgejo.org/forgejo/upload-artifact](https://code.forgejo.org/forgejo/upload-artifact) to `16871d9e8cfcf27ff31822cac382bbb5450f1e1e` </details> <details> <summary>Update actions/checkout action to v7</summary> - Schedule: ["at any time"] - Branch name: `renovate/actions-checkout-7.x` - Merge into: `main` - Upgrade [actions/checkout](https://github.com/actions/checkout) to `3d3c42e5aac5ba805825da76410c181273ba90b1` </details> <details> <summary>Update github/codeql-action action to v4</summary> - Schedule: ["at any time"] - Branch name: `renovate/github-codeql-action-4.x` - Merge into: `main` - Upgrade [github/codeql-action](https://github.com/github/codeql-action) to `ff2f1c621b7f889edc0d3c761ac2e6a3f8cdb0dd` </details> <details> <summary>Update https://code.forgejo.org/forgejo/upload-artifact action to v5</summary> - Schedule: ["at any time"] - Branch name: `renovate/https-code.forgejo.org-forgejo-upload-artifact-5.x` - Merge into: `main` - Upgrade [https://code.forgejo.org/forgejo/upload-artifact](https://code.forgejo.org/forgejo/upload-artifact) to `cb8afe72b42edc798abfb8fcb556cf660d894245` </details> --- ❓ Got questions? Check out Renovate's [Docs](https://docs.renovatebot.com/), particularly the Getting Started section. If you need any further assistance then you can also [request help here](https://github.com/renovatebot/renovate/discussions). --- This PR has been generated by [Mend Renovate CLI](https://github.com/renovatebot/renovate). <!--renovate-config-hash:68e2b3b6cd8b9b21e72df5710d33fc36b4fb308f16a754735cb6d438a8e151bc--> Co-authored-by: kittyfangs <kat@firekitten.net> Reviewed-on: #1 |
||
| .github | ||
| assets/readme | ||
| chat.html | ||
| CNAME | ||
| CODE_OF_CONDUCT.md | ||
| generator.html | ||
| generator.js | ||
| LICENSE | ||
| options.md | ||
| README.md | ||
| renovate.json | ||
| test.html | ||
stream-chat-rebooted
Active continuation
This repository is an active continuation of Izzy's original stream-chat project. Full credit for the original overlay and foundation goes to Izzy.
I am actively maintaining this continuation so the project can keep receiving updates, fixes, and support beyond the original repository's planned archive.
Chat Overlay for OBS based on streamer.bot's websocket, using pronouns from pronouns.alejo.io.
Supported platforms
stream-chat-rebooted supports chat messages from Streamer.bot for Twitch, YouTube, and Kick. Platform support includes chat messages, emotes, badges, and message removal after user bans or timeouts where Streamer.bot emits those moderation events.
Installation
Local
To use the Chat overlay locally just download the newest release from the releases page and unpack it somewhere OBS can reach it.
After unpacking you can open generator.html in a browser to open the configurator.
Online
You can also use the hosted generator at https://chat.narnacle.com/generator.html.
While this is the easier method, using the online method comes with some drawbacks. First and foremost that GitHub has a soft limit on bandwidth and availability. There is no guarantee that this will always work.
Also keep in mind that GitHub has its own data collection policies.
Configuration
Supported settings are in options.md. It's easier to use the generator page, but in case you want to build the URL by hand or programatically, these might be helpful
Troubleshooting
Generally the best way to troubleshoot is to open the browser console (F12) and check for any errors. Error messages in the console might differ depending on your browser. Given OBS is based on CEF(Chromium Embedded Framework) it's likely that Chrome's console is the most accurate.
Settings set in the generator aren't working in OBS
Possible reasons:
- You have not removed the
Local Filecheckbox in the OBS Source
Solution
- Uncheck
Local Fileand paste the generated URL again
Can't connect to WebSocket
Possible errors in the console:
- Firefox can’t establish a connection to the server at ws://127.0.0.1:8080/
- Websocket connection to 'ws://127.0.0.1:8080/' failed: [...]
Possible reasons:
- Streamer.Bot is not running
- Streamer.Bot is listening on a different port
- Streamer.Bot is listening on a port that is not exclusively available
Troubleshooting:
- Make sure Streamer.Bot is running
- If you're using a custom port, make sure it's the same as the one in the overlay's URL
- If you're using a custom port, make sure it's not in use by another application(try a different port)
- To make sure the port is exclusively available, close Streamer.Bot and run
Get-Process -Id (Get-NetTCPConnection -LocalPort 8080).OwningProcessin PowerShell. If the output is empty, the port is available, otherwise it's in use by another process and you should probably try a different port.
WebSocket connected but doesn't show messages
Possible errors in the console:
- No direct errors
- Log will say connected, but not say
SUBSCRIBE: ok
Possible reasons:
- Wrong kind of Streamer.Bot websocket server started
Troubleshooting:
- Make sure that in Streamer.Bot you started the internal Websocket server(under "Websocket Server"), not a custom one(under "Websocket Servers" - mind the plural)
Contributors / Thanks
Thanks to @andi242 for his fork on https://github.com/andi242/twitch-chat