Release v5.64.0

v5.64.0 Update Notes

✨ New

• Firebot has been fully migrated to EventSub! This is a major change as Twitch has deprecated PubSub in favor of EventSub. This will ensure continued functionality for Twitch events and notifications.
• Most effects will now have automatic dynamic labels by default. You can still override these default labels with your own or turn this feature off entirely in Settings. (#2127)
• Custom Scripts can now create UI Extensions, allowing them to add entirely new pages to the Firebot UI.
• Added Golden Kappa Hype Train Indicator
• Currency command updates:
  • Added a subcommand to look up another users currency (#3018)
  • Added a "set" subcommand to set another users currency
• Enhancements to simulating events
  • Event properties are now prefilled with default values
  • It is now possible to reload previously used property values
• Support for Shared Chat throughout the app
• Added an option to prevent your commands from being used in shared chats on a global and per command basis
• Added an Event Filter and $isSharedChatMessage variable
• Added ability to open streamers firebot profile page from the commands tab
• Added "Outgoing Raid" Event (#2767)
• Added an "Open Overlay in Browser" option to the Tools menu
• Added $vip array variable
• Added support for custom fonts for the Dashboard chat (#2955)
• The voices list in the TTS Effect is now searchable (#3000)
• Added $arrayFuzzySearch variable (#3002)
• Added $overlayResourcesPath variable to get the system path of the overlay-resources directory (#3007)
• Added a user allow list to the URL moderation tool (#2983)
• Added "Wait for speech to finish" option to the Text-To-Speech effect
• Added option to show correct trivia question on an incorrect answer
• Added a role filter to currency update event (#2873)
• Added "send as reply" as an option for restrictions
• Added $fileName variable that extracts a file name from a file path with a file extension (#2803)
• Added Effect Queue Status as event that trigger when the status of a queue changes.
• Added Effect Queue Added as a event that triggers when a new item are added to a effect queue.
• Added a filter for Effect Queue Status , Effect Queue Added and existing Effect Queue Cleared.
• Added new $effectQueueStatus variable that returns the true or false or null based of the status of the effect queue.
• Added $arraySlice replace variable (#2776)
• Added $pollChoices and $pollTitle variables
• New installers for Debian and Fedora (or similar) Linux distributions
• Added Apple Silicon (arm64) support for macOS, allowing Firebot to run natively on Apple Silicon Macs
• Added custom WebSocket listeners and events to plugins
• Added built in variable api (#2899)
• Added clear custom role api (#2483)
• Added Quotes events to websocket server
• Added Viewer Metadata Events to the Websocket Server
• Added Viewer Metadata POST, PUT, and DELETE APIs

🛠️ Improved

• Added array parameters to $min and $max (#2987)
• $randomActiveViewer can now filter roles into or out (#2805)
• Added a way to see and clear unknown sources in obs toggle effects (#2980)
• Improved styling of some notification toasts (#2997)
• Added an option for decimal padding to the $commafy variable
• New custom fonts are now dynamically added to the overlay
• Allow stream categories to be set to empty
• Made error logs more verbose for the http request effect (#2935)
• Added support for .oga file extension to the Play Sound effect
• Add Quote effect now includes the new quote id as an effect output (#2822)
• The dashboard chat will now remember Active Chat User, Message Text, and Replying-To even if you switch tabs (#2772)
• Option to default quotes to streamer name if no @ is provided (#2336)
• Added a property selector parameter to the $customRoleUsers
• Added Custom WebSocket Event effect
• Improved the verbiage on how to setup Streamdeck Website actions for the latest version of the app
• Toned down the brightness of the chat alert bg color (#2880)
• Improved accessibility of some dropdown selects
• Scheduled effect lists can now be added to Setups

✅ Fixed

• Fixed twitch clips not playing as expected in the overlay (#2778)
• Fixed 'Wait for sound to finish' not working (#2879)
• Fixed Twitch Global Emote Text Overlap (#3069)
• Fixed errors in effects breaking Effect (#3066)
• Fixed role bonuses pay out (#3030)
• Fixed cannot assign sort tags to some channel rewards (#3031)
• Fixed Currency Variable Not Pulling user (#3021)
• Fixed File Writer Newline Escapes (#3025)
• Simulated events are no longer cached (#2672)
• Fixed Toggle Event effect not working as expected on initial creation (#3008)
• Fixed ranks not sending chat messages (#2994)
• Fixed $rankLadder variable not being available (#2996)
• Fixed Empty Conditional Effects Showing Empty Conditions (#2986)
• Fixed HTTP Request effect JSON header
• Fixed edit user metadata editor type
• Improved channel rewards error handling when logged out
• Fixed Anonymous Cheering Total Bits Amount
• Resolved a race condition with overlay connect
• Fixed linux overlay not working when pwd not firebot dir
• Fixed sub kind filter
• Fixed filter values showing Not Set
• Fixed follower channelGoalCurrentAmount (#2919)
• Fixed obs change scene var menu and rotation var menu (#2918)
• Fixed $donationAmount and $formatedDonationAmount not being available for all donation services (#2917)
• Resolves some Duplicate Preset Effect List issues (#2920)
• We no longer send failed dashboard slash commands to twitch chat
• Resolved a bug with global command cooldowns allowing more than one command to be ran at once (#2909)
• Fixed carriage return not being ignored in replace line of write file. (#2892)
• Fixed a bug with chat moderation when a viewer had no saved view time (#2883)
• Fixed Elgato light strip colors
• Fixed poll choice and poll choices showing twice on the UI for simulate event
• Fixed case sensitivity in !permit moderation command (#2863)
• Fixed system command overrides not presenting new options from definition (#2831)
• Fixed menu position for activity feed effect (#2833)
• Fixed clip live check (#2845)
• Fixed ffz and 7tv wide emotes overlap
• Fixed Currencies Pay Out While Offline Even if Offline Payout is Disabled (#2801)
• Fixed twitch chat roles not getting added and updated properly in the viewer database
• Fixed random location setting for the show text effect
• Corrected $hasRole and $hasRoles Usage Examples (#2790)
• Fixed an error when saving quick action (#2779)
• When a command fails due to incorrect category/game, it now display's the correct one
• Fixed Condition of 0 showing as [Not Set] (#3086)

⚙️ Under the Hood

• The backup system has been refactored and should now be much more reliable
• The audio system has been refactored to help protect against memory leaks
• Refactored various modules to Typescript

Windows Install

• Download and run Firebot-v5.64.0-setup.exe

MacOS Install

• Apple Silicon
  • Download Firebot-v5.64.0-macos-arm64.dmg
  • Open the .dmg and drag Firebot into your Applications
  • Run the following command in Terminal:

  xattr -c /Applications/Firebot.app
  

• Intel Macs
  • Download Firebot-v5.64.0-macos-x64.dmg
  • 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.64.0-linux-x64.deb or Firebot-v5.64.0-linux-x64.rpm
  • Install the file using your system package manager
  • Open Firebot v5 from your system program runner
• Other distributions:
  • Download Firebot-v5.64.0-linux-x64.tar.gz
  • Unpack Firebot-v5.64.0-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

Release v5.64.0-beta1

v5.64.0-beta1 Update Notes

✨ New

• Firebot has been fully migrated to EventSub! This is a major change as Twitch has deprecated PubSub in favor of EventSub. This will ensure continued functionality for Twitch events and notifications.
• Most effects will now have automatic dynamic labels by default. You can still override these default labels with your own or turn this feature off entirely in Settings. (#2127)
• Custom Scripts can now create UI Extensions, allowing them to add entirely new pages to the Firebot UI.
• Added Golden Kappa Hype Train Indicator
• Currency command updates:
  • Added a subcommand to look up another users currency (#3018)
  • Added a "set" subcommand to set another users currency
• Enhancements to simulating events
  • Event properties are now prefilled with default values
  • It is now possible to reload previously used property values
• Added ability to open streamers firebot profile page from the commands tab
• Added $vip array variable
• Added support for custom fonts for the Dashboard chat (#2955)
• The voices list in the TTS Effect is now searchable (#3000)
• Added $arrayFuzzySearch variable (#3002)
• Added $overlayResourcesPath variable to get the system path of the overlay-resources directory (#3007)
• Added a user allow list to the URL moderation tool (#2983)
• Added "Wait for speech to finish" option to the Text-To-Speech effect
• Added option to show correct trivia question on an incorrect answer
• Scheduled effect lists can now be added to Setups
• Added a role filter to currency update event (#2873)
• Added "send as reply" as an option for restrictions
• Support for Shared Chat throughout the app
  • Added an option to prevent your commands from being used in shared chats on a global and per command basis
  • Added an Event Filter and $isSharedChatMessage variable
• Added $fileName variable that extracts a file name from a file path with a file extension (#2803)
• Added "Outgoing Raid" Event (#2767)
• Added Effect Queue Status as event that trigger when the status of a queue changes.
• Added Effect Queue Added as a event that triggers when a new item are added to a effect queue.
• Added a filter for Effect Queue Status , Effect Queue Added and existing Effect Queue Cleared.
• Added new $effectQueueStatus variable that returns the true or false or null based of the status of the effect queue.
• Added $arraySlice replace variable (#2776)
• Added $pollChoices and $pollTitle variables
• New installers for Debian and Fedora (or similar) Linux distributions
• Added Apple Silicon (arm64) support for macOS, allowing Firebot to run natively on Apple Silicon Macs
• Added custom WebSocket listeners and events to plugins
• Added built in variable api (#2899)
• Added clear custom role api (#2483)
• Added Quotes events to websocket server
• Added Viewer Metadata Events to the Websocket Server
• Added Viewer Metadata POST, PUT, and DELETE APIs

🛠️ Improved

• Added array parameters to $min and $max (#2987)
• $randomActiveViewer can now filter roles into or out (#2805)
• Added a way to see and clear unknown sources in obs toggle effects (#2980)
• Improved styling of some notification toasts (#2997)
• Added an option for decimal padding to the $commafy variable
• New custom fonts are now dynamically added to the overlay
• Allow stream categories to be set to empty
• Made error logs more verbose for the http request effect (#2935)
• Added support for .oga file extension to the Play Sound effect
• Add Quote effect now includes the new quote id as an effect output (#2822)
• The dashboard chat will now remember Active Chat User, Message Text, and Replying-To even if you switch tabs (#2772)
• Option to default quotes to streamer name if no @ is provided (#2336)
• Added a property selector parameter to the $customRoleUsers
• Added Custom WebSocket Event effect
• Improved the verbiage on how to setup Streamdeck Website actions for the latest version of the app
• Toned down the brightness of the chat alert bg color (#2880)
• Improved accessibility of some dropdown selects

✅ Fixed

• Fixed 'Wait for sound to finish' not working (#2879)
• Fixed Twitch Global Emote Text Overlap (#3069)
• Fixed errors in effects breaking Effect (#3066)
• Fixed role bonuses pay out (#3030)
• Fixed cannot assign sort tags to some channel rewards (#3031)
• Fixed Currency Variable Not Pulling user (#3021)
• Fixed File Writer Newline Escapes (#3025)
• Simulated events are no longer cached (#2672)
• Fixed Toggle Event effect not working as expected on initial creation (#3008)
• Fixed ranks not sending chat messages (#2994)
• Fixed $rankLadder variable not being available (#2996)
• Fixed Empty Conditional Effects Showing Empty Conditions (#2986)
• Fixed HTTP Request effect JSON header
• Fixed edit user metadata editor type
• Improved channel rewards error handling when logged out
• Fixed Anonymous Cheering Total Bits Amount
• Resolved a race condition with overlay connect
• Fixed linux overlay not working when pwd not firebot dir
• Fixed sub kind filter
• Fixed filter values showing Not Set
• Fixed follower channelGoalCurrentAmount (#2919)
• Fixed obs change scene var menu and rotation var menu (#2918)
• Fixed $donationAmount and $formatedDonationAmount not being available for all donation services (#2917)
• Resolves some Duplicate Preset Effect List issues (#2920)
• We no longer send failed dashboard slash commands to twitch chat
• Resolved a bug with global command cooldowns allowing more than one command to be ran at once (#2909)
• Fixed carriage return not being ignored in replace line of write file. (#2892)
• Fixed a bug with chat moderation when a viewer had no saved view time (#2883)
• Fixed Elgato light strip colors
• Fixed poll choice and poll choices showing twice on the UI for simulate event
• Fixed case sensitivity in !permit moderation command (#2863)
• Fixed system command overrides not presenting new options from definition (#2831)
• Fixed menu position for activity feed effect (#2833)
• Fixed clip live check (#2845)
• Fixed ffz and 7tv wide emotes overlap
• Fixed Currencies Pay Out While Offline Even if Offline Payout is Disabled (#2801)
• Fixed twitch chat roles not getting added and updated properly in the viewer database
• Fixed random location setting for the show text effect
• Corrected $hasRole and $hasRoles Usage Examples (#2790)
• Fixed an error when saving quick action (#2779)
• Fixed twitch clips not playing as expected in the overlay (#2778)
• When a command fails due to incorrect category/game, it now display's the correct one

⚙️ Under the Hood

• The backup system has been refactored and should now be much more reliable
• The audio system has been refactored to help protect against memory leaks
• Refactored various modules to Typescript

Windows Install

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

MacOS Install

• Apple Silicon
  • Download Firebot-v5.64.0-beta1-macos-arm64.dmg
  • Open the .dmg and drag Firebot into your Applications
  • Run the following command in Terminal:

  xattr -c /Applications/Firebot.app
  

• Intel Macs
  • Download Firebot-v5.64.0-beta1-macos-x64.dmg
  • 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.64.0-beta1-linux-x64.deb or Firebot-v5.64.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.64.0-beta1-linux-x64.tar.gz
  • Unpack Firebot-v5.64.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

Release v5.63.2

v5.63.2 Hotfix Notes

• Fixed viewer details modal never loading
• Fixed OBS Transition Started event showing incorrect scene name
• Fixed OBS Program Scene Changed double event
• Fixed HTML text area in HTML effect overflowing modal to the right

v5.63.0 Update Notes

✨New

• Ranks System (#1898)
  • Automated ladders to move viewers through ranks based on view time or currency
  • Manual ladders that you control fully with the new Update Viewer Rank effect
• $variable Macro System
  • Reuse complicated variables easily.
• Run Random Effect now supports weighted chances (#1971).
• Added ability to convert any effect list into to Preset Effect Lists (#2624)
• Added Activity Feed Alert effect (#2667)
• New Variables:
  • $userProfileImageUrl as alias for $userAvatarUrl
  • $userBio to retrieve user's Twitch bio/about (#2612)
  • $obsIsConnected for OBS connection state (#2608)
  • $chatMessageTextOnly returns chat message without URIs or emotes (#2598)
  • $effectQueueLength for effect queue length (#2533)
  • $randomUUID for random IDs
  • $chatMessageId to grab the chat message ID
  • $unixTimestamp variable to return number of seconds since unix epoch (#2644)
• New Events: Chat Message Deleted, Twitch Chat Cleared
• OBS Integration:
  • Added Transform OBS Source effect (#2664)
  • Support for OBS Groups
  • New events: OBS Connected and OBS Disconnected (#2618)
  • Support for OBS chapter markers (#2616)
  • Added support for OBS GDI+ v3 Text Sources (#2638)
• Channel Rewards: Events for when a Channel Reward is accepted or rejected (#2572)
• User Interaction: Mark user active on channel point redemption (#2542)
• Dashboard Feedback: Added feedback for slash command use (#2527)
• Twitch Viewer Card: Link added to viewer info popup.
• Graphics: Firebot Graphics provided by nxbs (#2585)
• Ability to abort running effects and effect lists, either manually or via automatic timeout
• TTS support on Linux (#2705)
• Add Control Hue Light effect

🛠️ Improved

• Single-line text inputs can now be expanded
• Edit Effect modal header is now sticky, allowing constant access to the Test Effects button
• Subcommands can now inherit the base command cooldowns
• Added add/edit tags button to sort tag popover (#2690)
• Added searching to Create New Setup components (#2599)
• OBS Color Picker, Raw/Variable Color Entry (#2708)
• Timeout option for HTTP Request effect
• $effectOutput now supports propertyPath and defaultData arguments (#2709)
• Added case-insensitive 'contains' to conditional effect
• New selectable image types: .bmp, .apng, .webm
• Input box changed to a multiline textarea for preset list args (#2399, #2626)
• UI improvements: padding, whitespace, and scrolling (#2602, #2597, #2490)
• Skip null/empty username values on custom role import (#2489)
• Aria support for preset effect lists and add/edit event modal (#2642, #2640)
• Edge-case handling of $chatMessageTextOnly (#2649)
• Improved index-referencing for $arrayElement and $arrayRemove (#2651)
• Reduced logging spam (#2653)
• Added max age and featured only Twitch clip options to the Play Video effect
• Improved rounded corners of inputs that have a title
• Improved copy and corrected typos throughout the app
• Philips Hue integration now has improved bridge discovery
• Clickable link added to feature stream setting
• Aria labels added to settings where missing (#2623)
• Improved Effect Modal Test Effect Aria accessibility (#2604)

✅ Fixed

• $randomActiveViewer variable filtering (#2627)
• Fuzzy matching for array-related searching (#2605)
• $readFile example description fixed (#2603)
• Windows resize with display scaling (#2578)
• /me not triggering from commands.
• Show Image effect not respecting specified duration.
• Run Command Effect arg returning undefined.
• Perform ad check on startup.
• Time input not saving seconds (#2494)
• $ensureNumber ignoring string empty
• Reward filters not having display description
• Can't use effect output variables in Preset Effect List arguments (#2444)
• Searching commands with "!" in Create Setup modal returns incorrect results (#2643)
• Streamer account logged out after putting host PC to sleep or when a network issue is encountered (#2646)
• Viewer Rank event filter not functioning correctly (#2654)
• Viewer Rank commands sending incorrect chat messages after rank up
• Channel rewards creating invalid default color codes (#2682)
• Export setup file extension on linux (#2677, #2678)
• Cooldown search negation (#2676)
• Corrected data output types for OBS variables
• Sort tag menu overflowing under modal footer
• Clip effect failing because it thinks streamer is offline
• Added timeout to known bots list api call
• Pasting a previously copied effect multiple times gives each copy the same id
• $userRoles not available for some triggers
• Twitch Connected event fires before bot account is connected to chat
• Dashboard sometimes has empty space at bottom
• User metadata not saving when username in database mismatches twitch username

⚙️ Under the Hood

• Updated to Electron 31 and Node 20
• Improvements for custom scripts:
  • Script js files can now be nested within folders within the /scripts dir
  • Script description, param titles, and param descriptions now support markdown
  • Support for more param types
  • ReplaceVariableFactory, EventFilterFactory, and NotificationManager modules now passed to scripts
  • Added showToast IPC event for showing a toast message that scripts can trigger
• Switched to prebuilt firebot-nutjs (#2615)
• Added support for variable aliasing (#2613)
• Fixed api/v1/viewers to return proper username and displayName (#2607)
• Added guard against effectOutputs being null
• Fixed log requestor IP for API calls (#2534)
• Resolve create preset list promise on cancel, pass back fully saved preset list object
• Expanded support for OAuth host configurations
• Expanded replace-variable-manager definition
• Added /api/v1/viewers/export end point to retrieve entire viewer db in json format
• Added event API over websockets (#2641)
• Fix: Corrected JsonDbManager event typo
• Fix: Manual metadata being null instead of empty object (#2648)

Windows Install

• Download and run Firebot-v5.63.0-setup.exe

MacOS Install

• Download Firebot-v5.63.0-macos-x64.dmg
• 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

• Download Firebot-v5.63.0-linux-x64.tar.gz
• Unpack Firebot-v5.63.0-linux-x64.tar.gz
• Change into the directory where you unpacked the archive
• Run the Firebot v5 executable.
  • This must either be done via a terminal window, or you will need to create a shortcut that includes the correct path for the unpacked archived as the "working directory".

Note: Linux does not receive auto-updates

Release v5.63.1

v5.63.1 Hotfix Notes

• Fixed $overlayInstance always showing as Default

v5.63.0 Update Notes

✨New

• Ranks System (#1898)
  • Automated ladders to move viewers through ranks based on view time or currency
  • Manual ladders that you control fully with the new Update Viewer Rank effect
• $variable Macro System
  • Reuse complicated variables easily.
• Run Random Effect now supports weighted chances (#1971).
• Added ability to convert any effect list into to Preset Effect Lists (#2624)
• Added Activity Feed Alert effect (#2667)
• New Variables:
  • $userProfileImageUrl as alias for $userAvatarUrl
  • $userBio to retrieve user's Twitch bio/about (#2612)
  • $obsIsConnected for OBS connection state (#2608)
  • $chatMessageTextOnly returns chat message without URIs or emotes (#2598)
  • $effectQueueLength for effect queue length (#2533)
  • $randomUUID for random IDs
  • $chatMessageId to grab the chat message ID
  • $unixTimestamp variable to return number of seconds since unix epoch (#2644)
• New Events: Chat Message Deleted, Twitch Chat Cleared
• OBS Integration:
  • Added Transform OBS Source effect (#2664)
  • Support for OBS Groups
  • New events: OBS Connected and OBS Disconnected (#2618)
  • Support for OBS chapter markers (#2616)
  • Added support for OBS GDI+ v3 Text Sources (#2638)
• Channel Rewards: Events for when a Channel Reward is accepted or rejected (#2572)
• User Interaction: Mark user active on channel point redemption (#2542)
• Dashboard Feedback: Added feedback for slash command use (#2527)
• Twitch Viewer Card: Link added to viewer info popup.
• Graphics: Firebot Graphics provided by nxbs (#2585)
• Ability to abort running effects and effect lists, either manually or via automatic timeout
• TTS support on Linux (#2705)
• Add Control Hue Light effect

🛠️ Improved

• Single-line text inputs can now be expanded
• Edit Effect modal header is now sticky, allowing constant access to the Test Effects button
• Subcommands can now inherit the base command cooldowns
• Added add/edit tags button to sort tag popover (#2690)
• Added searching to Create New Setup components (#2599)
• OBS Color Picker, Raw/Variable Color Entry (#2708)
• Timeout option for HTTP Request effect
• $effectOutput now supports propertyPath and defaultData arguments (#2709)
• Added case-insensitive 'contains' to conditional effect
• New selectable image types: .bmp, .apng, .webm
• Input box changed to a multiline textarea for preset list args (#2399, #2626)
• UI improvements: padding, whitespace, and scrolling (#2602, #2597, #2490)
• Skip null/empty username values on custom role import (#2489)
• Aria support for preset effect lists and add/edit event modal (#2642, #2640)
• Edge-case handling of $chatMessageTextOnly (#2649)
• Improved index-referencing for $arrayElement and $arrayRemove (#2651)
• Reduced logging spam (#2653)
• Added max age and featured only Twitch clip options to the Play Video effect
• Improved rounded corners of inputs that have a title
• Improved copy and corrected typos throughout the app
• Philips Hue integration now has improved bridge discovery
• Clickable link added to feature stream setting
• Aria labels added to settings where missing (#2623)
• Improved Effect Modal Test Effect Aria accessibility (#2604)

✅ Fixed

• $randomActiveViewer variable filtering (#2627)
• Fuzzy matching for array-related searching (#2605)
• $readFile example description fixed (#2603)
• Windows resize with display scaling (#2578)
• /me not triggering from commands.
• Show Image effect not respecting specified duration.
• Run Command Effect arg returning undefined.
• Perform ad check on startup.
• Time input not saving seconds (#2494)
• $ensureNumber ignoring string empty
• Reward filters not having display description
• Can't use effect output variables in Preset Effect List arguments (#2444)
• Searching commands with "!" in Create Setup modal returns incorrect results (#2643)
• Streamer account logged out after putting host PC to sleep or when a network issue is encountered (#2646)
• Viewer Rank event filter not functioning correctly (#2654)
• Viewer Rank commands sending incorrect chat messages after rank up
• Channel rewards creating invalid default color codes (#2682)
• Export setup file extension on linux (#2677, #2678)
• Cooldown search negation (#2676)
• Corrected data output types for OBS variables
• Sort tag menu overflowing under modal footer
• Clip effect failing because it thinks streamer is offline
• Added timeout to known bots list api call
• Pasting a previously copied effect multiple times gives each copy the same id
• $userRoles not available for some triggers
• Twitch Connected event fires before bot account is connected to chat
• Dashboard sometimes has empty space at bottom
• User metadata not saving when username in database mismatches twitch username

⚙️ Under the Hood

• Updated to Electron 31 and Node 20
• Improvements for custom scripts:
  • Script js files can now be nested within folders within the /scripts dir
  • Script description, param titles, and param descriptions now support markdown
  • Support for more param types
  • ReplaceVariableFactory, EventFilterFactory, and NotificationManager modules now passed to scripts
  • Added showToast IPC event for showing a toast message that scripts can trigger
• Switched to prebuilt firebot-nutjs (#2615)
• Added support for variable aliasing (#2613)
• Fixed api/v1/viewers to return proper username and displayName (#2607)
• Added guard against effectOutputs being null
• Fixed log requestor IP for API calls (#2534)
• Resolve create preset list promise on cancel, pass back fully saved preset list object
• Expanded support for OAuth host configurations
• Expanded replace-variable-manager definition
• Added /api/v1/viewers/export end point to retrieve entire viewer db in json format
• Added event API over websockets (#2641)
• Fix: Corrected JsonDbManager event typo
• Fix: Manual metadata being null instead of empty object (#2648)

Windows Install

• Download and run Firebot-v5.63.0-setup.exe

MacOS Install

• Download Firebot-v5.63.0-macos-x64.dmg
• 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

• Download Firebot-v5.63.0-linux-x64.tar.gz
• Unpack Firebot-v5.63.0-linux-x64.tar.gz
• Change into the directory where you unpacked the archive
• Run the Firebot v5 executable.
  • This must either be done via a terminal window, or you will need to create a shortcut that includes the correct path for the unpacked archived as the "working directory".

Note: Linux does not receive auto-updates

Release v5.63.0

v5.63.0 Update Notes

✨New

• Ranks System (#1898)
  • Automated ladders to move viewers through ranks based on view time or currency
  • Manual ladders that you control fully with the new Update Viewer Rank effect
• $variable Macro System
  • Reuse complicated variables easily.
• Run Random Effect now supports weighted chances (#1971).
• Added ability to convert any effect list into to Preset Effect Lists (#2624)
• Added Activity Feed Alert effect (#2667)
• New Variables:
  • $userProfileImageUrl as alias for $userAvatarUrl
  • $userBio to retrieve user's Twitch bio/about (#2612)
  • $obsIsConnected for OBS connection state (#2608)
  • $chatMessageTextOnly returns chat message without URIs or emotes (#2598)
  • $effectQueueLength for effect queue length (#2533)
  • $randomUUID for random IDs
  • $chatMessageId to grab the chat message ID
  • $unixTimestamp variable to return number of seconds since unix epoch (#2644)
• New Events: Chat Message Deleted, Twitch Chat Cleared
• OBS Integration:
  • Added Transform OBS Source effect (#2664)
  • Support for OBS Groups
  • New events: OBS Connected and OBS Disconnected (#2618)
  • Support for OBS chapter markers (#2616)
  • Added support for OBS GDI+ v3 Text Sources (#2638)
• Channel Rewards: Events for when a Channel Reward is accepted or rejected (#2572)
• User Interaction: Mark user active on channel point redemption (#2542)
• Dashboard Feedback: Added feedback for slash command use (#2527)
• Twitch Viewer Card: Link added to viewer info popup.
• Graphics: Firebot Graphics provided by nxbs (#2585)
• Ability to abort running effects and effect lists, either manually or via automatic timeout
• TTS support on Linux (#2705)
• Add Control Hue Light effect

🛠️ Improved

• Single-line text inputs can now be expanded
• Edit Effect modal header is now sticky, allowing constant access to the Test Effects button
• Subcommands can now inherit the base command cooldowns
• Added add/edit tags button to sort tag popover (#2690)
• Added searching to Create New Setup components (#2599)
• OBS Color Picker, Raw/Variable Color Entry (#2708)
• Timeout option for HTTP Request effect
• $effectOutput now supports propertyPath and defaultData arguments (#2709)
• Added case-insensitive 'contains' to conditional effect
• New selectable image types: .bmp, .apng, .webm
• Input box changed to a multiline textarea for preset list args (#2399, #2626)
• UI improvements: padding, whitespace, and scrolling (#2602, #2597, #2490)
• Skip null/empty username values on custom role import (#2489)
• Aria support for preset effect lists and add/edit event modal (#2642, #2640)
• Edge-case handling of $chatMessageTextOnly (#2649)
• Improved index-referencing for $arrayElement and $arrayRemove (#2651)
• Reduced logging spam (#2653)
• Added max age and featured only Twitch clip options to the Play Video effect
• Improved rounded corners of inputs that have a title
• Improved copy and corrected typos throughout the app
• Philips Hue integration now has improved bridge discovery
• Clickable link added to feature stream setting
• Aria labels added to settings where missing (#2623)
• Improved Effect Modal Test Effect Aria accessibility (#2604)

✅ Fixed

• $randomActiveViewer variable filtering (#2627)
• Fuzzy matching for array-related searching (#2605)
• $readFile example description fixed (#2603)
• Windows resize with display scaling (#2578)
• /me not triggering from commands.
• Show Image effect not respecting specified duration.
• Run Command Effect arg returning undefined.
• Perform ad check on startup.
• Time input not saving seconds (#2494)
• $ensureNumber ignoring string empty
• Reward filters not having display description
• Can't use effect output variables in Preset Effect List arguments (#2444)
• Searching commands with "!" in Create Setup modal returns incorrect results (#2643)
• Streamer account logged out after putting host PC to sleep or when a network issue is encountered (#2646)
• Viewer Rank event filter not functioning correctly (#2654)
• Viewer Rank commands sending incorrect chat messages after rank up
• Channel rewards creating invalid default color codes (#2682)
• Export setup file extension on linux (#2677, #2678)
• Cooldown search negation (#2676)
• Corrected data output types for OBS variables
• Sort tag menu overflowing under modal footer
• Clip effect failing because it thinks streamer is offline
• Added timeout to known bots list api call
• Pasting a previously copied effect multiple times gives each copy the same id
• $userRoles not available for some triggers
• Twitch Connected event fires before bot account is connected to chat
• Dashboard sometimes has empty space at bottom
• User metadata not saving when username in database mismatches twitch username

⚙️ Under the Hood

• Updated to Electron 31 and Node 20
• Improvements for custom scripts:
  • Script js files can now be nested within folders within the /scripts dir
  • Script description, param titles, and param descriptions now support markdown
  • Support for more param types
  • ReplaceVariableFactory, EventFilterFactory, and NotificationManager modules now passed to scripts
  • Added showToast IPC event for showing a toast message that scripts can trigger
• Switched to prebuilt firebot-nutjs (#2615)
• Added support for variable aliasing (#2613)
• Fixed api/v1/viewers to return proper username and displayName (#2607)
• Added guard against effectOutputs being null
• Fixed log requestor IP for API calls (#2534)
• Resolve create preset list promise on cancel, pass back fully saved preset list object
• Expanded support for OAuth host configurations
• Expanded replace-variable-manager definition
• Added /api/v1/viewers/export end point to retrieve entire viewer db in json format
• Added event API over websockets (#2641)
• Fix: Corrected JsonDbManager event typo
• Fix: Manual metadata being null instead of empty object (#2648)

Windows Install

• Download and run Firebot-v5.63.0-setup.exe

MacOS Install

• Download Firebot-v5.63.0-macos-x64.dmg
• 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

• Download Firebot-v5.63.0-linux-x64.tar.gz
• Unpack Firebot-v5.63.0-linux-x64.tar.gz
• Change into the directory where you unpacked the archive
• Run the Firebot v5 executable.
  • This must either be done via a terminal window, or you will need to create a shortcut that includes the correct path for the unpacked archived as the "working directory".

Note: Linux does not receive auto-updates

Release v5.63.0-beta3

v5.63.0-beta3 Update Notes

✨New

• Added Transform OBS Source effect (#2664)
• Added Activity Feed Alert effect (#2667)
• Ability to abort running effects and effect lists, either manually or via automatic timeout
• New Variables: $randomUUID, $chatMessageId
• New Events: Chat Message Deleted, Twitch Chat Cleared
• New Event Filters: New Rank, Previous Rank, Rank Transition Type
• Support for OBS Groups
• TTS support on Linux (#2705)
• Add Control Hue Light effect

🛠️ Improved

• Single-line text inputs can now be expanded
• You can now customize the rank promotion messages
• Edit Effect modal header is now sticky, allowing constant access to the Test Effects button
• Subcommands can now inherit the base command cooldowns
• OBS Color Picker, Raw/Variable Color Entry (#2708)
• Added max age and featured only Twitch clip options to the Play Video effect
• Added add/edit tags button to sort tag popover (#2690)
• Timeout option for HTTP Request effect
• $effectOutput now supports propertyPath and defaultData arguments (#2709)
• Improved rounded corners of inputs that have a title
• Improved copy and corrected typos throughout the app
• Philips Hue integration now has improved bridge discovery

✅ Fixed

• Channel rewards creating invalid default color codes (#2682)
• Export setup file extension on linux (#2677, #2678)
• Cooldown search negation (#2676)
• Corrected data output types for OBS variables
• Sort tag menu overflowing under modal footer
• Clip effect failing because it thinks streamer is offline
• Added timeout to known bots list api call
• Pasting a previously copied effect multiple times gives each copy the same id
• $userRoles not available for some triggers
• Twitch Connected event fires before bot account is connected to chat
• Dashboard sometimes has empty space at bottom
• User metadata not saving when username in database mismatches twitch username

⚙️ Under the Hood

• Updated to Electron 31 and Node 20
• Improvements for custom scripts:
  • Script js files can now be nested within folders within the /scripts dir
  • Script description, param titles, and param descriptions now support markdown
  • Support for more param types
  • ReplaceVariableFactory, EventFilterFactory, and NotificationManager modules now passed to scripts
  • Added showToast IPC event for showing a toast message that scripts can trigger

Support the project

• Merch Store
• Donate

Windows Install

• Download and run Firebot-v5.63.0-beta3-setup.exe

MacOS Install

• Download Firebot-v5.63.0-beta3-macos-x64.dmg
• 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: MacOS does not receive auto-updates

Linux Install

• Download Firebot-v5.63.0-beta3-linux-x64.tar.gz
• Unpack Firebot-v5.63.0-beta3-linux-x64.tar.gz
• Change into the directory where you unpacked the archive
• Run the Firebot v5 executable.
  • This must either be done via a terminal window, or you will need to create a shortcut that includes the correct path for the unpacked archived as the "working directory".

Note: Linux does not receive auto-updates

Release v5.63.0-beta2

v5.63.0-beta2 Update Notes

✨ New

• Added support for OBS GDI+ v3 Text (#2638)
• Added $unixTimestamp variable to return number of seconds since unix epoch (#2644)

✅ Fixed

• Recursive effect-list runs not populating effect outputs
• Setup component filter negation (#2643)
• Authorization tokens being invalidated as a result of network issues
• Viewer Rank filtering not being respected (#2654)
• Viewer rank commands sending incorrect chat messages after rank up

🛠️ Improved

• Aria support (#2642, #2640)
• Edge-case handling of $chatMessageTextOnly (#2649)
• Improved index-referencing for $arrayElement and $arrayRemove (#2651)
• Reduced logging spam (#2653)

🔗 Internal

• Added /api/v1/viewers/export end point to retrieve entire viewer db in json format
• Added event API over websockets (#2641)
• Fix: Corrected JsonDbManager event typo
• Fix: Manual metadata being null instead of empty object (#2648)

Windows Install

• Download and run Firebot-v5.63.0-beta2-setup.exe

MacOS Install

• Download Firebot-v5.63.0-beta2-macos-x64.dmg
• 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

• Download Firebot-v5.63.0-beta2-linux-x64.tar.gz
• Unpack Firebot-v5.63.0-beta2-linux-x64.tar.gz
• Change into the directory where you unpacked the archive
• Run the Firebot v5 executable.
  • This must either be done via a terminal window, or you will need to create a shortcut that includes the correct path for the unpacked archived as the "working directory".

Note: Linux does not receive auto-updates

Release v5.63.0-beta1

v5.63.0-beta1 Update Notes

✨ New

• Ranks System (#1898)
  • Automated ladders to move viewers through ranks based on view time or currency
  • Manual ladders that you control fully with the new Update Viewer Rank effect
• $variable Macro System
  • Reuse complicated variables easily.
• Run Random Effect now supports weighted chances (#1971).
• Added ability to convert any effect list into to Preset Effect Lists (#2624).
• New Variables:
  • $userProfileImageUrl as alias for $userAvatarUrl
  • $userBio to retrieve user's Twitch bio/about (#2612)
  • $obsIsConnected for OBS connection state (#2608)
  • $chatMessageTextOnly returns chat message without URIs or emotes (#2598)
  • $effectQueueLength for effect queue length (#2533)
• OBS Integration:
  • New events: OBS Connected and OBS Disconnected (#2618)
  • Support for OBS chapter markers (#2616)
• Channel Rewards: Events for when a Channel Reward is accepted or rejected (#2572)
• User Interaction: Mark user active on channel point redemption (#2542)
• Dashboard Feedback: Added feedback for slash command use (#2527)
• Twitch Viewer Card: Link added to viewer info popup.
• Graphics: Firebot Graphics provided by nxbs (#2585)

🛠️ Improved

• Clickable link added to feature stream setting.
• Aria labels added to settings where missing (#2623).
• Improved accessibility of firebot-select component.
• Added case-insensitive 'contains' to conditional effect.
• New selectable image types: .bmp, .apng, .webm.
• Improved Effect Modal Test Effect Aria accessibility (#2604).
• Input box changed to a multiline textarea for preset list args (#2399, #2626).
• UI improvements: padding, whitespace, and scrolling (#2602, #2597, #2490).
• Skip null/empty username values on custom role import (#2489).
• Added searching to Create New Setup components (#2599).

✅ Fixed

• $randomActiveViewer variable filtering (#2627).
• Fuzzy matching for array-related searching (#2605).
• $readFile example description fixed (#2603).
• Windows resize with display scaling (#2578).
• /me not triggering from commands.
• Show Image effect not respecting specified duration.
• Run Command Effect arg returning undefined.
• Perform ad check on startup.
• Time input not saving seconds (#2494).
• $ensureNumber ignoring string empty.
• Reward filters not having display description.

🔗 Internal Changes

• Added support for variable aliasing (#2613).
• Switched to prebuilt firebot-nutjs (#2615).
• Fixed api/v1/viewers to return proper username and displayName (#2607).
• Added guard against effectOutputs being null.
• Fixed log requestor IP for API calls (#2534).
• Resolve create preset list promise on cancel, pass back fully saved preset list object.
• Expanded support for OAuth host configurations.
• Expanded replace-variable-manager definition.

Windows Install

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

MacOS Install

• Download Firebot-v5.63.0-beta1-macos-x64.dmg
• 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

• Download Firebot-v5.63.0-beta1-linux-x64.tar.gz
• Unpack Firebot-v5.63.0-beta1-linux-x64.tar.gz
• Change into the directory where you unpacked the archive
• Run the Firebot v5 executable.
  • This must either be done via a terminal window, or you will need to create a shortcut that includes the correct path for the unpacked archived as the "working directory".

Note: Linux does not receive auto-updates

Release v5.62.1

v5.62.1 Hotfix Notes

✨ New

• Added new $isUserInChat variable (#2477)
• Added new $isAdBreakRunning variable (#2480)

🛠️ Improved

• The Commands page now contains advanced search options to toggle between normal and full text custom command searching
• Built-in games once again show the formatted display name when posting chat messages

✅ Fixed

• Fixed an issue where the ad break countdown on the top bar would not show hours for upcoming scheduled ad breaks that were longer than an hour away
• Fixed an issue where clicking the + button in the variable popup in the Show Text effect wouldn't add variables to the WYSIWYG editor

v5.62.0 Update Notes

Note

To learn more about the changes to the username variables, Firebot's internal role management, and how this will affect you, please read this wiki article

✨ New

• Custom Roles have been revamped. We now track viewers in custom (and all other) roles by their user ID.
• Users with localized Twitch display names now display their localized variant along with their regular username in most areas of the UI, similarly to how they appear in Twitch chat
• You can now manage your Channel Reward Request Queue for any rewards that can be managed by Firebot. From here, you can approve or reject individual pending redemptions, all pending redemptions for a single reward, or all pending redemptions, You can access the queue on both the Dashboard via Quick Actions and the Channel Reward screen. (#1154)
  
• Scheduled ad break countdowns now appear in the top bar
• Added new $userDisplayName variable
• Added new Ad Break Start and Ad Break End events (#2111)
• Added new Scheduled Ad Break Starting Soon event. This can be configured in Settings -> Triggers. It is disabled by default. (#2111)
• Added new Snooze Next Ad Break effect
• Added new $adBreakDuration, $isAdBreakScheduled, and $secondsUntilNextAdBreak variables
• Added new Show/Hide Command option on custom command right-click menu (#2400) (#2472)
• Added new Magic variable category to display any special, context-specific variables (e.g. custom variables, preset list args, effect outputs) (#2466)
• Added new option to immediately skip remaining time on Play Sound/Play Video effects when clearing/refreshing overlays (#2116)
• Added the following new OBS events:
  • OBS Input Created
  • OBS Input Removed
  • OBS Input Name Changed
  • OBS Input Settings Changed
  • OBS Input Active State Changed
  • OBS Input Show State Changed
  • OBS Input Mute State Changed
  • OBS Input Volume Level Changed
  • OBS Input Audio Balance Changed
  • OBS Input Audio Sync Offset Changed
  • OBS Input Audio Tracks Changed
  • OBS Input Audio Monitor Type Changed
• Added the following new OBS variables:
  • $obsInputName
  • $obsInputUuid
  • $obsInputKind
  • $obsInputSettings
  • $obsOldInputName
  • $obsInputActive
  • $obsInputShowing
  • $obsInputMuted
  • $obsInputVolumeDb
  • $obsInputVolumeMultiplier
  • $obsInputAudioBalance
  • $obsInputAudioSyncOffset
  • $obsInputAudioTracks
  • $obsInputMonitorType

🛠️ Improved

• The Required Additional Arg Count field for subcommands may now be reset to 0 if it was previously set to a higher value
• Firebot now attempts to load and cache all channel moderators/VIPs both at startup and when connecting to Twitch, and will update roles for moderators while connected to Twitch
• Chat messages from Firebot (both streamer and bot accounts) now send via Twitch's REST API instead of IRC
• All viewer roles now track users by user ID instead of username/display name
• The $user/$username variables now return a username, not a display name
• The $useridname variable has been deprecated
• The Cost field of the Update Channel Reward effect now allows variables (#2410)
• When Firebot encounters an unrecoverable issue with Twitch login credentials, it now immediately logs out the affected account(s) and prompts the user to log back in
• The chat settings UI has been refreshed
• The Create Clip effect now only waits to continue to the next effect if the clip is set to be displayed on an overlay and the Wait option is selected (#2428)
• The $convertToJSON now has an option to pretty-print the output (#2422)
• Custom scripts are now signaled to stop when Firebot is closed so that they can perform any cleanup (#2431)
• The Approve/Reject Reward Redemption effect now has a Current option for use inside of channel reward effect lists
• Channel Rewards now support restrictions (#2452)
• Channel Rewards now support the $arg and $target variables (#1612)
• Chat autocomplete on the dashboard now performs searches for terms anywhere in the name of emotes and chat users (e.g. :wut will show both the zunder2Wut and WutFace emotes)
• The Play Sound effect file chooser dialog now supports FLAC files
• When clicking the Update button for beta update notifications in Firebot, it now launches the GitHub release page for the beta update
• Firebot now automatically closes all child windows when closing the main window on macOS/Linux
• The Chat effect can now optionally send the message as an action using /me (#2440)
• Several improvements have been made to the Follow Check restriction (#1193) (#2453) (#2456)
• Several UI improvements to most Firebot data tables, especially for commands
• Sort tag UI has been refactored to make it easier to manage tags
• The Set Chat Mode effect now includes an option for Unique-Mode chat
• The Cooldown Command effect can now also cooldown the fallback subcommand (#2461)
• Subcommand options are now hidden when selecting the tag option in the Cooldown Command effect (#2462)
• Extension messages can now trigger commands/events (#2433)
• When deleting a subcommand, the confirmation dialog now displays which subcommand you are deleting. It also only asks you to confirm once instead of twice. (#2458)
• Better fallback subcommand UI/UX (#2459)

✅ Fixed

• The "Disconnected from chat" message on the Dashboard now properly hides once chat connection has been reestablished (#2423) (#2424)
• Fixed an issue where using Tier 2/Tier 3 subscriber roles for permissions/role checks would not work (#2167)
• Fixed an issue where renaming a Quick Action would result in an error when there was no error (#2419) (#2420)
• The Create Clip effect now correctly returns its effect output (#2428)
• Fixed an issue where the custom variable tooltip in the Create Clip effect would break custom variable settings for the effect
• Fixed an issue where autocomplete on the Dashboard may break in certain scenarios
• Fixed the usage examples for the $textPadStart and $textPadEnd variables (#2416) (#2417)
• Fixed an issue where the ampersand character (&) in an overlay name would cause it to not work
• Fixed an issue where the main window wasn't fully closing correctly behind the scenes
• Fixed multiple UI issues (#1804)
• Fixed an issue where newly created commands would not increment their usage count until Firebot was restarted (#2450)
• Fixed an issue when using multiple nodes with the $objectWalkPath variable
• Fixed an issue where the Dashboard chatter list may be blank
• Fixed an issue where Twitch events may stop triggering after some time (#2457)
• Fixed an issue where the $chatMessage variable may be missing part of the beginning of the text
• Fixed an issue where the Toggle Connection effect would not toggle integrations correctly (#2454) (#2470)
• Fixed a display issue where the wrong symbol would be displayed for a subcommand when deleting another subcommand higher in the list (#2460)

🔗 API Changes

• Updated to Twurple 7.1.0
• Internal web server now forces listening on both IPv4 and IPv6 to fix issues on some Linux systems

Windows Install

• Download and run Firebot-v5.62.1-setup.exe

MacOS Install

• Download Firebot-v5.62.1-macos-x64.dmg
• 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

• Download Firebot-v5.62.1-linux-x64.tar.gz
• Unpack Firebot-v5.62.1-linux-x64.tar.gz
• Change into the directory where you unpacked the archive
• Run the Firebot v5 executable.
  • This must either be done via a terminal window, or you will need to create a shortcut that includes the correct path for the unpacked archived as the "working directory".

Note: Linux does not receive auto-updates

Release v5.62.0

v5.62.0 Update Notes

Note

To learn more about the changes to the username variables, Firebot's internal role management, and how this will affect you, please read this wiki article

✨ New

• Custom Roles have been revamped. We now track viewers in custom (and all other) roles by their user ID.
• Users with localized Twitch display names now display their localized variant along with their regular username in most areas of the UI, similarly to how they appear in Twitch chat
• You can now manage your Channel Reward Request Queue for any rewards that can be managed by Firebot. From here, you can approve or reject individual pending redemptions, all pending redemptions for a single reward, or all pending redemptions, You can access the queue on both the Dashboard via Quick Actions and the Channel Reward screen. (#1154)
  
• Scheduled ad break countdowns now appear in the top bar
• Added new $userDisplayName variable
• Added new Ad Break Start and Ad Break End events (#2111)
• Added new Scheduled Ad Break Starting Soon event. This can be configured in Settings -> Triggers. It is disabled by default. (#2111)
• Added new Snooze Next Ad Break effect
• Added new $adBreakDuration, $isAdBreakScheduled, and $secondsUntilNextAdBreak variables
• Added new Show/Hide Command option on custom command right-click menu (#2400) (#2472)
• Added new Magic variable category to display any special, context-specific variables (e.g. custom variables, preset list args, effect outputs) (#2466)
• Added new option to immediately skip remaining time on Play Sound/Play Video effects when clearing/refreshing overlays (#2116)
• Added the following new OBS events:
  • OBS Input Created
  • OBS Input Removed
  • OBS Input Name Changed
  • OBS Input Settings Changed
  • OBS Input Active State Changed
  • OBS Input Show State Changed
  • OBS Input Mute State Changed
  • OBS Input Volume Level Changed
  • OBS Input Audio Balance Changed
  • OBS Input Audio Sync Offset Changed
  • OBS Input Audio Tracks Changed
  • OBS Input Audio Monitor Type Changed
• Added the following new OBS variables:
  • $obsInputName
  • $obsInputUuid
  • $obsInputKind
  • $obsInputSettings
  • $obsOldInputName
  • $obsInputActive
  • $obsInputShowing
  • $obsInputMuted
  • $obsInputVolumeDb
  • $obsInputVolumeMultiplier
  • $obsInputAudioBalance
  • $obsInputAudioSyncOffset
  • $obsInputAudioTracks
  • $obsInputMonitorType

🛠️ Improved

• The Required Additional Arg Count field for subcommands may now be reset to 0 if it was previously set to a higher value
• Firebot now attempts to load and cache all channel moderators/VIPs both at startup and when connecting to Twitch, and will update roles for moderators while connected to Twitch
• Chat messages from Firebot (both streamer and bot accounts) now send via Twitch's REST API instead of IRC
• All viewer roles now track users by user ID instead of username/display name
• The $user/$username variables now return a username, not a display name
• The $useridname variable has been deprecated
• The Cost field of the Update Channel Reward effect now allows variables (#2410)
• When Firebot encounters an unrecoverable issue with Twitch login credentials, it now immediately logs out the affected account(s) and prompts the user to log back in
• The chat settings UI has been refreshed
• The Create Clip effect now only waits to continue to the next effect if the clip is set to be displayed on an overlay and the Wait option is selected (#2428)
• The $convertToJSON now has an option to pretty-print the output (#2422)
• Custom scripts are now signaled to stop when Firebot is closed so that they can perform any cleanup (#2431)
• The Approve/Reject Reward Redemption effect now has a Current option for use inside of channel reward effect lists
• Channel Rewards now support restrictions (#2452)
• Channel Rewards now support the $arg and $target variables (#1612)
• Chat autocomplete on the dashboard now performs searches for terms anywhere in the name of emotes and chat users (e.g. :wut will show both the zunder2Wut and WutFace emotes)
• The Play Sound effect file chooser dialog now supports FLAC files
• When clicking the Update button for beta update notifications in Firebot, it now launches the GitHub release page for the beta update
• Firebot now automatically closes all child windows when closing the main window on macOS/Linux
• The Chat effect can now optionally send the message as an action using /me (#2440)
• Several improvements have been made to the Follow Check restriction (#1193) (#2453) (#2456)
• Several UI improvements to most Firebot data tables, especially for commands
• Sort tag UI has been refactored to make it easier to manage tags
• The Set Chat Mode effect now includes an option for Unique-Mode chat
• The Cooldown Command effect can now also cooldown the fallback subcommand (#2461)
• Subcommand options are now hidden when selecting the tag option in the Cooldown Command effect (#2462)
• Extension messages can now trigger commands/events (#2433)
• When deleting a subcommand, the confirmation dialog now displays which subcommand you are deleting. It also only asks you to confirm once instead of twice. (#2458)
• Better fallback subcommand UI/UX (#2459)

✅ Fixed

• The "Disconnected from chat" message on the Dashboard now properly hides once chat connection has been reestablished (#2423) (#2424)
• Fixed an issue where using Tier 2/Tier 3 subscriber roles for permissions/role checks would not work (#2167)
• Fixed an issue where renaming a Quick Action would result in an error when there was no error (#2419) (#2420)
• The Create Clip effect now correctly returns its effect output (#2428)
• Fixed an issue where the custom variable tooltip in the Create Clip effect would break custom variable settings for the effect
• Fixed an issue where autocomplete on the Dashboard may break in certain scenarios
• Fixed the usage examples for the $textPadStart and $textPadEnd variables (#2416) (#2417)
• Fixed an issue where the ampersand character (&) in an overlay name would cause it to not work
• Fixed an issue where the main window wasn't fully closing correctly behind the scenes
• Fixed multiple UI issues (#1804)
• Fixed an issue where newly created commands would not increment their usage count until Firebot was restarted (#2450)
• Fixed an issue when using multiple nodes with the $objectWalkPath variable
• Fixed an issue where the Dashboard chatter list may be blank
• Fixed an issue where Twitch events may stop triggering after some time (#2457)
• Fixed an issue where the $chatMessage variable may be missing part of the beginning of the text
• Fixed an issue where the Toggle Connection effect would not toggle integrations correctly (#2454) (#2470)
• Fixed a display issue where the wrong symbol would be displayed for a subcommand when deleting another subcommand higher in the list (#2460)

🔗 API Changes

• Updated to Twurple 7.1.0
• Internal web server now forces listening on both IPv4 and IPv6 to fix issues on some Linux systems

Windows Install

• Download and run Firebot-v5.62.0-setup.exe

MacOS Install

• Download Firebot-v5.62.0-macos-x64.dmg
• 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

• Download Firebot-v5.62.0-linux-x64.tar.gz
• Unpack Firebot-v5.62.0-linux-x64.tar.gz
• Change into the directory where you unpacked the archive
• Run the Firebot v5 executable.
  • This must either be done via a terminal window, or you will need to create a shortcut that includes the correct path for the unpacked archived as the "working directory".

Note: Linux does not receive auto-updates