From: Debayan Sutradhar <debayansutradhar3@gmail.com>
Date: Sun, 07 Mar 2021 10:09:55 +0530
Subject: Merge pull request #17 from prubiella/hotkey-doc
---
Merge pull request #17 from prubiella/hotkey-doc

#14 - Documentation, table mapping between keyboard and hotkey namings
---


--- /dev/null
+++ b/hotkeyaction/README.md
@@ -0,0 +1,151 @@
+# Hotkey Action plugin
+
+This plugin allows map and execute keyboard shortcuts
+
+## KeyBoard Mapping Reference to Hotkeyaction
+
+The following table shows the relation between our keyboard and what we have to type on the plugin field to fire the hotkeys we want:
+
+Hotkey mapping plugin | Keyboard Key | 
+--------------------- | ------------ | 
+ A                    | A            | 
+ B                    | B            |   
+ C                    | C            |  
+ D                    | D            |  
+ E                    | E            |  
+ F                    | F            |  
+ G                    | G            |  
+ H                    | H            |  
+ I                    | I            |  
+ J                    | J            |  
+ K                    | K            |  
+ L                    | L            |  
+ M                    | M            |  
+ N                    | N            |  
+ O                    | O            |  
+ P                    | P            |  
+ Q                    | Q            |  
+ R                    | R            |  
+ S                    | S            |  
+ T                    | T            |  
+ U                    | U            |  
+ V                    | V            |  
+ W                    | W            |  
+ X                    | X            |  
+ Y                    | Y            |  
+ Z                    | Z            |  
+ `                    | `            |  
+ 0                    | 0            | 
+ 1                    | 1            | 
+ 2                    | 2            | 
+ 3                    | 3            | 
+ 4                    | 4            | 
+ 5                    | 5            | 
+ 6                    | 6            | 
+ 7                    | 7            | 
+ 8                    | 8            | 
+ 9                    | 9            | 
+ \-                   | -            | 
+ =                    | =            |  
+ ~                    | ~            |  
+ !                    | !            |  
+ @                    | @            |  
+ \#                    | #            |  
+ $                    | $            | 
+ ^                    | ^            |  
+ &                    | &            |  
+ \*                    | *            |  
+ (                    | (            |  
+ )                    | )            |  
+ \_                    | _            |  
+ \+                    | +            |  
+ TAB                  | TAB           | 
+ \[                    | \[            |  
+ ]                    | ]            |  
+ \\                   | \\           |  
+ {                    | {            |  
+ }                    | }            |  
+ \|                   | \|            |  
+ \;                   | ;            |  
+ \:                   | :            |  
+ \                    | \            | 
+ ,                    | ,            |  
+ \<                   | <            | 
+ \.                   | .            |  
+ \>                   | >            | 
+ /                    | /            |  
+" "                   | " "          | 
+WINDOWS               | WIN          |
+SUPER                 | SUPER        |
+COMMAND               | COMMAND      |
+WIN                   | WIN          |
+META                  | META         | 
+SHIFT                 | SHIFT        | 
+ALT                   | ALT          | 
+F1                    | F1           | 
+F2                    | F2           | 
+F3                    | F3           | 
+F4                    | F4           | 
+F5                    | F5           | 
+F6                    | F6           | 
+F7                    | F7           | 
+F8                    | F8           | 
+F9                    | F9           | 
+F10                   | F10          | 
+F11                   | F11          | 
+F12                   | F12          | 
+F13                   | F13          | 
+F14                   | F14          | 
+F15                   | F15          | 
+F16                   | F16          | 
+F17                   | F17          | 
+F18                   | F18          | 
+F19                   | F19          | 
+F20                   | F20          | 
+F21                   | F21          | 
+F22                   | F22          | 
+F23                   | F23          | 
+F24                   | F24          | 
+NUMPAD 0              | NUMPAD 0     | 
+NUMPAD 1              | NUMPAD 1     | 
+NUMPAD 2              | NUMPAD 2     | 
+NUMPAD 3              | NUMPAD 3     | 
+NUMPAD 4              | NUMPAD 4     | 
+NUMPAD 5              | NUMPAD 5     | 
+NUMPAD 6              | NUMPAD 6     | 
+NUMPAD 7              | NUMPAD 7     | 
+NUMPAD 8              | NUMPAD 8     | 
+NUMPAD 9              | NUMPAD 9     | 
+NUMBER SIGN           | NUMBER SIGN  | 
+HOME                  | HOME         | 
+INSERT                | INSERT       | 
+PAGE UP               | PAGE UP      | 
+PAGE DOWN             | PAGE DOWN    | 
+END                   | END          | 
+ENTER                 | ENTER        | 
+DELETE                | DELETE       | 
+SCROLL LOCK           | SCROLL LOCK  |
+PRINT SCREEN          | PRINT SCREEN | 
+PAUSE                 | PAUSE        | 
+NUM LOCK              | NUM LOCK     | 
+CONTROL               | CONTROL      | 
+CAPS LOCK             | CAPS LOCK    | 
+NUM UP                | NUM UP       | 
+ARROW UP                  | UP           | 
+NUM LEFT              | NUM LEFT     | 
+ARROW LEFT                  | LEFT         | 
+ALT GRAPH             | ALT GRAPH    | 
+NUM RIGHT             | NUM RIGHT    | 
+ARROW RIGHT                 | RIGHT        | 
+NUM DOWN              | NUM DOWN     | 
+ARROW DOWN                  | DOWN         | 
+
+## Usage
+
+To create a new hotkey, just drag the hotkey feature to the desired button and in the field `Key combination (separate using comma)` just type your combination. 
+
+Example: in ubuntu 20.04 for opening terminal just type `CONTROL,ALT,T` 
+
+
+## Known issues: 
+- `WINDOWS` or `SUPER` or `META` key in Linux distros does not work.

--- 'a/hotkeyaction/src/main/java/com/stream_pi/hotkeyaction/HotkeyAction.java'
+++ b/hotkeyaction/src/main/java/com/stream_pi/hotkeyaction/HotkeyAction.java
@@ -24,7 +24,7 @@ public class HotkeyAction extends Normal
         setCategory("Essentials");
         setAuthor("rnayabed");
         setServerButtonGraphic("far-keyboard");
-        setHelpLink("https://github.com/Stream-Pi/EssentialActions");
+        setHelpLink("https://github.com/prubiella/essentialactions/tree/master/hotkeyaction/README.md");
         setVersion(new Version(1,0,0));
     }
 
@@ -145,13 +145,13 @@ public class HotkeyAction extends Normal
             case "TAB": return TAB;
             case "[": return OPEN_BRACKET; 
             case "]": return CLOSE_BRACKET; 
-            case "\\": return BACK_SLASH; 
             case "{": return OPEN_BRACKET; 
             case "}": return CLOSE_BRACKET; 
-            case "|": return BACK_SLASH; 
+            case "|": return PIPE; 
             case ";": return SEMICOLON; 
             case ":": return COLON; 
-            case "\"": return BACK_SLASH;
+            case "\\": return BACK_SLASH; 
+            case "\"": return QUOTE;
             case ",": return COMMA; 
             case "<": return LESS;
             case ".": return PERIOD;