crowbartools/Firebot v5.67.0-beta1

Release v5.67.0-beta1

on GitHub

v5.67.0-beta1 Update Notes

✨ New

• Control Decks! A new fun and easy way to trigger Firebot actions is here! With Control Decks, you can create your own push button interface to quickly run effects in Firebot. Each deck supports custom grid and control sizes, multiple pages, nested folders, and even pinned controls that can appear on every page of that particular deck. Plus, Control Decks are built with mobile in mind: As long as your phone is on the same local network as Firebot, you can quickly scan a QR code and control Firebot from your phone! (Just make sure your firewall allows Firebot to communicate with your local network - and as always, PLEASE do not allow incoming requests to Firebot from the public internet!)
• Plugins! The next generation of extending Firebot functionality is here! For quite some time now, Firebot has had the ability to add additional features and integrations using custom scripts, but we know that they can be difficult and tedious to create and manage. To solve this, we've built a brand new plugin system from the ground up, including a new Plugin Manager that you can quickly access from either the Tools menu or from Firebot settings. This new system not only makes it easier for you as a Firebot user to install, update, and manage your plugins, but it's also designed with developers in mind, making it much faster and easier to build and maintain new integrations. Several custom scripts have already been updated to the new plugin system, so check out our Discord for more info!
• Community Plugins! With the introduction of our new plugin system, we're also introducing Community Plugins - a way to quickly and easily find, install, and update plugins, all without leaving Firebot! When you want to find an available plugin, just open the Plugin Manager, click "Browse Plugins", and search. Best of all, Firebot will automatically let you know when updates are available for any of your Community Plugins, so you can update a plugin from the Plugin Manager with a single click, quickly giving you the latest features and fixes. Since Community Plugins are brand new, there won't be too many available to start with, but be sure to search often to discover new plugins that our community members have created and published!
• Pinned Messages! In this first wave of pinned message features, we've added some new effects and variables, along with the ability to pin a message immediately using the Chat effect and to right click & pin a message from the Dashboard! We plan to add events and additional Dashboard support once Twitch adds additional third-party support on their end.
• Added the following new overlay widgets:
  • Rotating Text
  • Twitch Poll
  • Twitch Prediction
• Added the following new effects:
  • Clear Chat Widget
  • Pin Chat Message
  • Set Active Control Deck
  • Set Default Control Deck
  • Unpin Chat Message
  • Update Pinned Chat Message
  • Update Rotating Text
• Added the following new event filters:
  • Gift Resub
• Added the following new variables:
  • $controlDeckInput
  • $isGiftResub
  • $obsPreviousSceneName
  • $pinnedByUserDisplayName
  • $pinnedByUserId
  • $pinnedByUsername
  • $pinnedChatMessage
  • $pinnedChatMessageId
  • $pinnedChatMessageTextOnly
  • $pinnedChatMessageUserDisplayName
  • $pinnedChatMessageUserId
  • $pinnedChatMessageUsername

🛠️ Improved

• We've made a number of performance improvements to Firebot. We'll be focusing heavily on more of these improvements, especially with larger/more active communities, in the coming months.
• Firebot will now attempt to automatically fix your global settings file if it somehow becomes corrupt
• Log messages have improved, now including the Firebot module or plugin where the log message originated and more detailed Twitch connection logging
• More variables are now available for use with Power-ups (e.g. $arg and $target)

✅ Fixed

• Fixed an issue where overlays may not reconnect properly if you close and reopen Firebot while streaming software remains open
• Fixed an issue where built-in integrations (like OBS) might trigger events before other Firebot systems are fully loaded (#3400)

⚙️ Under the Hood

• With the new plugin system, we have made several changes for developers:
  • Legacy startup and effect scripts are now deprecated. They will continue to work, but they will not receive feature updates or fixes going forward, and may break as underlying Firebot systems evolve. Please update your custom scripts to the new Plugin format ASAP.
  • The following internal systems may break legacy scripts as soon as 5.68.0 as we are planning major internal changes:
    • Viewer database
    • Currencies
    • Roles
  • Firebot types are no longer being published or updated via the @crowbartools/firebot-custom-scripts-types library or repository. Going forward, use the new @crowbartools/firebot-types package. This package is automatically generated from the main Firebot source and will match the corresponding Firebot version.
  • Plugins no longer need to manually register and unregister many items, like effects, events, filters, variables, and much more. Simply add the corresponding items to the registers property of your exported Plugin and the plugin system will automatically handle registrations for the lifecycle of your plugin. NOTE: Due to limitations with Angular 1.x (our frontend UI framework), users must reload the Firebot main window in order to fully update, disable, or uninstall plugins that register UI extensions.
  • Internal Firebot systems/modules are no longer directly exposed to plugins. Instead, the @crowbartools/firebot-types provides a default firebot export that abstracts out and interfaces with internal systems in the context of your plugin (e.g. firebot.logger or firebot.storage). In order to use any of these, simply import firebot from "@crowbartools/firebot-types" anywhere in your plugin and use it as needed. The plugin system automatically injects the functionality at Firebot runtime, so no more need to maintain and pass around your own copies of modules that were previously provided in the run() function.

Windows Install

• Download and run Firebot-v5.67.0-beta1-setup.exe

MacOS Install

• Download Firebot-v5.67.0-beta1-macos-arm64.dmg (Apple Silicon)
• Right click the .dmg and select "Open"
• In the dialog that appears click "Cancel"
• Right click the .dmg again and select "Open"
• In the dialog that appears click "Open"

Note: Mac OS does not receive auto-updates

Linux Install

• DEB or RPM based distributions:
  • Download Firebot-v5.67.0-beta1-linux-x64.deb or Firebot-v5.67.0-beta1-linux-x64.rpm
  • Install the file using your system package manager
  • Open Firebot v5 from your system program runner
• Other distributions:
  • Download Firebot-v5.67.0-beta1-linux-x64.tar.gz
  • Unpack Firebot-v5.67.0-beta1-linux-x64.tar.gz
  • Change into the directory where you unpacked the archive
  • Run the Firebot v5 executable.

Note: Linux does not receive auto-updates