Skip to content

TheStaticMage/firebot-mage-credits-generator

Repository files navigation

Firebot "Mage Credits Generator" Script

Introduction

This is a script that helps with an "end credits" display for Firebot (the all-in-one bot for Twitch streamers).

example.mp4

Features:

  • Your choice of display style:

    • Scrolling (as pictured in the video)
    • Slideshow
  • Tracks numerous events including:

    • New followers
    • Subs and re-subs
    • Gifted subs
    • Bits and cheering
  • Handles credits that date back to before the current stream:

    • Existing followers
    • Existing subscribers
    • Existing gifters
  • Customizable:

    • Basic usage should work with minimal changes
    • Most display settings are changeable via CSS file
    • Uses a JSON data structure for maximum customization possibility
    • Custom events can be tracked
  • Compatibility beyond Firebot:

Feel free to stop by my Twitch stream (https://www.twitch.tv/thestaticmage) where you will see me roll the credits at the end of every stream.

Compatibility

Plugin Version Minimum Firebot Version
1.0.0+ 5.65
0.2.5 and earlier 5.64 and earlier

If you have Firebot 5.64 or earlier, you should use version 0.2.5. For Firebot 5.65 and higher, use version 1.0.0 or later.

Documentation

Support

The best way to get help is in my Discord server. Join the The Static Discord and then visit the #firebot-mage-credits-generator channel there.

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

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 project 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.)

Alternatives

This project was inspired by CaveMobster's firebot-setup-end-credits script, which implements an end-credits screen entirely with a Firebot setup (and no custom scripting). See also @arblane's credits-firebot-setup which achieves the same without a browser source.

About

Generate credits for an end-scene with Firebot

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •