User Tools

Site Tools


manual:Plug_In_Actions

Plug In Actions

You can develop custom Macro Actions using a facility known as Plug In Actions (PIA). After you install a Plug In Action in your local Keyboard Maestro Support folder, you can use them like the built-in Actions.

Third Party PIAs

You can download PIAs developed by others from these sources:

How to Install

PIA Install Files are .zip Archive Files

  1. Initial Install: Drop on the Keyboard Maestro app Dock icon
    • This will create a PIA sub-folder by the same name as the .zip file
    • Do not unzip the file
  2. To Update An Existing PIA
    1. First Manually Delete or Move the PIA Sub-Folder from:
      ~/Library/Application Support/Keyboard Maestro/Keyboard Maestro Actions/ folder
    2. Then Drop the .zip file onto the Dock Icon

How To Use a PIA

Plug In Actions are used just like the built-in Keyboard Maestro Actions.

After you have installed a PIA, you may need to restart both the Keyboard Maestro Editor and Engine in order for the new PIA to be recognized by Keyboard Maestro.

  1. In the Keyboard Maestro Editor, goto File > Quit Engine.
  2. Quit and re-launch the Keyboard Maestro Editor. This will also start the Engine.

To insert a PIA into your Macro, use any of the normal methods to insert Actions:

  1. Display the Actions Panel from the menu or with the shortcut ⌘K, and select the Third Party Plugins folder:
  2. Menu Edit > Actions > Third Party Plugins
  3. Insert Action by Name, using shortcut ⌘⌃A.

Enter the PIA form fields (parameters) that are shown on the action form.

Building a PIA

How to Create a PIA

There is no easy way to create a Plug In Action. There is no one editor (except maybe BBEdit) that can be used to create all of the files that are needed. Probably the best way to get started is to examine an existing PIA, like this one:

Steps to Create a PIA

  1. Folder: Create a folder on your local drive, using the same name that you will use for the PIA, put the following files in this folder.
  2. Plist: Create a file named Keyboard Maestro Action.plist, which is a standard Cocoa Property list file that defines the PIA form.
    • The PIA Plist is an XML which defines the Action form you see in the Keyboard Maestro Editor, and identifies the name of the script file that will be run when the PIA is executed in a triggered macro.
  3. Script: Create a script file named Action.scpt, or other suitable name (like the name of your PIA), which can be an AppleScript, JXA, or Shell Script, to process the data from the PIA form.
  4. Icon: Create icon.png which is the icon that will be displayed in the Keyboard Maestro Editor. This file is optional.
  5. Zip Install File: When you are finished with all of these files, create a .zip archive from the PIA Folder.

PIA Folder

A Plug In Action is Contained in a Folder,
Whose Name:

  1. Should generally closely match the action name
  2. Must be made up of only ASCII alphanumerics, underscores and spaces.
  3. Must be unique among all plug in actions.
  4. Is stored in the Keyboard Maestro Macros.plist to reference the plugin action.

The PIA folder contains a set of files, including:

  1. Keyboard Maestro Action.plist – an XML file describing the action.
  2. A script file
    • whose name must be made up of only ASCII alphanumerics or underscores, plus an ASCII alphanumeric extension.
    • It may be a shell script or an AppleScript.
    • If it is a shell script, it will be made executable automatically.
  3. Icon File: 64×64 png icon (optional).

The PIA Folder must be stored as a .zip archive file for installation.

PIA PList

The format of the Keyboard Maestro Action.plist is a Cocoa Property list containing a dictionary with the following keys and values:

Key Description
Name Name of the action.
(which appears in the Category/Actions list)
Script Name of the script file which will be run when the PIA is executed.
The name can only use ASCII alphanumerics or underscores, plus an ASCII alphanumeric extension
Parameters An array of parameters to the script
  • Each entry is a dictionary as described below.
  • These parameters will appear as form fields in the PIA in the Keyboard Maestro Editor.
  • They allow the user of the PIA to enter the data to be processed by the script.
  • Optional
Icon Name of the icon png file, made up of only ASCII alphanumerics or underscores plus .png
Optional
Title The title displayed on the action
  • Which can include %Param%XYZ% tokens.
  • It should usually not include other tokens.
  • If it is missing, the Name will be used.
  • Optional
Timeout The default timeout in seconds
  • Entered as a number
  • Set it to 0 if the action needs no timeout
  • The default is 99 hours
  • Like all Actions, Timeout can be changed in the Editor
  • Optional
Author The author of this action
Optional
URL URL for the author or this action
Optional
Help A short (Tool Tip) explanation of this action
Optional
Results What to do with the output of the script if any.
Possible Values:
  • None
  • Window
  • Briefly
  • Typing
  • Pasting
  • Variable
  • Clipboard

Multiple values can be used, separated by a bar (|), the first specified value is the default
Optional

Plist Parameters

Parameter Key Description
Label Name of the parameter.
  • The same rules as Keyboard Maestro Variable Names apply.
  • The label is displayed to the user and used to pass the parameter to the script.
  • Obviously, the label must be unique amongst all parameters
Type Type of the parameter.
Must be one of the following:
(Text in italics is info, and not part of the Type)
  • String (single line)
  • TokenString
  • Calculation
  • Text (multi-line)
  • TokenText
  • Checkbox (0 or 1)
  • PopupMenu
  • Hidden

The Type specifies how the value is displayed to the user and what processing is applied before it is passed to the script.
Hidden types are text token processed, but are not displayed in the editor

Menu Values of the popup menu, separated by |
Optional unless Type is PopupMenu.
Default Default value of the Parameter when the PIA is inserted in the Macro.
Optional

Each parameter in the Parameters array is a dictionary with the following keys:

Warning: Keys are case sensitive.

Retrieving Parameters in a Script

Parameters are passed to the script via environment variables with names starting with KMPARAM_, similar to how variables are passed to shell scripts with the Execute Script action.
So a parameter named “My Text” would be in an environment variable KMPARAM_My_Text.
Note that spaces in the variable names must be replaced with underscores in your script.

Methods To Retrieve Parameters Using AppleScript

--~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--»	1.  Use AppleScript "system attribute"
--~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- This method is "not safe for international characters" (and emoji)
 
set myText to system attribute "KMPARAM_My_Text"
 
--~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--»	2.  Use Shell Script with "echo"
--~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- This method works with emoji and international characters 
-- but multi-line text (as from a TokenText form field) 
-- will be flattened into a single line
 
set myText to do shell script "echo $KMPARAM_My_Text"
 
 
--~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--»	3.  Use Shell Script with "printenv"
--~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- This works with emoji, international characters and multi-line text
-- however printenv returns an error if KMPARAM_My_Text doesn't exist.
-- You can catch this error with a try command.
 
try
  set myText to do shell script "printenv KMPARAM_My_Text"
on error -- Parameter does NOT exist
  set myText to ""
end try

Reload to Use Updated PIAs

In normal use, once a plug in action is read, it will stay in memory and changes will not be noticed (although the script will be executed each time, so changes to that will be noticed). To cause the editor and/or engine to notice changes to the plug while in development, use AppleScript to reload the macros:

tell application "Keyboard Maestro" to reload
tell application "Keyboard Maestro Engine" to reload

PIA Failure

If the Plug In script fails, the action will fail (v9.0+), potentially aborting the macro.

manual/Plug_In_Actions.txt · Last modified: 2021/06/02 00:19 by JMichaelTX