Skip to content

TheStaticMage/firebot-mage-onscreen-chat

Repository files navigation

Mage's Firebot On-Screen Chat Display

Introduction

This is a customizable on-screen chat display for your Twitch chat messages via Firebot.

Features:

  • Integrates via OBS browser source
  • Control which chat messages are sent to the display
  • Display badges
  • Display user profile images
  • Deleting messages in chat removes them from the display
  • Banning / timing-out a user clears their messages
  • Clearing chat clears the display
  • Supports gigantified emotes (Firebot 5.65+ only)
  • Supports multiple instances with separate message content
  • Supports Kick.com messages (with my Kick integration)

Customizable:

  • Turn profile image display on or off by role
  • Colors, bold, italic, etc., on usernames and messages by role
  • For advanced users, full access to CSS style sheet
  • For really advanced users, full access to underlying Javascript

Documentation

Support

The best way to get help is in this project's thread on Discord. Join The Static Discord and then visit the #firebot-mage-onscreen-chat channel there.

  • Please do not DM me on Discord.
  • Please do not ask for help in my chat when I am live streaming on any platform.

Bug reports and feature requests are welcome via GitHub Issues.

Contributing

Contributions are welcome via Pull Requests. I strongly suggest that you contact me before making significant changes, because I'd feel really bad if you spent a lot of time working on something that is not consistent with my vision for the project. Please refer to the Contribution Guidelines for specifics.

License

This plugin is released under the GNU General Public License version 3. That makes it free to use whether your stream is monetized or not.

If you use this on your stream, I would appreciate a shout-out. (Appreciated, but not required.)

FAQ

Does Twitch allow me to display chat on stream?

Important: The answer provided is my personal interpretation of Twitch's Terms of Service. It may not be complete, up to date, or accurate. You should always verify details directly with Twitch's official documentation and make your own informed decisions.

The Twitch Terms of Service: Simulcasting guidelines prohibit you from combining activity from other platforms or services on your Twitch stream during your Simulcast, such as merging chat. However, displaying just your Twitch chat on your stream is fine with Twitch. Firebot only supports Twitch at ths time, so only Twitch messages are being sent to this display. You should not run into a problem even if you are simulcasting to another platform. (Note: if you're using my Firebot Kick Integration too, you should not route messages from both Twitch and Kick chat events to your chat display.)

About

Chat overlay powered by Firebot

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors