SuperMacro - Advanced keystroke macros triggered by the Elgato Stream Deck

Author's website and contact information: https://barraider.com

New in v2.0

• New Capture keystroke feature allows to record the Key Strokes instead of manually typing them into the textbox.
• New {{SetClipboard}} command will set the value of a string or variable into the clipboard
• New Functions:
  • LEN - Returns the length of the string/variable
  • MID - Returns a substring from the current string/variable
  • INDEXOF - Returns the first 0-based position of a text in the string. Example: FUNC:INDEXOF:RES:Hello:e will return 1 into RES
  • REVERSE - Reverses the string/variable

New in v1.9

• Added variable support for VARSETFROMFILE and OUTPUTTOFILE
• MouseXY and MouseMove commands now support both a comma and a colon between the X and Y values (for better consistency with other commands) {{MOUSEXY:$VarX:$VarY}}
• Length of the long-press in SuperMacro action is now customizable
• Keystroke PTT now has a Run Once option, to only run the command a single time
• You can now control the output frequency of the Keystroke PTT using the delay slider
• {{MSCROLLUP}} and {{MSCROLLDOWN}} now support an optional number of clicks to scroll. (See example 13 below)
• {{MOUSEXY}} now supports variables for moving the mouse (see example 14 below)
• {{MSAVEPOS}} now stores the values in variables $MOUSE_X and $MOUSE_Y
• New REPLACE function allows replacing parts of a variable/string (see usage in Functions section and example 15 below)
• New NOW function allows to get the current date and time and format it (see example 16 below)
• Added link to documentation inside the settings
• Fixed issue with Output command messing up text

New in v1.8

• 🆕 FUNCTIONS Support!
  • RANDOM function allows choosing a random number in a customized range
  • ADD/SUB/MUL/DIV allow to Add, Subtract, Multiply and Divide numbers
  • CONCAT function allows to concatenate multiple strings/variables into one
