User Tools

Site Tools


manual:Plug_In_Actions

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revision Both sides next revision
manual:Plug_In_Actions [2019/03/28 03:18]
peternlewis
manual:Plug_In_Actions [2021/05/31 19:55]
JMichaelTX Major rewrite providing sections and lists
Line 1: Line 1:
 ====== Plug In Actions ====== ====== Plug In Actions ======
  
-Keyboard Maestro has support for user written and contributable plug in actions.  ​You can get more plug in actions from [[https://​www.stairways.com/​action/​linkthru?​thirdpartyactions|our web site]] or [[https://​forum.keyboardmaestro.com/​c/​plugin|the forum]] and you can create and optionally contribute your own.  You can drop new plug in action .zip archive on the Keyboard Maestro ​application dock icon to install it (note that to update a plug in action ​you must manually remove it from the FILE{{{~/​Library/​Application Support/​Keyboard Maestro/​Keyboard Maestro ​Actions}}} folder before re-installing it).+You can develop custom ​[[:Actions|Macro Actions]] using a facility known as _Plug In Actions_ (PIA) ​After ​you install ​_Plug In Action_ ​in your local Keyboard Maestro ​Support folder, ​you can use them like the built-in ​Actions.
  
-Third Party Plug In Action consists of a folder with a name (which should generally closely match the action name), and must be made up of only ASCII alphanumerics,​ underscores and spaces. The folder name must be unique among all plug in actions. ​ The folder name is stored in the Keyboard Maestro Macros.plist to reference the plugin action.+===== Third Party PIA =====
  
-The folder contains a set of files, including:+You download PIA developed by others from these sources: 
 +  - [[https://​www.stairways.com/​action/​linkthru?​thirdpartyactions|Stairways Web Site]] 
 +  - [[https://​forum.keyboardmaestro.com/​c/​plugin|Keyboard Maestro Forum]]
  
-* Keyboard Maestro Action.plist – an XML file describing the action. +===== How to Install =====
-* 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. +
-* An optional 64x64 png icon.+
  
-The format of the Keyboard Maestro Action.plist is a Cocoa property ​list containing a dictionary with the following keys and values:+PIA Install Files are `.zip` Archive Files 
 +  - **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 
 +  - **To Update** An Existing PIA 
 +    - First Manually Delete or Move the PIA Sub-Folder from:\\ FILE{{{~/​Library/​Application Support/​Keyboard Maestro/​Keyboard Maestro Actions/}}} folder 
 +    - Then Drop onto the Dock Icon 
 + 
 +===== Building a PIA ===== 
 + 
 + 
 +**A _Plug In Action_ is Contained in a Folder**,\\ **Whose Name:** 
 +  - Should generally closely match the action name 
 +  - Must be made up of only ASCII alphanumerics,​ underscores and spaces. 
 +  - Must be unique among all plug in actions. 
 +  - Is stored in the Keyboard Maestro Macros.plist to reference the plugin action. 
 + 
 +The PIA folder contains a set of files, including:​ 
 +  - Keyboard Maestro Action.plist – an XML file describing the action. 
 +  - 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. 
 +  - Icon File: 64x64 png icon (optional). 
 + 
 +**The PIA Folder must be stored as a `.zip` archive file for installation.** 
 + 
 +The format of the Keyboard Maestro Action.plist is a [Cocoa Property ​list](https://​developer.apple.com/​library/​archive/​documentation/​General/​Conceptual/​DevPedia-CocoaCore/​PropertyList.html) ​containing a dictionary with the following keys and values:
  
 | Name | the name of the action (which appears in the Category/​Actions list) | | Name | the name of the action (which appears in the Category/​Actions list) |
Line 47: Line 74:
  
 Keyboard Maestro Plug In Actions go in the FILE{{{~/​Library/​Application Support/​Keyboard Maestro/​Keyboard Maestro Actions}}} folder. Keyboard Maestro Plug In Actions go in the FILE{{{~/​Library/​Application Support/​Keyboard Maestro/​Keyboard Maestro Actions}}} folder.
 +
 +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