With this action, you can configure background scripts that are always active regardless of which page or profile you have loaded.
This action does NOT need to be loaded for the scripts to be active. You can load this action when you need to configure background scripts and remove it when you're done.
The scripts run in the background, and the primary usage is to have translation scripts that receive commands from buttons or dials,
translate them to other commands and send them to the daw (and vice versa).
Some "Plugin-Internal" midi ports are available for usage with the background scripts.
These ports are not visible outside the plugin; they can only be used to communicate between actions within the plugin.
Since the scripts run in the background, they have no direct contact with buttons or dials.
They cannot react on (press) or (release) events, and they cannot execute {image}, {text} or {state} actions.
Number of plugin-internal ports:
Save Interval
seconds
Max age
hours
Info
Info
If Midi state restore is enabled, the plugin will save the state for all sent and received Midi commands to a file on disk.
When the plugin is later restarted, the file will be read, and the state for all buttons and dials will be set the same as when the plugin was shut down.
If Midi state restore is disabled, all buttons and dials will be initialized with the value 0 when the plugin starts.
"Plugin start" means when the plugin is initially started by rebooting the computer or restarting the Stream Deck software.
Profile or page switches do not affect the plugin's background store of the midi state.
The "Save Interval" property defines how often (in seconds) the midi state is saved to disk. The saved file may be large, and I see no reason to have real-time or close to real-time updates.
The default value once every 60 seconds seems reasonable but can be changed if needed. Disk saves are only performed if there has been any midi activity since the last save.
The "Max Age" property defines the maximum age (in hours) of Midi events that will be restored at the plugin's start.
The default value of 24 hours means that only Midi events created in the last 24 hours will be restored during the plugin's start.
If the computer has been shut down for longer, the saved Midi state may be irrelevant.
Tip: To change the order of the devices, click and hold a header, and drag and drop it where you want it.
Global ports behavior in dropdowns
Info
Info
Global ports enable swift and straightforward adjustments to ports that simultaneously impact many buttons and dials.
Instead of specifying a unique port for each button and dial, you can define a global port and then reference that port from buttons and dials.
When you need to change the port, you do so for the global port, and the change will immediately apply to all buttons and dials that refer to it.
In the port lists for other buttons and dials, the global ports will be prefixed with "GP" and an ordinal number, along with the name of the port currently assigned to the global port.
Before version 4.2, variables could only store strings or integers (classic mode).
Starting with version 4.2, variables can also hold floating-point numbers (extended mode).
This change could cause existing scripts to malfunction because the storage format has changed.
To avoid unexpected problems, you need to enable support for floating-point variables manually.
Variables work as before version 4.2 storing strings and integers only, and existing scripts will run unaffected.
If you do not explicitly need floating-point variables,
you can safely continue without enabling floating-point.
If you need variables to store both floating point numbers, strings, and integers, choose this option.
Please note that when switching between variable modes, some existing variables might not automatically update their
types and could still have the wrong type. The most reliable way to ensure all variables have the correct type is to
delete all variables and run the scripts to recreate them from scratch.
The plugin has internal settings that typically don't require adjustment.
These settings can be configured using keywords entered in this text field.
Generally, keywords are shared on a need-to-know basis or published on the website if it makes sense to share them with advanced users.
Keywords are not case-sensitive and should be entered either as comma-separated or on separate lines.
Help and logging
Help
Log
Enable extended logging
Log ID
When you click "upload log", both the plugin log file and the Stream Deck log file will be uploaded to the plugin server.
The upload will receive an ID in this format: e10e5eb2-0df2-4104-9bfa-acddda7db364
This ID is essential for linking your upload to your bug report or whatever the reason for the upload was.
Once the files are successfully uploaded, the ID will be displayed in the editor.
Please include this ID in your bug report.
Right-click the ID field to copy the ID to the clipboard.