Release v5.62.0-beta1

v5.62.0-beta1 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
• Added new $userDisplayName variable

🛠️ Improved

• 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)

✅ 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

Windows Install

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

MacOS Install

• Download Firebot-v5.62.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.62.0-beta1-linux-x64.tar.gz
• Unpack Firebot-v5.62.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.61.2

v5.61.2 Hotfix Notes

✨ New

• Preset Effect List arguments may now be accessed via $# in addition to $presetListArgs (e.g. $#someArg is the same as $presetListArgs[someArg])

✅ Fixed

• Fixed an issue where viewers would not accrue watch time

v5.61.1 Hotfix Notes

✅ Fixed

• Fixed an issue where we weren't handling corrupt JsonDB files properly (#2405)

v5.61.0 Update Notes

Caution

Several advanced variables may now work differently or have been deprecated in this release (e.g. any variables that begin with $array, $object, $raw or $regex). PLEASE test and update your setups accordingly to ensure they work as expected. For a full list of related changes, please see this wiki article

✨ New

• Firebot's variable processing engine has been overhauled
• Introducing: Firebot Featured Streams! You may now opt-in to have your stream featured on the Firebot website when you're live. Just go to Settings > General and enable Feature My Stream on Firebot.app
• The top bar now indicates the status of an active Hype Train (#2087)
• Commands, Channel Rewards, Timers, and Scheduled Effect Lists can be enabled/disabled via tag (#576) (#2342)
• Added an option on the Commands tab to manually clear cooldowns on both individual commands and all commands (#1947)
• Custom variables may now be accessed via $$ in addition to $customVariable (e.g. $$myVar is the same as $customVariable[myVar] and $$myVar[path, to, value] is the same as $customVariable[myVar, path.to.value])
• Effect outputs may now be accessed via $& in addition to $effectOutputs (e.g. $&httpRequest is the same as $effectOutputs[httpRequest] and $&httpRequest[path, to, value] is the same as $effectOutputs[httpRequest, path.to.value])
• Added exact matching for the $arrayFind* variables
• Added new $userIsBanned and $userIsTimedOut variables (#2330)
• Added new $pronouns variable (#2187) (#2341)
• Added new $extraLifeInfo, $extraLifeMilestones, $extraLifeDonations, and $extraLifeIncentives variables (#2229) (#2343)
• Added new $arrayRandomItem, $filesInDirectory, $textPadStart, and $textPadEnd variables
• Added new $null, $true and $false variables
• Added default currency option for !steam system command (#2138)
• Added new Before Firebot Closed event (#2332) (#2347)
• Added new Evaluate JavaScript effect and $evalJs variable. These will allow you to run simple, very limited JavaScript functions for advanced processing.
• The Evaluate JavaScript effect and $evalJs variable can now access custom variables via Firebot.getCustomVariable(varName) and effect outputs via Firebot.getEffectOutput(outputName)
• Added --fbuser-data-directory and --fbsecrets-config command line flags

🛠️ Improved

• Clarified the tooltip around storing Twitch clip URLs in a custom variable (#2392)
• Command cooldowns are no longer cleared inadvertently in multiple scenarios, including when switching to the Commands tab or when using the Toggle Command effect (#1947)
• We now better handle usernames in several scenarios, including those with Unicode/international characters in their usernames (#2123) (#2131) (#2390)
• Usernames now get updated when users appear in chat after they change their username (#2198)
• The !commands command now allows for custom chat output (#2339)
• Cleaned up the command data export when using !commands
• The Run Program effect can now read output (#1176)
• Whisper events are no longer cached, meaning they will trigger with each message, just like chat messages
• The known bot list is now loaded when connecting to Twitch if it failed to load previously (#2349)
• The $followCount variable should more consistently return a value (#2368)
• The $subNames variable now includes display names (#2379)
• The Log Message effect now has a multiline editor for the message
• Backups created on Windows will now properly restore on non-Windows systems
• Several internal Firebot systems have been refactored/updated (viewer database, command handlers, currency, in-app notifications, backups)
• Misc improvements/typo fixes

✅ Fixed

• Fixed an issue with 7TV channel emotes
• Fixed an issue with Raid event metadata
• Fixed an issue where quick actions may not import correctly from a Firebot setup (#2376)
• Fixed an issue where quick actions may not show up after being added from the Dashboard (#2401) (#2402)
• Fixed an issue with effect outputs causing an error in Loop Effects effect
• Conditional effects now properly read previous effect outputs
• Fixed an issue where $chatMessage variable does not return the full chat message for a command with a regex trigger (#2394)
• Fixed an issue where variables may unexpectedly return [object Object] (#2323)
• Fixed an issue where HTTP routes registered via custom scripts may erroneously include backslashes

🔗 API Changes

• Added new GET /timers/:timerId/:action API endpoint (#2395) (#2396)
• Custom script parametersUpdated() and stop() functions are now properly called (#2337) (#2338)
• Bumped Electron to 28.2.3

Misc

• Merge pull request #2409 from crowbartools/v5
• 5.61.2
• fix(database): fix viewer watch time accrual
• feat: spoof $#name shorthand variable
• feat: presetListArgs shorthand
• chore: better negative mathing

Windows Install

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

MacOS Install

• Download Firebot-v5.61.2-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.61.2-linux-x64.tar.gz
• Unpack Firebot-v5.61.2-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.61.1

v5.61.1 Hotfix Notes

✅ Fixed

• Fixed an issue where we weren't handling corrupt JsonDB files properly (#2405)

v5.61.0 Update Notes

Caution

Several advanced variables may now work differently or have been deprecated in this release (e.g. any variables that begin with $array, $object, $raw or $regex). PLEASE test and update your setups accordingly to ensure they work as expected. For a full list of related changes, please see this wiki article

✨ New

• Firebot's variable processing engine has been overhauled
• Introducing: Firebot Featured Streams! You may now opt-in to have your stream featured on the Firebot website when you're live. Just go to Settings > General and enable Feature My Stream on Firebot.app
• The top bar now indicates the status of an active Hype Train (#2087)
• Commands, Channel Rewards, Timers, and Scheduled Effect Lists can be enabled/disabled via tag (#576) (#2342)
• Added an option on the Commands tab to manually clear cooldowns on both individual commands and all commands (#1947)
• Custom variables may now be accessed via $$ in addition to $customVariable (e.g. $$myVar is the same as $customVariable[myVar] and $$myVar[path, to, value] is the same as $customVariable[myVar, path.to.value])
• Effect outputs may now be accessed via $& in addition to $effectOutputs (e.g. $&httpRequest is the same as $effectOutputs[httpRequest] and $&httpRequest[path, to, value] is the same as $effectOutputs[httpRequest, path.to.value])
• Added exact matching for the $arrayFind* variables
• Added new $userIsBanned and $userIsTimedOut variables (#2330)
• Added new $pronouns variable (#2187) (#2341)
• Added new $extraLifeInfo, $extraLifeMilestones, $extraLifeDonations, and $extraLifeIncentives variables (#2229) (#2343)
• Added new $arrayRandomItem, $filesInDirectory, $textPadStart, and $textPadEnd variables
• Added new $null, $true and $false variables
• Added default currency option for !steam system command (#2138)
• Added new Before Firebot Closed event (#2332) (#2347)
• Added new Evaluate JavaScript effect and $evalJs variable. These will allow you to run simple, very limited JavaScript functions for advanced processing.
• The Evaluate JavaScript effect and $evalJs variable can now access custom variables via Firebot.getCustomVariable(varName) and effect outputs via Firebot.getEffectOutput(outputName)
• Added --fbuser-data-directory and --fbsecrets-config command line flags

🛠️ Improved

• Clarified the tooltip around storing Twitch clip URLs in a custom variable (#2392)
• Command cooldowns are no longer cleared inadvertently in multiple scenarios, including when switching to the Commands tab or when using the Toggle Command effect (#1947)
• We now better handle usernames in several scenarios, including those with Unicode/international characters in their usernames (#2123) (#2131) (#2390)
• Usernames now get updated when users appear in chat after they change their username (#2198)
• The !commands command now allows for custom chat output (#2339)
• Cleaned up the command data export when using !commands
• The Run Program effect can now read output (#1176)
• Whisper events are no longer cached, meaning they will trigger with each message, just like chat messages
• The known bot list is now loaded when connecting to Twitch if it failed to load previously (#2349)
• The $followCount variable should more consistently return a value (#2368)
• The $subNames variable now includes display names (#2379)
• The Log Message effect now has a multiline editor for the message
• Backups created on Windows will now properly restore on non-Windows systems
• Several internal Firebot systems have been refactored/updated (viewer database, command handlers, currency, in-app notifications, backups)
• Misc improvements/typo fixes

✅ Fixed

• Fixed an issue with 7TV channel emotes
• Fixed an issue with Raid event metadata
• Fixed an issue where quick actions may not import correctly from a Firebot setup (#2376)
• Fixed an issue where quick actions may not show up after being added from the Dashboard (#2401) (#2402)
• Fixed an issue with effect outputs causing an error in Loop Effects effect
• Conditional effects now properly read previous effect outputs
• Fixed an issue where $chatMessage variable does not return the full chat message for a command with a regex trigger (#2394)
• Fixed an issue where variables may unexpectedly return [object Object] (#2323)
• Fixed an issue where HTTP routes registered via custom scripts may erroneously include backslashes

🔗 API Changes

• Added new GET /timers/:timerId/:action API endpoint (#2395) (#2396)
• Custom script parametersUpdated() and stop() functions are now properly called (#2337) (#2338)
• Bumped Electron to 28.2.3

Windows Install

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

MacOS Install

• Download Firebot-v5.61.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.61.1-linux-x64.tar.gz
• ?? will need further instructions

Note: Linux does not receive auto-updates

Release v5.61.0

v5.61.0 Update Notes

Caution

Several advanced variables may now work differently or have been deprecated in this release (e.g. any variables that begin with $array, $object, $raw or $regex). PLEASE test and update your setups accordingly to ensure they work as expected. For a full list of related changes, please see this wiki article

✨ New

• Firebot's variable processing engine has been overhauled
• Introducing: Firebot Featured Streams! You may now opt-in to have your stream featured on the Firebot website when you're live. Just go to Settings > General and enable Feature My Stream on Firebot.app
• The top bar now indicates the status of an active Hype Train (#2087)
• Commands, Channel Rewards, Timers, and Scheduled Effect Lists can be enabled/disabled via tag (#576) (#2342)
• Added an option on the Commands tab to manually clear cooldowns on both individual commands and all commands (#1947)
• Custom variables may now be accessed via $$ in addition to $customVariable (e.g. $$myVar is the same as $customVariable[myVar] and $$myVar[path, to, value] is the same as $customVariable[myVar, path.to.value])
• Effect outputs may now be accessed via $& in addition to $effectOutputs (e.g. $&httpRequest is the same as $effectOutputs[httpRequest] and $&httpRequest[path, to, value] is the same as $effectOutputs[httpRequest, path.to.value])
• Added exact matching for the $arrayFind* variables
• Added new $userIsBanned and $userIsTimedOut variables (#2330)
• Added new $pronouns variable (#2187) (#2341)
• Added new $extraLifeInfo, $extraLifeMilestones, $extraLifeDonations, and $extraLifeIncentives variables (#2229) (#2343)
• Added new $arrayRandomItem, $filesInDirectory, $textPadStart, and $textPadEnd variables
• Added new $null, $true and $false variables
• Added default currency option for !steam system command (#2138)
• Added new Before Firebot Closed event (#2332) (#2347)
• Added new Evaluate JavaScript effect and $evalJs variable. These will allow you to run simple, very limited JavaScript functions for advanced processing.
• The Evaluate JavaScript effect and $evalJs variable can now access custom variables via Firebot.getCustomVariable(varName) and effect outputs via Firebot.getEffectOutput(outputName)
• Added --fbuser-data-directory and --fbsecrets-config command line flags

🛠️ Improved

• Clarified the tooltip around storing Twitch clip URLs in a custom variable (#2392)
• Command cooldowns are no longer cleared inadvertently in multiple scenarios, including when switching to the Commands tab or when using the Toggle Command effect (#1947)
• We now better handle usernames in several scenarios, including those with Unicode/international characters in their usernames (#2123) (#2131) (#2390)
• Usernames now get updated when users appear in chat after they change their username (#2198)
• The !commands command now allows for custom chat output (#2339)
• Cleaned up the command data export when using !commands
• The Run Program effect can now read output (#1176)
• Whisper events are no longer cached, meaning they will trigger with each message, just like chat messages
• The known bot list is now loaded when connecting to Twitch if it failed to load previously (#2349)
• The $followCount variable should more consistently return a value (#2368)
• The $subNames variable now includes display names (#2379)
• The Log Message effect now has a multiline editor for the message
• Backups created on Windows will now properly restore on non-Windows systems
• Several internal Firebot systems have been refactored/updated (viewer database, command handlers, currency, in-app notifications, backups)
• Misc improvements/typo fixes

✅ Fixed

• Fixed an issue with 7TV channel emotes
• Fixed an issue with Raid event metadata
• Fixed an issue where quick actions may not import correctly from a Firebot setup (#2376)
• Fixed an issue where quick actions may not show up after being added from the Dashboard (#2401) (#2402)
• Fixed an issue with effect outputs causing an error in Loop Effects effect
• Conditional effects now properly read previous effect outputs
• Fixed an issue where $chatMessage variable does not return the full chat message for a command with a regex trigger (#2394)
• Fixed an issue where variables may unexpectedly return [object Object] (#2323)
• Fixed an issue where HTTP routes registered via custom scripts may erroneously include backslashes

🔗 API Changes

• Added new GET /timers/:timerId/:action API endpoint (#2395) (#2396)
• Custom script parametersUpdated() and stop() functions are now properly called (#2337) (#2338)
• Bumped Electron to 28.2.3

Windows Install

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

MacOS Install

• Download Firebot-v5.61.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.61.0-linux-x64.tar.gz
• ?? will need further instructions

Note: Linux does not receive auto-updates

Release v5.61.0-beta5

v5.61.0-beta5 Changes

Caution

Several advanced variables may now work differently or have been deprecated in this release (e.g. any variables that begin with $array, $object, $raw or $regex). PLEASE test and update your setups accordingly to ensure they work as expected. For a full list of related changes, please see this wiki article

🛠️ Improved

• Reverted a change from beta1 that monitored EventSub connection that was not working as expected

✅ Fixed

• Fixed an issue from beta2 where variables that required specific trigger types would not allow effects to be saved

v5.61.0-beta4 Changes

✅ Fixed

• Fixed an issue from beta1 where variables related to user metadata or currency would not return correct data

v5.61.0-beta3 Changes

🛠️ Improved

• Cleaned up the command data export when using !commands

✅ Fixed

• Fixed an issue from beta2 where variables would not properly validate when editing effects
• Fixed an issue from beta1 where $readFile would not work properly when specifying a line number

v5.61.0-beta2 Changes

✨ New

• Introducing: Firebot Featured Streams! You may now opt-in to have your stream featured on the Firebot website when you're live. Just go to Settings > General and enable Feature My Stream on Firebot.app
• Custom variables may now be accessed via $$ (e.g. $$myVar is the same as $customVariable[myVar] and $$myVar[path, to, value] is the same as $customVariable[myVar, path.to.value])
• Effect outputs may now be accessed via $& (e.g. $&httpRequest is the same as $effectOutputs[httpRequest] and $&httpRequest[path, to, value] is the same as $effectOutputs[httpRequest, path.to.value])
• Added exact matching for the $arrayFind* variables
• The Evaluate JavaScript effect and $evalJs variable can now access custom variables via firebot.getCustomVariable(varName) and effect outputs via firebot.getEffectOutput(outputName)
• Added --fbuser-data-directory and --fbsecrets-config command line flags

🛠️ Improved

• Clarified the tooltip around storing Twitch clip URLs in a custom variable (#2392)

✅ Fixed

• Fixed an issue with 7TV channel emotes
• Fixed an issue from beta1 where custom commands would not refresh immediately when renamed

v5.61.0-beta1 Update Notes

✨ New

• Firebot's variable processing engine has been overhauled
• The top bar now indicates the status of an active Hype Train (#2087)
• Commands, Channel Rewards, Timers, and Scheduled Effect Lists can be enabled/disabled via tag (#576) (#2342)
• Added an option on the Commands tab to manually clear cooldowns on both individual commands and all commands (#1947)
• Added new $userIsBanned and $userIsTimedOut variables (#2330)
• Added new $pronouns variable (#2187) (#2341)
• Added new $extraLifeInfo, $extraLifeMilestones, $extraLifeDonations, and $extraLifeIncentives variables (#2229) (#2343)
• Added new $arrayRandomItem, $filesInDirectory, $textPadStart, and $textPadEnd variables
• Added new $null, $true and $false variables
• Added default currency option for !steam system command (#2138)
• Added new Before Firebot Closed event (#2332) (#2347)
• Added new Evaluate JavaScript effect and $evalJs variable. These will allow you to run simple, very limited JavaScript functions for advanced processing.

🛠️ Improved

• Command cooldowns are no longer cleared inadvertently in multiple scenarios, including when switching to the Commands tab or when using the Toggle Command effect (#1947)
• We now better handle usernames in several scenarios, including those with Unicode/international characters in their usernames (#2123) (#2131) (#2390)
• Usernames now get updated when users appear in chat after they change their username (#2198)
• The !commands command now allows for custom chat output (#2339)
• The Run Program effect can now read output (#1176)
• Whisper events are no longer cached, meaning they will trigger with each message, just like chat messages
• The known bot list is now loaded when connecting to Twitch if it failed to load previously (#2349)
• The $followCount variable should more consistently return a value (#2368)
• The $subNames variable now includes display names (#2379)
• Firebot now monitors and attempts to resubscribe to any EventSub subscriptions that may have become invalid
• The Log Message effect now has a multiline editor for the message
• Backups created on Windows will now properly restore on non-Windows systems
• Several internal Firebot systems have been refactored/updated (viewer database, command handlers, currency, in-app notifications, backups)

✅ Fixed

• Fixed an issue with Raid event metadata
• Fixed an issue where quick actions may not import correctly from a Firebot setup (#2376)
• Fixed an issue with effect outputs causing an error in Loop Effects effect
• Conditional effects now properly read previous effect outputs
• Fixed an issue where $chatMessage variable does not return the full chat message for a command with a regex trigger (#2394)
• Fixed an issue where variables may unexpectedly return [object Object] (#2323)
• Fixed an issue where HTTP routes registered via custom scripts may erroneously include backslashes

🔗 API Changes

• Added new GET /timers/:timerId/:action API endpoint (#2395) (#2396)
• Custom script parametersUpdated() and stop() functions are now properly called (#2337) (#2338)
• Bumped Electron to 28.2.2

Windows Install

• Download and run Firebot-v5.61.0-beta5-setup.exe

MacOS Install

• Download Firebot-v5.61.0-beta5-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.61.0-beta5-linux-x64.tar.gz
• ?? will need further instructions

Note: Linux does not receive auto-updates

Release v5.61.0-beta4

v5.61.0-beta4 Changes

Caution

Several advanced variables may now work differently or have been deprecated in this release (e.g. any variables that begin with $array, $object, $raw or $regex). PLEASE test and update your setups accordingly to ensure they work as expected. For a full list of related changes, please see this wiki article

✅ Fixed

• Fixed an issue from beta1 where variables related to user metadata or currency would not return correct data

v5.61.0-beta3 Changes

🛠️ Improved

• Cleaned up the command data export when using !commands

✅ Fixed

• Fixed an issue from beta2 where variables would not properly validate when editing effects
• Fixed an issue from beta1 where $readFile would not work properly when specifying a line number

v5.61.0-beta2 Changes

✨ New

• Introducing: Firebot Featured Streams! You may now opt-in to have your stream featured on the Firebot website when you're live. Just go to Settings > General and enable Feature My Stream on Firebot.app
• Custom variables may now be accessed via $$ (e.g. $$myVar is the same as $customVariable[myVar] and $$myVar[path, to, value] is the same as $customVariable[myVar, path.to.value])
• Effect outputs may now be accessed via $& (e.g. $&httpRequest is the same as $effectOutputs[httpRequest] and $&httpRequest[path, to, value] is the same as $effectOutputs[httpRequest, path.to.value])
• Added exact matching for the $arrayFind* variables
• The Evaluate JavaScript effect and $evalJs variable can now access custom variables via firebot.getCustomVariable(varName) and effect outputs via firebot.getEffectOutput(outputName)
• Added --fbuser-data-directory and --fbsecrets-config command line flags

🛠️ Improved

• Clarified the tooltip around storing Twitch clip URLs in a custom variable (#2392)

✅ Fixed

• Fixed an issue with 7TV channel emotes
• Fixed an issue from beta1 where custom commands would not refresh immediately when renamed

v5.61.0-beta1 Update Notes

✨ New

• Firebot's variable processing engine has been overhauled
• The top bar now indicates the status of an active Hype Train (#2087)
• Commands, Channel Rewards, Timers, and Scheduled Effect Lists can be enabled/disabled via tag (#576) (#2342)
• Added an option on the Commands tab to manually clear cooldowns on both individual commands and all commands (#1947)
• Added new $userIsBanned and $userIsTimedOut variables (#2330)
• Added new $pronouns variable (#2187) (#2341)
• Added new $extraLifeInfo, $extraLifeMilestones, $extraLifeDonations, and $extraLifeIncentives variables (#2229) (#2343)
• Added new $arrayRandomItem, $filesInDirectory, $textPadStart, and $textPadEnd variables
• Added new $null, $true and $false variables
• Added default currency option for !steam system command (#2138)
• Added new Before Firebot Closed event (#2332) (#2347)
• Added new Evaluate JavaScript effect and $evalJs variable. These will allow you to run simple, very limited JavaScript functions for advanced processing.

🛠️ Improved

• Command cooldowns are no longer cleared inadvertently in multiple scenarios, including when switching to the Commands tab or when using the Toggle Command effect (#1947)
• We now better handle usernames in several scenarios, including those with Unicode/international characters in their usernames (#2123) (#2131) (#2390)
• Usernames now get updated when users appear in chat after they change their username (#2198)
• The !commands command now allows for custom chat output (#2339)
• The Run Program effect can now read output (#1176)
• Whisper events are no longer cached, meaning they will trigger with each message, just like chat messages
• The known bot list is now loaded when connecting to Twitch if it failed to load previously (#2349)
• The $followCount variable should more consistently return a value (#2368)
• The $subNames variable now includes display names (#2379)
• Firebot now monitors and attempts to resubscribe to any EventSub subscriptions that may have become invalid
• The Log Message effect now has a multiline editor for the message
• Backups created on Windows will now properly restore on non-Windows systems
• Several internal Firebot systems have been refactored/updated (viewer database, command handlers, currency, in-app notifications, backups)

✅ Fixed

• Fixed an issue with Raid event metadata
• Fixed an issue where quick actions may not import correctly from a Firebot setup (#2376)
• Fixed an issue with effect outputs causing an error in Loop Effects effect
• Conditional effects now properly read previous effect outputs
• Fixed an issue where $chatMessage variable does not return the full chat message for a command with a regex trigger (#2394)
• Fixed an issue where variables may unexpectedly return [object Object] (#2323)
• Fixed an issue where HTTP routes registered via custom scripts may erroneously include backslashes

🔗 API Changes

• Added new GET /timers/:timerId/:action API endpoint (#2395) (#2396)
• Custom script parametersUpdated() and stop() functions are now properly called (#2337) (#2338)
• Bumped Electron to 28.2.2

Windows Install

• Download and run Firebot-v5.61.0-beta4-setup.exe

MacOS Install

• Download Firebot-v5.61.0-beta4-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.61.0-beta4-linux-x64.tar.gz
• ?? will need further instructions

Note: Linux does not receive auto-updates

Release v5.61.0-beta3

v5.61.0-beta3 Changes

Caution

Several advanced variables may now work differently or have been deprecated in this release (e.g. any variables that begin with $array, $object, $raw or $regex). PLEASE test and update your setups accordingly to ensure they work as expected. For a full list of related changes, please see this wiki article

🛠️ Improved

• Cleaned up the command data export when using !commands

✅ Fixed

• Fixed an issue from beta2 where variables would not properly validate when editing effects
• Fixed an issue from beta1 where $readFile would not work properly when specifying a line number

v5.61.0-beta2 Changes

✨ New

• Introducing: Firebot Featured Streams! You may now opt-in to have your stream featured on the Firebot website when you're live. Just go to Settings > General and enable Feature My Stream on Firebot.app
• Custom variables may now be accessed via $$ (e.g. $$myVar is the same as $customVariable[myVar] and $$myVar[path, to, value] is the same as $customVariable[myVar, path.to.value])
• Effect outputs may now be accessed via $& (e.g. $&httpRequest is the same as $effectOutputs[httpRequest] and $&httpRequest[path, to, value] is the same as $effectOutputs[httpRequest, path.to.value])
• Added exact matching for the $arrayFind* variables
• The Evaluate JavaScript effect and $evalJs variable can now access custom variables via firebot.getCustomVariable(varName) and effect outputs via firebot.getEffectOutput(outputName)
• Added --fbuser-data-directory and --fbsecrets-config command line flags

🛠️ Improved

• Clarified the tooltip around storing Twitch clip URLs in a custom variable (#2392)

✅ Fixed

• Fixed an issue with 7TV channel emotes
• Fixed an issue from beta1 where custom commands would not refresh immediately when renamed

v5.61.0-beta1 Update Notes

✨ New

• Firebot's variable processing engine has been overhauled
• The top bar now indicates the status of an active Hype Train (#2087)
• Commands, Channel Rewards, Timers, and Scheduled Effect Lists can be enabled/disabled via tag (#576) (#2342)
• Added an option on the Commands tab to manually clear cooldowns on both individual commands and all commands (#1947)
• Added new $userIsBanned and $userIsTimedOut variables (#2330)
• Added new $pronouns variable (#2187) (#2341)
• Added new $extraLifeInfo, $extraLifeMilestones, $extraLifeDonations, and $extraLifeIncentives variables (#2229) (#2343)
• Added new $arrayRandomItem, $filesInDirectory, $textPadStart, and $textPadEnd variables
• Added new $null, $true and $false variables
• Added default currency option for !steam system command (#2138)
• Added new Before Firebot Closed event (#2332) (#2347)
• Added new Evaluate JavaScript effect and $evalJs variable. These will allow you to run simple, very limited JavaScript functions for advanced processing.

🛠️ Improved

• Command cooldowns are no longer cleared inadvertently in multiple scenarios, including when switching to the Commands tab or when using the Toggle Command effect (#1947)
• We now better handle usernames in several scenarios, including those with Unicode/international characters in their usernames (#2123) (#2131) (#2390)
• Usernames now get updated when users appear in chat after they change their username (#2198)
• The !commands command now allows for custom chat output (#2339)
• The Run Program effect can now read output (#1176)
• Whisper events are no longer cached, meaning they will trigger with each message, just like chat messages
• The known bot list is now loaded when connecting to Twitch if it failed to load previously (#2349)
• The $followCount variable should more consistently return a value (#2368)
• The $subNames variable now includes display names (#2379)
• Firebot now monitors and attempts to resubscribe to any EventSub subscriptions that may have become invalid
• The Log Message effect now has a multiline editor for the message
• Backups created on Windows will now properly restore on non-Windows systems
• Several internal Firebot systems have been refactored/updated (viewer database, command handlers, currency, in-app notifications, backups)

✅ Fixed

• Fixed an issue with Raid event metadata
• Fixed an issue where quick actions may not import correctly from a Firebot setup (#2376)
• Fixed an issue with effect outputs causing an error in Loop Effects effect
• Conditional effects now properly read previous effect outputs
• Fixed an issue where $chatMessage variable does not return the full chat message for a command with a regex trigger (#2394)
• Fixed an issue where variables may unexpectedly return [object Object] (#2323)
• Fixed an issue where HTTP routes registered via custom scripts may erroneously include backslashes

🔗 API Changes

• Added new GET /timers/:timerId/:action API endpoint (#2395) (#2396)
• Custom script parametersUpdated() and stop() functions are now properly called (#2337) (#2338)
• Bumped Electron to 28.2.2

Windows Install

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

MacOS Install

• Download Firebot-v5.61.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: Mac OS does not receive auto-updates

Linux Install

• Download Firebot-v5.61.0-beta3-linux-x64.tar.gz
• ?? will need further instructions

Note: Linux does not receive auto-updates

Release v5.61.0-beta2

v5.61.0-beta2 Changes

Caution

Several advanced variables may now work differently or have been deprecated in this release (e.g. any variables that begin with $array, $object, $raw or $regex). PLEASE test and update your setups accordingly to ensure they work as expected. For a full list of related changes, please see this wiki article

✨ New

• Introducing: Firebot Featured Streams! You may now opt-in to have your stream featured on the Firebot website when you're live. Just go to Settings > General and enable Feature My Stream on Firebot.app
• Custom variables may now be accessed via $$ (e.g. $$myVar is the same as $customVariable[myVar] and $$myVar[path, to, value] is the same as $customVariable[myVar, path.to.value])
• Effect outputs may now be accessed via $& (e.g. $&httpRequest is the same as $effectOutputs[httpRequest] and $&httpRequest[path, to, value] is the same as $effectOutputs[httpRequest, path.to.value])
• Added exact matching for the $arrayFind* variables
• The Evaluate JavaScript effect and $evalJs variable can now access custom variables via firebot.getCustomVariable(varName) and effect outputs via firebot.getEffectOutput(outputName)
• Added --fbuser-data-directory and --fbsecrets-config command line flags

🛠️ Improved

• Clarified the tooltip around storing Twitch clip URLs in a custom variable (#2392)

✅ Fixed

• Fixed an issue with 7TV channel emotes
• Fixed an issue from beta1 where custom commands would not refresh immediately when renamed

v5.61.0-beta1 Update Notes

✨ New

• Firebot's variable processing engine has been overhauled
• The top bar now indicates the status of an active Hype Train (#2087)
• Commands, Channel Rewards, Timers, and Scheduled Effect Lists can be enabled/disabled via tag (#576) (#2342)
• Added an option on the Commands tab to manually clear cooldowns on both individual commands and all commands (#1947)
• Added new $userIsBanned and $userIsTimedOut variables (#2330)
• Added new $pronouns variable (#2187) (#2341)
• Added new $extraLifeInfo, $extraLifeMilestones, $extraLifeDonations, and $extraLifeIncentives variables (#2229) (#2343)
• Added new $arrayRandomItem, $filesInDirectory, $textPadStart, and $textPadEnd variables
• Added new $null, $true and $false variables
• Added default currency option for !steam system command (#2138)
• Added new Before Firebot Closed event (#2332) (#2347)
• Added new Evaluate JavaScript effect and $evalJs variable. These will allow you to run simple, very limited JavaScript functions for advanced processing.

🛠️ Improved

• Command cooldowns are no longer cleared inadvertently in multiple scenarios, including when switching to the Commands tab or when using the Toggle Command effect (#1947)
• We now better handle usernames in several scenarios, including those with Unicode/international characters in their usernames (#2123) (#2131) (#2390)
• Usernames now get updated when users appear in chat after they change their username (#2198)
• The !commands command now allows for custom chat output (#2339)
• The Run Program effect can now read output (#1176)
• Whisper events are no longer cached, meaning they will trigger with each message, just like chat messages
• The known bot list is now loaded when connecting to Twitch if it failed to load previously (#2349)
• The $followCount variable should more consistently return a value (#2368)
• The $subNames variable now includes display names (#2379)
• Firebot now monitors and attempts to resubscribe to any EventSub subscriptions that may have become invalid
• The Log Message effect now has a multiline editor for the message
• Backups created on Windows will now properly restore on non-Windows systems
• Several internal Firebot systems have been refactored/updated (viewer database, command handlers, currency, in-app notifications, backups)

✅ Fixed

• Fixed an issue with Raid event metadata
• Fixed an issue where quick actions may not import correctly from a Firebot setup (#2376)
• Fixed an issue with effect outputs causing an error in Loop Effects effect
• Conditional effects now properly read previous effect outputs
• Fixed an issue where $chatMessage variable does not return the full chat message for a command with a regex trigger (#2394)
• Fixed an issue where variables may unexpectedly return [object Object] (#2323)
• Fixed an issue where HTTP routes registered via custom scripts may erroneously include backslashes

🔗 API Changes

• Added new GET /timers/:timerId/:action API endpoint (#2395) (#2396)
• Custom script parametersUpdated() and stop() functions are now properly called (#2337) (#2338)
• Bumped Electron to 28.2.2

Windows Install

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

MacOS Install

• Download Firebot-v5.61.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.61.0-beta2-linux-x64.tar.gz
• ?? will need further instructions

Note: Linux does not receive auto-updates

Release v5.61.0-beta1

v5.61.0-beta1 Update Notes

Caution

Several advanced variables may now work differently or have been deprecated in this release (e.g. any variables that begin with $array, $object, $raw or $regex). PLEASE test and update your setups accordingly to ensure they work as expected. For a full list of related changes, please see this wiki article

✨ New

• Firebot's variable processing engine has been overhauled
• The top bar now indicates the status of an active Hype Train (#2087)
• Commands, Channel Rewards, Timers, and Scheduled Effect Lists can be enabled/disabled via tag (#576) (#2342)
• Added an option on the Commands tab to manually clear cooldowns on both individual commands and all commands (#1947)
• Added new $userIsBanned and $userIsTimedOut variables (#2330)
• Added new $pronouns variable (#2187) (#2341)
• Added new $extraLifeInfo, $extraLifeMilestones, $extraLifeDonations, and $extraLifeIncentives variables (#2229) (#2343)
• Added new $arrayRandomItem, $filesInDirectory, $textPadStart, and $textPadEnd variables
• Added new $null, $true and $false variables
• Added default currency option for !steam system command (#2138)
• Added new Before Firebot Closed event (#2332) (#2347)
• Added new Evaluate JavaScript effect and $evalJs variable. These will allow you to run simple, very limited JavaScript functions for advanced processing.

🛠️ Improved

• Command cooldowns are no longer cleared inadvertently in multiple scenarios, including when switching to the Commands tab or when using the Toggle Command effect (#1947)
• We now better handle usernames in several scenarios, including those with Unicode/international characters in their usernames (#2123) (#2131) (#2390)
• Usernames now get updated when users appear in chat after they change their username (#2198)
• The !commands command now allows for custom chat output (#2339)
• The Run Program effect can now read output (#1176)
• Whisper events are no longer cached, meaning they will trigger with each message, just like chat messages
• The known bot list is now loaded when connecting to Twitch if it failed to load previously (#2349)
• The $followCount variable should more consistently return a value (#2368)
• The $subNames variable now includes display names (#2379)
• Firebot now monitors and attempts to resubscribe to any EventSub subscriptions that may have become invalid
• The Log Message effect now has a multiline editor for the message
• Backups created on Windows will now properly restore on non-Windows systems
• Several internal Firebot systems have been refactored/updated (viewer database, command handlers, currency, in-app notifications, backups)

✅ Fixed

• Fixed an issue with Raid event metadata
• Fixed an issue where quick actions may not import correctly from a Firebot setup (#2376)
• Fixed an issue with effect outputs causing an error in Loop Effects effect
• Conditional effects now properly read previous effect outputs
• Fixed an issue where $chatMessage variable does not return the full chat message for a command with a regex trigger (#2394)
• Fixed an issue where variables may unexpectedly return [object Object] (#2323)
• Fixed an issue where HTTP routes registered via custom scripts may erroneously include backslashes

🔗 API Changes

• Added new GET /timers/:timerId/:action API endpoint (#2395) (#2396)
• Custom script parametersUpdated() and stop() functions are now properly called (#2337) (#2338)
• Bumped Electron to 28.2.2

Windows Install

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

MacOS Install

• Download Firebot-v5.61.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.61.0-beta1-linux-x64.tar.gz
• ?? will need further instructions

Note: Linux does not receive auto-updates

Release v5.60.1

v5.60.1 Hotfix Notes

✅ Fixed

• Fixed an issue where macOS builds wouldn't open the main Firebot window

v5.60.0 Update Notes

✨ New

• Firebot now uses Twitch's new app login system.

Caution

Please read this wiki article for more information and to know how this will affect you.

• Firebot now supports Twitch's EventSub system! This means we'll be able to add new events and support for newer Twitch features as they light them up for third-party apps.
• The bot account can now receive whispers! This means that viewers can now whisper commands to the bot. (#1583) (#1739)
• The Dashboard chat view now supports Twitch chat threads! Replies now indicate which message they're replying to, plus you can view threads and reply to the them directly from the Dashboard.
• The Dashboard chat feed now supports cheermotes! When someone cheers in your chat, cheermotes will display similar to how they do on Twitch.
• Added support for Hype Trains (#1265)
  • Added new Hype Train Started, Hype Train Progress, and Hype Train Ended events
  • Added new $hypeTrainLevel and $hypeTrainPercent variables
• Added support for Polls (#1750)
  • Added new Create Poll and End Poll effects
  • Added new Channel Poll Started, Channel Poll Progress, and Channel Poll Ended events
  • Added new $pollWinningChoiceName and $pollWinningChoiceVotes variables
• Added support for Predictions (#1580) (#1750)
  • Added new Create Prediction, Lock Prediction, Resolve Prediction, and Cancel Prediction effects
  • Added new Channel Prediction Started, Channel Prediction Progress, Channel Prediction Locked. and Channel Prediction Ended events
  • Added new $predictionWinningOutcomeName variable
• Added support for Twitch Charity Campaigns
  • Added new Charity Campaign Started, Charity Donation, Channel Campaign Progress, and Channel Campaign Ended events
  • Added new $charityName, $charityWebsite, $charityLogo, $charityDescription, $charityCampaignGoal and$charityCampaignTotal variables
  • The $donationFrom and$donationAmount variables now support Twitch charity campaigns
• Added support for Channel Goals
  • Added new Channel Goal Started, Channel Goal Progress, and Channel Goal Ended events
  • Added new $channelGoalType, $channelGoalDescription, $channelGoalCurrentAmount, and $channelGoalTargetAmount variables
• Added new Shoutout Sent and Shoutout Received events
  • Also added new $viewerCount variable for Twitch shoutout events
• Added new Stream Online and Stream Offline events
• Added new Twitch Category Changed and Title Changed events (#2141)
• Added new First Time Chat event. First time chats are also now highlighted in the Dashboard chat view, similar to Twitch.
• Added new Effect Queue Cleared event along with $effectQueueName and $effectQueueId variables (#1610)
• Added new Toggle Scheduled Effect List effect (#2299)
• Commands can now be set to ignore whispers, meaning whispers will not trigger them
• The Dashboard chat view and Activity Feed both now indicate which account (streamer vs. bot) received a whisper
• Whispers can now be hidden in the Dashboard chat view
• Added new $isWhisper and $whisperRecipient variables
• Added the $cheermoteNames, $cheermoteAmounts, $cheermoteUrls, $cheermoteAnimatedUrls, and $cheermoteColors variables for chat message-related events
• Added new $twitchChannelUrl variable (#1776)
• Added new $counterName, $counterPreviousValue, $counterNewValue, $counterChange, $counterMinimum, and $counterMaximum variables that are available on Counter effect lists (update, minimum reached, maximum reached)
• Added new Overlay Connected event and $overlayInstance variable (#1957)
• Added new option in Settings > General to automatically open the Stream Preview window when Firebot launches (#1585)
• System command descriptions can now be edited and those custom descriptions will appear on the streamer's !commands page (#2320)
• The chat output for the Create Stream Marker system command is now editable, similar to other system commands (#2321)
• Added the following new OBS events: (#2209) (#2242)
  • OBS Recording Started
  • OBS Recording Stopped
  • OBS Scene Item Enable State Changed
  • OBS Scene Transition Started
  • OBS Scene Transition Ended
  • OBS Current Scene Transition Changed
  • OBS Current Scene Transition Duration Changed
  • OBS Replay Buffer Saved
  • OBS Current Profile Changed
  • OBS Vendor Event
  • OBS Current Program Scene Changed
  • OBS Current Scene Collection Changed
• Added the following new OBS variables:
  • $obsSceneItemId
  • $obsSceneItemName
  • $obsSceneItemEnabled
  • $obsTransitionName
  • $obsTransitionDuration
  • $obsReplayBufferPath
  • $obsProfileName
  • $obsVendorName
  • $obsVendorEventType
  • $obsVendorEventData

🛠️ Improved

• Several UI elements have been refined and updated
• The Add New Event and Edit Event dialogs can now search for events by name, description, or event source (e.g. Twitch, OBS, etc) (#2300)
• The Twitch Follow event now uses EventSub for realtime, accurate triggering
• The Cheer, Channel Reward Redemption, Ban, Timeout, and Unban events now use EventSub instead of the legacy PubSub system
• The Take OBS Source Screenshot effect can now be configured to take a screenshot of the currently active scene (#2291) (#2292)
• Screenshot-related effects now use a common set of output options, including enhanced options for posting to Discord (#2325)
• The Channel Rewards page now better indicates that a streamer is unable to use rewards if logged in with a non-affiliate/partner account
• Effect outputs now bubble down into effects with nested effect lists (e.g. Conditional Effects, Run Effect List, etc.) (#2273)
• The Discord webhook URL field now supports Guilded URLs and Discord pre-release (e.g. canary) URLs (#1255) (#2314) (#2315)
• OBS effect configuration dialogs now have clearer messaging when the integration may not be fully configured (#2308)
• The following variables can now be used with the Viewer Arrived event: $chatMessageEmoteNames, $chatMessageEmoteUrls, $chatMessageAnimatedEmoteUrls
• When attempting to delete a chat message from the Dashboard, we now show a notification if the message is unable to be deleted
• VIP role updates are now performed using chat message data for better handling of VIP removals (#2142)
• The Chat Message Highlight event and Highlight Message option in the Dashboard have been renamed to Chat Message Spotlight/Spotlight Message to differentiate from Twitch's message highlight channel reward
• Hotkeys now properly support the number pad for the following keys: 0-9, +, -, *, /, and . (#1945)
• Conditional effects now better handle viewer role checks when specifying a variable (e.g. $target) (#2309)
• The Firebot Category Changed event now only triggers when the category has actually changed (#2271)
• Channel rewards that cannot be managed in Firebot now have more detailed messaging and instructions on how to duplicate the reward
• Effects that depend on services being logged in (like Twitch) are now hidden from the Select New Effect dialog when logged out and are shown when logged in without needing to restart Firebot (#2298)
• On dialogs with multiple effect lists (e.g. the Conditional Effect dialog), copied effects can now be immediately pasted to other effect lists without closing/reopening the dialog (#1920)
• Context menu items now better indicate current status of an item (e.g. "Toggle Effect" is now either "Enable Effect" or "Disable Effect") (#2218)
• Buttons in the Backup Manager and the Moderation screen now have better accessibility labeling (#2212) (#2301)
• The $readApi and $rawReadApi variables now include the Firebot user agent string in the request headers (#2267)
• The overlay file:// URL now correctly accounts for Windows vs. Linux/Mac systems
• Internal web server responses now instruct browsers not to cache data, so overlay resources should always retrive the latest version (#1313)
• Overlay page titles notes include the name of the overlay instance for better identification/debugging (#2185)
• Randomly generated numbers now use cryptographically-secure generation
• We've reworked much of our code to fix issues and make it easier to debug and maintain long term.

✅ Fixed

• Twitch global and channel emotes now appear in the emote autocomplete list in the Dashboard
• FIxed an issue where certain 7tv emotes may not display incorrectly in the Dashboard
• Quick Actions now consistently display in the order set by the user (#2318)
• URLs in chat messages in the Dashboard now more consistently behave like hyperlinks
• Chat messages now appear bold in compact mode when streamer is tagged
• Fixed an issue where adding new banned regex words would break the UI (#2146)
• Fixed an issue where events may not fire when no filters are set and the filter mode is set to "Any Filter Passes" (#2306) (#2307)
• First time viewers now get added to the viewer database before relevant events trigger
• Fixed an issue where the $useridname variable may incorrectly return a blank value (#2329)
• Fixed $if incorrectly evaluating parameters
• Chat messages sent by the streamer account now correctly honor the Auto Delete Trigger command setting (#2217)
• Chat replies will now be properly processed/posted when replying to streamer messages sent from Firebot (#2276)
• The {minWager} field in He...