• Comments support: Type {{//}} and everything after it will be ignored, until the end of the line.
• New {{SetKeyTitle}} command to dynamically change the title of the Stream Deck button. See {{SETKEYTITLE}} command below.
• New {{OutputToFile}} command to store contents of a variable to file. See {{OUTPUTTOFILE}} command below.
• New {{VarSetFromClipboard}} command to set a variable with the clipboard contents. See {{VARSETFROMCLIPBOARD}} command below.
• New Mouse Location action shows you the current mouse coordinates, to be used with the MouseXY command.
• SuperMacro Toggle can now be set to remember the toggle state even when switching profiles or restarting the Stream Deck :pogchamp:
• SuperMacro PTT action now supports sending a specific keystroke when key is released
• SuperMacro PTT and StickyKeypress action now support a customizable delay (pause) between every execution.
• {{INPUT}} Command now remembers the previous value and autofills it in the popup window

New in v1.7

• 🆕 Loops Support!
  • Sticky SuperMacro and Sticky Keystroke both support loops! Use the Auto Stop After N Rounds to create loops which will run a customizable amount of times.
• New Variable Commands!
  • {{VarSet}} - Use {{VARSET:VarName:Value}} to set the value Value into VarName. You can then use {{OUTPUT:VarName}} to display it
  • {{VarSetFromFile}} - Use {{VARSETFROMFILE:VarName:c:\myfile.txt}} to read myfile.txt and store its contents into VarName. You can then use {{OUTPUT:VarName}} to display it
  • {{VarUnset}} - Use {{VARUNSET:VarName}} to clear VarName
  • {{VarUnsetAll}} - Clears all variables. Usage: {{VARUNSETALL}}
• Full support for Numpad buttons! Added a bunch of new commands to differentiate between Numpad buttons and their non-Numpad variation (Arrows, Home, End, ...). See full list below
• Storing/Restore mouse position. Use {{MSAVEPOS}} to store the current mouse position. Later use {{MLOADPOS}} to move the mouse back to that position
• Mouse Double-Clicks:
  • Left Double Click now uses the {{MLEFTDBLCLICK}} command.
  • Right Double Click now uses the {{MRIGHTDBLCLICK}} command.
• MouseXY command which is superseding the MousePos command. Use it to move the mouse cursor to a specific place on your desktop. Use together with the new Mouse Location action to quickly determine the coordinates you want.
• Support for mouse Button 4 and Button 5 - Use {{XBUTTON1}} for Button 4 click. Use {{XBUTTON2}} for Button 5 click.
• New Let macro complete on stop option available for Sticky SuperMacro. Will ensure the macro completes fully when the button is pressed

Current functionality

5 Plugins built into one:

Super Macro

This is the basic implementation. Create a macro and run it on keypress. Examples can be seen in the Usage Examples section below.

Super Macro Toggle

Toggle between two different macros.

Sticky Super Macro

Click once to enable, the macro will run again and again until the button is pressed again

Keystroke PTT

This action limits the action to either one command (such as {{ctrl}{c}}) or one character. The command will be run again and again as long as you continue to press the key.

Sticky Keystroke

This action limits the action to either one command (such as {{ctrl}{c}}) or one character. The command will be run again and again until the button is pressed again.

How do I get started using it?

SuperMacro knows to deal with both Commands and normal text. A command is either one special key (like F5 or Winkey) or a keystroke (like Ctrl-C). A command is always enclosed in {} and each individual key in the command is also inclosed in {} so you should always see two {{ at the beginning and two }} at the end. For instance: {{f5}} or {{ctrl}{c}}

Usage Examples

1. Open Windows Explorer and got to C:\Program Files
   Note: Delay should be ~20 ms

{{win}{e}}{{pause:400}}{{alt}{d}}c:\Program Files\{{enter}}

2. Open notepad and play with the settings
   Note: Delay should be ~20 ms
   Note2: This will not work correctly if your Windows (and notepad) are not in English

{{win}{r}}{{pause:500}}notepad.exe{{enter}}{{pause:1000}}Ok... Let's see what this plugin can do...{{alt}{f}}{{right}}{{PAUSE:400}}{{right}}{{PAUSE:400}}f{{pause:400}}times{{down}}{{PAUSE:400}}{{tab}}{{PAUSE:400}}{{down}}{{PAUSE:400}}{{down}}{{PAUSE:400}}{{ENTER}}{{ENTER}}For more information visit: https://barider.g1thubio{{ctrl}{shift}{left}}{{PAUSE:400}}https://barraider.github.io{{ENTER}}{{alt}{o}}f{{PAUSE:100}}Lucida Console{{tab}}Regular{{Tab}}12{{ENTER}}

3. Calculate something
   Note: Delay should be ~20 ms

{{win}{r}}{{pause:300}}calc{{enter}}{{pause:1000}}1*2*3*4*5=

4. Move the mouse to a certain position on the screen, then press Double-Click left mouse button.
   Note: To find the correct position you can use the Mouse Location action.

{{MOUSEXY:1000,15}}{{MLEFTDBLCLICK}}

5. Move the mouse by 10 pixels left and 20 pixels down on every press

{{MOUSEMOVE:-10,20}}

6. Variables: Get input from user and then use it later on.

{{INPUT:Name}}Hello {{OUTPUT:Name}}, Nice to meet you!

7. Variables: Read text from file into MyVar variable

{{VarSetFromFile:MyVar:C:\filename.txt}}

8. Functions: Choose a random number between 1 (inclusive) to 10 (exclusive) and store it in MyVar:

{{FUNC:RANDOM:MyVar:1:10}}

9. Functions: Input 2 numbers from the user. Choose a random number between firstNum variable (inclusive) to secondNum variable (exclusive) and store it in MyVar:

{{INPUT:firstNum}}
{{INPUT:secondNum}}
{{FUNC:RANDOM:MyVar:$firstNum:$secondNum}}

10. Functions: Select a number from the user and multiply it by 10. Then save it to a file named c:\temp\result.txt:

{{INPUT:myNumber}}
{{FUNC:MUL:MyResult:$myNumber:10}}
{{OUTPUTTOFILE:MyResult:c:\temp\result.txt}}

11. Add comments in the code using {{//}} command

{{INPUT:myNumber}} {{//}} Input a number from the user
{{FUNC:MUL:MyResult:$myNumber:10}} {{//}} Multiply number by 10
{{OUTPUTTOFILE:MyResult:c:\temp\result.txt}} {{//}} Save result in file

12. Read text from a file and show it on the Stream Deck Key:

{{VARSETFROMFILE:MyVar:c:\counter.txt}}
{{SETKEYTITLE:$MyVar}}

13. Read text from a clipboard and show it on the Stream Deck Key:

{{VARSETFROMCLIPBOARD:MyVar}}
{{SETKEYTITLE:$MyVar}}

14. Scroll the mouse up by 5 clicks and then down by 3 clicks:

{{MSCROLLUP:5}}
{{MSCROLLDOWN:3}}

15. Move the mouse to coordinates set from variables:

{{VARSET:X:100}}
{{VARSET:Y:400}}
{{MOUSEXY:$X,$Y}}

16. Repalce all "l"'s with "Z"'s in the string Hello World and show it on key

{{VARSET:XX:Hello World}}
{{VARSET:A:l}}
{{VARSET:B:Z}}
{{FUNC:REPLACE:MyVar:$XX:$A:$B}}
{{SETKEYTITLE:$MyVar}}

17. Show the current date and time on the key:

{{FUNC:NOW:MyVar:yyyy-MM-dd 
HH:mm:ss}}
{{SETKEYTITLE:$MyVar}}

18. Set value of variable into the clipboard

{{VARSET:MyVar:Hello World}}
{{SETCLIPBOARD:$MyVar}}

*** More commands below ***

Download

• Download plugin

I found a bug, who do I contact?

For support please contact the developer. Contact information is available at https://barraider.com

I have a feature request, who do I contact?

Please contact the developer. Contact information is available at https://barraider.com

Dependencies

• Uses StreamDeck-Tools by BarRaider:
• Uses Easy-PI by BarRaider - Provides seamless integration with the Stream Deck PI (Property Inspector)

List of supported keystroke commands

Advanced Commands

Note: Use a : between the command name and the arguments

Functions

Syntax:

{{FUNC:NameOfFunction:OutputVariable:InputParam1:InputParam2:InputParam3...}}

Where 'InputParamX' can either be text (10) or another variable ($MyVar)

Mouse Commands