Bug Fixes

• WC-1535: Fixed unable to login to Facebook destination on Windows.
• WC-1527: Fixed a rare crash when starting an RTMP output.

📦 Downloads available at

• https://user.bitfocus.io/download

💵 Donate to the project at

• open collective https://opencollective.com/companion

Companion v4.3.4 - Release Notes

🐞 BUG FIXES

• excessive sorting of entities in add modal
• References to local variables in module actions/feedbacks not being invalidated when control is moved #4192
• use module manifest name field from newer modules #4121
• respect isVisibleExpression for remote surface config fields #4188
• grid size grow prompt for surfaces not dismissing
• importing pagenum buttons show broken page number
• update elgato-stream-deck surface module
• run yarn build for dev modules in docker #4177

Full Changelog: v4.3.3...v4.3.4

📦 Downloads available at

• https://user.bitfocus.io/download

💵 Donate to the project at

• open collective https://opencollective.com/companion

Companion v4.3.3 - Release Notes

🐞 BUG FIXES

• disable --use-system-ca if encountering openssl launch errors
• improve DropdownInputField performance

Full Changelog: v4.3.2...v4.3.3

Bug Fixes

• WC-1518: Fixed unable to broadcast to LinkedIn destination.

📦 Downloads available at

• https://user.bitfocus.io/download

💵 Donate to the project at

• open collective https://opencollective.com/companion

Companion v4.3.2 - Release Notes

🐞 BUG FIXES

