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:
- 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