• surface locked rotation #4105
• button status icons not showing when topbar hidden #4134
• reword abort action special options #4140
• Limit scope of sidebar context menu (#4151)
• expand sidebar when clicking on toggler (#4136)
• importing config not fixing up some ids #4156
• local-variables in presets should enable persist-value
• warn about upcoming minimum macos
• rework 'loose' dropdown option matching
• upgrading 'set_page' action page number lost 'this page' value
• reword abort action special options
• inconsistent height of settings cards
• inconsistent surface module naming in add list

Full Changelog: v4.3.1...v4.3.2

📦 Downloads available at

• https://user.bitfocus.io/download

💵 Donate to the project at

• open collective https://opencollective.com/companion

Companion v4.3.1 - Release Notes

🐞 BUG FIXES

• update release notes to include section on the sidebar
• canvas crashing on empty png buffers #4107
• ensure processes exit when parent terminates
• unable to change module version when current is invalid
• missing pageNumber for surface plugins #4057
• update elgato-stream-deck
• low contrast in browse-entities table (#4106)
• rotate buttons on locked surfaces #4105
• show description for surface option fields
• restore legacy rotation for stream decks #4105
• field with allowInvalidValues: true should not show error on value preview
• multidropdown should indicate when no more elements can be removed
• handle variable replacement for nested variables in presets
• include rotation in satellite LOCKED-STATE message
• dont repeat manufacturer for modules with many products #4121

Full Changelog: v4.3.0...v4.3.1

📦 Downloads available at

• https://user.bitfocus.io/download

💵 Donate to

the project at

• open collective https://opencollective.com/companion

Companion v4.3.0 - Release Notes

Surface Module System

The biggest change in 4.3 is that surface support is now delivered through a downloadable module system — the same approach already used for connections.

Previously, support for every surface was baked into Companion itself, meaning you needed a full Companion update to get support for a new Stream Deck model or a surface bug fix.

This means:

• New Stream Deck models (and other surfaces) can be supported by updating just the surface module, without waiting for a Companion release.
• Each surface module can be updated independently, so a fix for one device doesn't require touching anything else.
• The same module management UI used for connections applies to surfaces. See the Modules documentation for details.

We hope this will encourage others to add support for new types of surfaces. The development experience is similar to that of connection modules.

Enable and Disable Individual Surfaces

Surfaces can now be individually enabled or disabled from the Surfaces page. Disabling a surface stops Companion from claiming it, but preserves its configuration for when you want to re-enable it.

This is useful when running Companion alongside other software (such as the Elgato Stream Deck app) — you can pick which devices each application manages.

Expressions in Any Action or Feedback Field

The connection module API has had a major revision in this release. The main change is to make it possible for any action or feedback input field to support expressions. Where supported, a toggle button next to the input field lets you switch it into expression mode.

Unfortunately, this requires modules to update to the latest version of the module-api making this opt in. We hope to see many modules start to support this in the coming months — it greatly increases the flexibility of Companion.

Sidebar and Header Bar Improvements

Sidebar.mp4

• Add a help menu in the header bar
• Add a context menu for managing the sidebar
  • Free up space by removing the now-redundant sidebar help section
  • Reduce the number of items in the Variables sidebar group
  • Manage expand/collapse of sidebar groups (Auto-close aka. Accordion Mode)
  • Add a new "Always-Narrow" sidebar mode

Modernising the Elgato Plugin

The Elgato Stream Deck plugin has been updated to support connecting over the Satellite API making it the preferred way for the plugin to connect to Companion.

Previously, the plugin communicated with Companion using an older, Elgato plugin-specific protocol. The Satellite API is a more modern, general-purpose alternative that is already used by the Satellite application and other third party software and hardware. Using it for the plugin means consistent behaviour across all surface types and a simpler integration overall.

If you are currently using the Elgato plugin, you can continue using it as before; however, we intend to remove support for the old protocol in a couple of Companion releases' time. When setting up a new connection, the plugin will now guide you toward using the Satellite API instead.

The plugin has also received a number of UI bug fixes.

And more

• Surfaces are now implemented through a module system, similar to connections.
• Option to enable/disable individual surfaces
  • This allows Companion to run alongside other software with each using just some of the connected stream decks
• Support expressions in any action/feedback field
  • This requires modules to opt into supporting it for now
• Get custom-variable via tcp #3999
• preview local variable value next to editor
• Ability to execute trigger at random intervals
• Improving expressions
  • add URI encode/decode functions #3771
  • Add blink() function to expressions. This can be used in feedbacks to provide customisable blinking behaviour
  • Extended time formatting options
  • Date expression functions (#4021)
• Rework various panels/lists to group connections by collections instead of as a flat list
• Improve performance of some button drawing #3902 #3891
• Various styling refinement
  • Rework button grid presentation
  • Add help icon to header bar
  • improve drag and drop previews
  • Update app icon on macos
  • add collapse/expand all buttons for collection items (#4063)
  • add or update help and close icons in panel headers (#4053)
• Add support for SENTRY_DISABLE environment variable, to disable sentry reporting
• Option to suppress header notifications (#4004)
• Add docker COMPANION_ADMIN_PORT environment variable for admin port configuration (#4042)
• Expand satellite api to cover full module and elgato plugin functionality
• Add HTTP API endpoints for connection management (#4048)

🐞 BUG FIXES

• Improve presentation of missing values in dropdowns
• navigation to anchor link in /user-guide (#4036)
• Local variable updates do not immediately apply #3953
• show modules which only have prerelease version in the add list
• upgrade scripts isInverted failing
• certain triggers not being disabled with the collection (#3981)
• respect multiline for connection config fields #3986
• connection collections being lost during full import
• udp service not listening when ipv6 enabled
• preserve type of expressions when writing to custom/local variables #3954
• child entities not being upgraded #3924
• improve confusing trigger terminology "depress" (#3922)
• ensure module manifest doesn't load root file from outside of package
• Launch main companion process with the --use-system-ca flag (#4060)

Full Changelog: v4.2.6...v4.3.0

📦 Downloads available at

• https://user.bitfocus.io/download

💵 Donate to the project at

• open collective https://opencollective.com/companion

Companion v4.2.6 - Release Notes

• stream deck + xl not working on windows
• unable to export some pages
• run upgrade scripts for disabled actions/feedbacks
• prevent prototype pollution in expressions

Full Changelog: v4.2.5...v4.2.6

Bug Fixes

• WC-1488: Fixed unable to authenticate with the YouTube destination in Output Settings.
• WC-1468: Fixed a bug that prevented several Elgato devices from appearing in the Add Source menu.
• WC-1439: Fixed certain serial licenses do not display the license tab in Preferences. This prevented users from deactivating their licenses.
• WC-1431: Fixed the countdown clock gets stuck at 00:00 on Windows.
• WC-1400: Fixed Black Duck.
• WC-1392: Fixed Multistream sessions cannot be created when opening Wirecast documents quickly.
• WC-1179: Updated the minimum macOS version to 14.0.
• WC-1047: Fixed an outdated dialog when the subscription expires.
• WC-1038: Fixed the Facebook Speed Test.

📦 Downloads available at

• https://user.bitfocus.io/download

💵 Donate to the project at

• open collective https://opencollective.com/companion

Companion v4.2.5 - Release Notes

• support stream deck + xl
• improve import resiliency/performance for large configs
• ux issues in the expression editor
• better respect collections when ordering connections
• incorrect urls into module docs
• suppress some unnecessary errors
• allow connection configs to use multiline input fields

Full Changelog: v4.2.4...v4.2.5

Bug Fixes

• WC-1488: Fixed unable to authenticate with the YouTube destination in Output Settings.
• WC-1468: Fixed a bug that prevented several Elgato devices from appearing in the Add Source menu.
• WC-1439: Fixed certain serial licenses do not display the license tab in Preferences. This prevented users from deactivating their licenses.
• WC-1431: Fixed the countdown clock gets stuck at 00:00 on Windows.
• WC-1400: Fixed Black Duck.
• WC-1392: Fixed Multistream sessions cannot be created when opening Wirecast documents quickly.
• WC-1179: Updated the minimum macOS version to 14.0.
• WC-1047: Fixed an outdated dialog when the subscription expires.
• WC-1038: Fixed the Facebook Speed Test.

📦 Downloads available at

• https://user.bitfocus.io/download

💵 Donate to the project at

• open collective https://opencollective.com/companion

Companion v4.2.4 - Release Notes

🐞 BUG FIXES

• support corsair galleon k100 sd
• add SENTRY_DISABLE env var to disable sentry integration
• fix: unable to clear local variable name
• fix: reduce monaco suggest-details line-spacing (#3948)
• fix: improve presentation of missing values in dropdowns
• fix: surface table stretching
• fix: 'internal: User Value' feedback field order refinement
• fix: added TMPDIR to preserved env vars list (#3929)
• fix: attempt to suppress mirabox stream dock error flood
• fix: disable sentry http session tracking

Full Changelog: v4.2.3...v4.2.4

📦 Downloads available at

• https://user.bitfocus.io/download

💵 Donate to the project at

• open collective https://opencollective.com/companion

Companion v4.2.3 - Release Notes

🐞 BUG FIXES

• local variables not invalidating module entities #3896
• expression arrayLastIndexOf not working if no offset provided #3873
• drag and drop previews showing more than the dragged element #3883
• avoid invalid values being sent to a surface when referencing old jog/tbar variables (#3872)
• improve scrolling behaviour of surfaces page
• variables dropdown showing behind heading in settings
• make connected network docks stick below the active surfaces in the list
• respect DISABLE_IPV6 env var to disable admin interface binding to ipv6
• respect collections when sorting connections for add entity dropdowns and variables page #3899
• only report usage stats for published modules

Full Changelog: v4.2.2...v4.2.3

📦 Downloads available at

• https://user.bitfocus.io/download

💵 Donate to the project at

• open collective https://opencollective.com/companion

Companion v4.2.2 - Release Notes

🐞 BUG FIXES

• add keepalive interval for client websocket
• improve emulator behaviour when websocket closes
• revert: limit environment variables exposed to internal actions
• only search labels in dropdown fields
• unable to edit color inputs as hex
• bluetooth support for blackmagic controllers
• open help links in a new windows
• isVisibleExpression clone error
• loupedeck ct bad key map
• sidebar dom issues
• better suppress some common/excessive errors

Full Changelog: v4.2.1...v4.2.2

📦 Downloads available at

• https://user.bitfocus.io/download

💵 Donate to the project at

• open collective https://opencollective.com/companion

Companion v4.2.1 - Release Notes

🐞 BUG FIXES

• crash at launch on linux arm64 #3826
• docs search urls incorrect #3824
• expression variables not updating in ui #3825
• emulator not showing pincode entry #3827
• toggling never lock for surface not applying
• support ajaz akp153 #3840
• preserve additional environment variables for modules
• limit environment variables exposed to internal actions
• preserve sqlite wal when upgrading config #3835

Full Changelog: v4.2.0...v4.2.1

📦 Downloads available at

• https://user.bitfocus.io/download

💵 Donate to the project at

• open collective https://opencollective.com/companion

Companion v4.2.0 - Release Notes

This is a slightly smaller release than usual, focussing more on smaller improvements.

End of support for macOS 11

This version of Companion requires macOS 12 or later

Rebuilt Documentation

The Companion User Guide has been rewritten to use a new rendering system.

This allows us to host a new publicly available version of the documentation online which is versioned per release, as well as building it in a simplified form within Companion

The new tools allow us to do more with the documentation and will make it easier for us to keep up to date too!

Improved Expression Editor

The expression editor input field has been rebuilt, making it easier to use with functionality you would expect from a code editor. This includes functions and keyword suggestions, and better handling of multi-line expressions.

And more

• The old xkeys $(internal:tbar) and similar variables have been removed, and they should now be bound to custom variables in the config of each surface (#3716)
• Require macos 12
• Convert docs to docusaurus (#3741)
• Rebuild emulator pincode locking
• Add options to to restrict page access (#3736)
• Enhanced expressions:
  • Improved expression editor (#3713)
  • More formatting for timestamp (#3668)
  • Handle negative value in msToTimestamp (#3651)
  • Support local variables in step expressions #3762
  • Expressions better handle undefined. add getVariable method #3451 (#3715)
• Refined connection management:
  • Reworked connection config layout #3559 (#3569)
  • Rework changing connection versions, to remove need to disable module first
  • Add delete button to connection edit panel
  • Allow changing connection enabled state from config panel
  • Indicate connections missing modules in sidebar
• Surface improvements:
  • Merge surface remote and discover pages (#3677)
  • Support resolve speed editor #3525
  • Support more variants of Mirabox 293S
  • Support for Mirabox Streamdock N3 (#3686)
  • Add repeating button-presses to contour-shuttle shuttle ring (#3492)
  • Improve vec-footpedal surface implementation
  • Support complex surface layouts over satellite api (#3611)
  • Support swipe to change page on Stream Deck + (#3721)
  • Support touch strip variables for Loupedeck Live (#3790)
• Draw button 'error' state as a red warning triangle (#3675)
• Remove deprecated bank field from tcp bank_bg_change message #2779
• Include timestamps and source in module debug logs
• Add version number variables #3714
• Rework update check api, improving reliability

🐞 BUG FIXES

• ember+ api issues with some clients
• limit env vars passed to modules
• improve error handling for module executeAction
• "Sentry DSN not located" error in launcher (#3758)
• Align the display name of surface_set_position with the UI terminology (#3761)
• Avoid flooding modules with large objects, batch entity updates to resolve issues with large configs
• preserve original types of custom variable values from osc and ember+ apis
• improve version number handling for release vs beta builds
• Page up button/Page down button don't set page-history (#3683)
• Reduce frequency of pincode lock state logging (#3792)
• Loupedeck Live pincode lock layout

Full Changelog: v4.1.6...v4.2.0

📦 Downloads available at

• https://user.bitfocus.io/download

💵 Donate to the project at

• open collective https://opencollective.com/companion

Companion v4.1.6 - Release Notes

🐞 BUG FIXES

• Setting local variables for another control failing #3813
• Unable to select module beta version for connection #3815
• Suppress some logged errors about local variable names
• Avoid spamming log with surface lock state messages #3792

Full Changelog: v4.1.5...v4.1.6

📦 Downloads available at

• https://user.bitfocus.io/download

💵 Donate to the project at

• open collective https://opencollective.com/companion

Companion v4.1.5 - Release Notes

🐞 BUG FIXES

• reordering pages not persisting #3727
• Local variable actions not working on triggers #3788
• support stream deck mini (discord edition) #3778
• elgato plugin not handling multiple clients correctly #3775
• elgato plugin not cleaning up on connection close #3767
• suppress module SecurityWarnings in a better way

Full Changelog: v4.1.4...v4.1.5

Bug Fixes

• WC-1309: Fixed a hang when deleting assets from Asset Manager.
• WC-1307: Fixed unable to mute user’s microphone in a Zoom Meeting.
• WC-1299/1290: Fixed a rare crash when starting an output.
• WC-1254: Fixed a rare crash when opening the Stock Media Library.
• WC-1248/1226/1222/1134/812: Fixed an issue where users on certain networks could not stream to Facebook.
• WC-1245: Fixed an audio issue with sources that produce 24 kHz audio.
• WC-1230: Fixed Zoom Panelist audio disappears when the Panelist leaves then re-joins the Webinar.
• WC-1214: Fixed Stock Media Library shows nothing after entering a search query, then erasing it.
• WC-1200/934/612/565: Fixed flickering issues when using Video Filters, especially with the Multi-Viewer enabled.
• WC-1176: Fixed user needs to refresh connection to PTZ cameras when opening a saved document.
• WC-1119: Fixed an issue where the clock overlay would get ahead of the system clock.
• WC-928: Fixed an issue that caused Gatekeeper to block Wirecast from launching on some macOS systems.
• WC-702: Fixed an issue where Wirecast did not recognize anonymous Zoom guests.
• WC-673: Fixed applying a virtual PTZ or Background Removal filter to an SRT source causes the source to drop frames on Windows with D3D12.
• WC-670: Fixed an issue where Zoom shots would not reconnect after reconnecting to the internet.
• WC-511: Fixed an issue where the Virtual Camera did not show up in the list of video sources for certain third-party apps on macOS.

Bug Fixes

• WC-1151 / 1130 / 1125: Fixed issues with connecting to destinations that require Adobe authentication. This fixes connecting to ChurchStreaming.tv, AWS and Wowza servers that require Adobe authentication among others.
• WC-1138: Fixed several crashes with certain audio devices that use unsupported sample rates on macOS. The minimum supported sample rate is 8 kHz, and the maximum is 192 kHz for System Devices.
• WC-1136: Fixed hold behavior when playing media files.
• WC-934: Fixed issue with single frame of black video during a media file loop or transitioning between different media files.

Bug Fixes

• WC-1068: Fixed a rare crash at startup.
• WC-1049: Remove use of “Not Configured” as the default destination name.
• WC-1046: Fixed cannot connect to Teams using RTMPS.
• WC-951: Fixed a rare crash on Windows.
• WC-939: Show a better error message when the user cannot stream to a Facebook page due to restrictions.
• WC-206: Improve playback of SRT sources when timestamps are out of order.

Bug Fixes

• WC-1042: Fixed audio distortions with certain audio sources on Windows.
• WC-1026: Fixed an issue with Multistream where destinations were reporting a disconnection when there was no disconnection.
• WC-1020: Give better error messages when a user attempts to use Multistream and there are too many active sessions with the account.
• WC-1017: Add Multistream status button to server timeout page in Output Settings.
• WC-1000: Enable LinkedIn destination with Multistream.
• WC-793: Fixed translations missing for Multistream service.
• WC-787: Fixed Multicast/Unicast outputs.

Features and Improvements:

• Wirecast Cloud Multistream (Beta): Stream to multiple destinations while only using the resources of one stream! Currently supporting 2 destinations.
• Facebook API v19 Update
• NDI SDK 6.0 Update
• WC-167: Improved SRT source logging when the peer rejects the connection. For example, give a specific error when the peer rejects the password.

Bug Fixes

• WC-972: Fixed a rare crash when adding media files to a document.
• WC-844: Fixed Rendezvous audio output selector applies wrong selection.
• WC-727: Fixed rendering issue with certain custom scoreboard PNG sources.
• WC-726: Fixed Facebook Business pages do not appear in the Pages drop-down list.
• WC-662: Move macOS EULA into application.
• WC-508: Fixed UI issues in Video Filters.

📦 Downloads available at

• https://user.bitfocus.io/download

💵 Donate to the project at

• open collective https://opencollective.com/companion

Companion v4.1.4 - Release Notes

🐞 BUG FIXES

• Expression variables not getting value immediately following import
• Import page not scrolling correctly
• Import single page unable to create new page
• Unable to select any file to import on iOs #3676
• Surfaces not remembering state when using lockout all
• Failures when installing modules not being displayed
• Missing tooltips in module versions table
• Surfaces table upgrade icon position
• Allow larger module archives
• Fix some links within the getting started docs #3720
• Performance improvements for module entity events

Full Changelog: v4.1.3...v4.1.4

📦 Downloads available at

• https://user.bitfocus.io/download

💵 Donate to the project at

• open collective https://opencollective.com/companion

Companion v4.1.3 - Release Notes

🐞 BUG FIXES

• Crash at startup when checking instance statuses

Full Changelog: v4.1.2...v4.1.3

📦 Downloads available at

• https://user.bitfocus.io/download

💵 Donate to the project at

• open collective https://opencollective.com/companion

Companion v4.1.2 - Release Notes

🐞 BUG FIXES

• surface import/export errors with last_page_id or name #3650
• stream deck mini not working with network dock #3682
• don't assign elgato network dock an index in the surfaces table
• very old contour shuttle pro v1 has an XKey vendor ID (#3658)
• Template literal parsing in some expressions has unbound recursion #3655
• disabled module count incorrect at startup #3679
• connection status variables showing empty instead of disabled at startup #3652
• Surface Groups should always show "Current Page" (#3685)
• hide deprecated modules from add panel if no versions are installed #3684
• Preset previewStyle is overridden by feedback (#3673)
• ensure invalid version doesnt crash connections page
• ios safari downloading exports with bad extension #3676
• ensure modules being installed look like connections
• ember+ api not including custom variables (#3681)

Full Changelog: v4.1.1...v4.1.2

Bug Fixes

• WC-1309: Fixed a hang when deleting assets from Asset Manager.
• WC-1307: Fixed unable to mute user’s microphone in a Zoom Meeting.
• WC-1299/1290: Fixed a rare crash when starting an output.
• WC-1254: Fixed a rare crash when opening the Stock Media Library.
• WC-1248/1226/1222/1134/812: Fixed an issue where users on certain networks could not stream to Facebook.
• WC-1245: Fixed an audio issue with sources that produce 24 kHz audio.
• WC-1230: Fixed Zoom Panelist audio disappears when the Panelist leaves then re-joins the Webinar.
• WC-1214: Fixed Stock Media Library shows nothing after entering a search query, then erasing it.
• WC-1200/934/612/565: Fixed flickering issues when using Video Filters, especially with the Multi-Viewer enabled.
• WC-1176: Fixed user needs to refresh connection to PTZ cameras when opening a saved document.
• WC-1119: Fixed an issue where the clock overlay would get ahead of the system clock.
• WC-928: Fixed an issue that caused Gatekeeper to block Wirecast from launching on some macOS systems.
• WC-702: Fixed an issue where Wirecast did not recognize anonymous Zoom guests.
• WC-673: Fixed applying a virtual PTZ or Background Removal filter to an SRT source causes the source to drop frames on Windows with D3D12.
• WC-670: Fixed an issue where Zoom shots would not reconnect after reconnecting to the internet.
• WC-511: Fixed an issue where the Virtual Camera did not show up in the list of video sources for certain third-party apps on macOS.

📦 Downloads available at

• https://user.bitfocus.io/download

💵 Donate to the project at

• open collective https://opencollective.com/companion

Companion v4.1.1 - Release Notes

🐞 BUG FIXES

• Version warning showing in the header
• Pages not being deleted properly during reset
• Partial import resetting unexpected portions of the system #3625 #3639
• Unable to drag some collections around
• Unexpected error logged when aborting an internal: Wait action #3645
• UI not loading in older Chromium (~121)
• Ember+ api reporting hidden variables #3646
• DEBUG-INSPECT not working for all modules

Full Changelog: v4.1.0...v4.1.1

📦 Downloads available at

• https://user.bitfocus.io/download

💵 Donate to the project at

• open collective https://opencollective.com/companion

Companion v4.1.0 - Release Notes

Ending support for macOS 11

This is the last version of Companion to support macOS 11. Starting with Companion 4.2 you will need to be running macOS 12 or later.

UI improvements

This release focuses on polishing the UI.

A major addition is "collections" — a way to group connections, triggers, or custom variables so you can manage or enable/disable them together. Collections make organising complex setups and toggling related items during events much easier.

We also made a number of small adjustments to improve clarity and flow, such as reworking table layouts in many places.

These changes prioritise organisation and usability so you can work more quickly.

Local variables

On each button or trigger you can now define local variables. These variables are scoped to that single button or trigger — they do not exist outside of it. Local variables can be configured in a few ways:

• Work like custom variables (can hold a static value and be changed by actions).
• Be expression-driven (value is the result of an expression evaluated when needed).
• Take the value of a feedback.

A key point: not all actions and feedbacks support local variables. Supported items will show a globe icon to indicate compatibility. We're working to broaden support; modules will add compatibility over time and further improvements are planned for 4.2.

Improving support for expressions

Expressions let you build more complex configurations and transform data flowing into or out of connections. They allow you to normalise, combine, or conditionally modify values before they're consumed or sent.

The new Expression Variables page lets you define variables computed from expressions. These can be referenced wherever connection or custom variables are accepted; their value is calculated from the expression you provide.

Expression variables can:

• Return a computed value from an expression.
• Depend on other variables, feedbacks, connection state, or local variables defined on a button/trigger (so you can break complex logic into sub-expressions or take input from feedbacks).
• Be used anywhere standard variables are used (actions, feedbacks, connection fields, etc.).

Notes:

• Circular dependencies between variables are possible but discouraged; they will be rate-limited and can incur a notable performance cost.

Custom backup rules

Companion now supports custom backup rules, allowing you to schedule backups, and keep more restore points.

You can pick how often to run, where to store them, choose how many to keep (auto-pruned), and select the file format.

Tip: Saving backups to a synced folder (Dropbox, OneDrive, or similar), automatically keeps an off-site copy — great for extra safety and easy access across machines.

And more

• Various UX improvements
  • Connections, triggers and custom variables can be added to 'collections' for grouping
  • Connections and triggers can be enabled/disabled by their collections
  • Connections, triggers and surfaces tables have had their contents rearranged to flow more naturally
  • Surfaces has been reworked to utilise a right panel for the selected surface.
  • Any right hand panels of pages have been refined
  • Version number has moved into the sidebar instead of header
  • Improve clarity of beta module versions
  • Layout improvements of some pages on mobile
  • Indicate whether custom-variable value is valid while typing
  • Improved layout of the launcher window, including a new settings window
  • Add filter/search to triggers page
  • Improved import page
  • Improve emulator list page
• Added Expression Variables. Similar to Custom Variables, but their value is the result of an expression that executes when needed.
• Add new 'while loop' action
• Ability to define 'local variables' on buttons and triggers.
  • Not all actions or feedbacks support these, this will improve over time
• Additional expression functions
  • arrayIndexOf & arrayLastIndexOf
• Button step can be driven from an expression
• Multiple connections from the Elgato Stream Deck software are now supported.
• Support for Logitech MX Creative Console (buttons, not wheel)
• Support for MiraBox HSV293S
• Importing configs can be performed more granularly, without needing to reset everything
• Variables for installation name
• Expansion of the Ember+ api
  • Expose variables
  • Allow setting custom-variable values
  • Expose action recorder
• Support for 'secret' field types in connection config
• Attempt to keep screen awake in emulator/tablet views
• Support for defining custom backup rules
• Syslog support for logging
• Improve docker image command syntax
• UI can be hosted under a subpath when behind a reverse proxy
• Replace the library used for communication with the UI
  • This improves the type safety and code quality of this api and makes it easier for us to work with.
  • There should be no notable impact to users

🐞 BUG FIXES

• Surface page settings not being persisted correctly in exports
• Load PNG button not always accepting files
• Help tooltips not always showing
• Some internal actions incorrectly claiming to support expressions
• Some dropdown fields not updating their options when expected
• Duplicating triggers first execution incorrect
• Improve drag and drop behaviour in action/feedback lists
• Sanitise page ids at startup, to ensure the config is sane
• Better handling when no compatible versions of a module are available to be installed

Full Changelog: v4.0.3...v4.1.0

📦 Downloads available at

• https://user.bitfocus.io/download

💵 Donate to the project at

• open collective https://opencollective.com/companion

Companion v4.0.3 - Release Notes

🐞 BUG FIXES

• Button step feedbacks not reactive to variables #3531
• Validate module version number before installing or loading
• Checkboes jumping in safari (#3548)
• Variables page not scrolling #3544
• Stream Deck Network Dock not allowing backlight brightness control
• Add slider to surface brightness field
• Some module static-text values being interpreted as code blocks #3540
• Fix connections being called with feedbacks of other connections
• Unable to run with companion config on windows network shares #3510

Full Changelog: v4.0.2...v4.0.3