Add help widget

Author: ajboni

HELP.md

@@ -0,0 +1,15 @@
+## KEYBOARD SHORTCUTS
+
+| Context                  | Modifier | Combination         | Action                                               |
+| ------------------------ | -------- | ------------------- | ---------------------------------------------------- |
+| General                  | -        | 1 ... 9             | Select menu option.                                  |
+| General                  | -        | TAB                 | Focus next widget                                    |
+| Layout                   | SHIFT    | TAB                 | Focus previous widget                                |
+| Rack                     | -        | RETURN              | Select plugin.                                       |
+| Rack                     | -        | DELETE              | Remove Plugin                                        |
+| Rack                     | CTRL     | UP / DOWN           | Swap plugins up/down                                 |
+| Plugin Parameters Widget | -        | UP / DOWN - TAB     | Cycle through parameters.                            |
+| Plugin Parameters Widget | -        | LEFT / RIGHT        | Change parameter value by default step               |
+| Plugin Parameters Widget | SHIFT    | LEFT / RIGHT        | Change parameter value by small step.                |
+| Plugin Parameters Widget | CTRL     | LEFT / RIGHT        | Change parameter value by big step.                  |
+| Plugin Parameters Widget | -        | PAGE_UP / PAGE_DOWN | Change parameter value by 1/5 of the maximum allowed |

README.md

@@ -40,24 +40,21 @@ Modify `.config.yaml` with your settings, more info [in the docs](https://ajboni
 
 # Keyboard shortcuts
 
-### Layout
-
-- `TAB | Shift + TAB` Cycle between each widget.
-- `1...9` Select menu option.
-
-### Rack widget
-
-- `enter` Select plugin for handling
-- `delete | backspace` Remove plugin
-- `CTRL + up/down` Swap plugins up/down
-
-### Plugin parameters widget
-
-- `up/down / TAB` Cycle through each parameter.
-- `left/right` Change parameter value by default step.
-- `SHIFT + left/right` Change parameter value by small step.
-- `CTRL + left/right` Change parameter value by big step.
-- `page_up/page_down` Change parameter value by 1/5 of the maximum allowed
+## KEYBOARD SHORTCUTS
+
+| Context                  | Modifier | Combination         | Action                                               |
+| ------------------------ | -------- | ------------------- | ---------------------------------------------------- |
+| General                  | -        | 1 ... 9             | Select menu option.                                  |
+| General                  | -        | TAB                 | Focus next widget                                    |
+| Layout                   | SHIFT    | TAB                 | Focus previous widget                                |
+| Rack                     | -        | RETURN              | Select plugin.                                       |
+| Rack                     | -        | DELETE              | Remove Plugin                                        |
+| Rack                     | CTRL     | UP / DOWN           | Swap plugins up/down                                 |
+| Plugin Parameters Widget | -        | UP / DOWN - TAB     | Cycle through parameters.                            |
+| Plugin Parameters Widget | -        | LEFT / RIGHT        | Change parameter value by default step               |
+| Plugin Parameters Widget | SHIFT    | LEFT / RIGHT        | Change parameter value by small step.                |
+| Plugin Parameters Widget | CTRL     | LEFT / RIGHT        | Change parameter value by big step.                  |
+| Plugin Parameters Widget | -        | PAGE_UP / PAGE_DOWN | Change parameter value by 1/5 of the maximum allowed |
 
 # DEV
 

package-lock.json

@@ -20,6 +20,7 @@ const AudioIO = require("./widgets/audioIO");
 const PubSub = require("pubsub-js");
 const PluginInfo = require("./widgets/pluginInfo");
 const PluginPresetsWidget = require("./widgets/pluginPresets");
+const HelpWidget = require("./widgets/help");
 
 let focusIndex = 0;
 var mainScreen;
@@ -88,14 +89,16 @@ function setUpLayout(screen) {
     new AudioIO(grid, 0, 15, 13, 13, "output")
   );
 
+  const page6 = new Page(new HelpWidget(grid, 0, 1, 13, 27));
+
   const pageSwitcher = new PageSwitcher(mainScreen, [
     page0,
     page0,
     page2,
     page0,
     page4,
     page0,
-    // page4,
+    page6,
   ]);
 
   PubSub.subscribe("app", function (msg, app) {

src/layout.js

@@ -0,0 +1,29 @@
+const contrib = require("blessed-contrib");
+const PubSub = require("pubsub-js");
+const fs = require("fs");
+const { tree } = require("blessed-contrib");
+
+const HelpWidget = function (grid, x, y, xSpan, ySpan) {
+  const helpWidget = grid.set(y, x, ySpan, xSpan, contrib.markdown, {
+    label: " Calvo Help ",
+    tags: true,
+    input: false,
+    mouse: true,
+    interactive: true,
+    keys: false,
+    padding: { left: 1, right: 1, top: 1, bottom: 1 },
+    style: {
+      border: { fg: "#7ea87f" },
+      focus: {
+        border: { fg: "red" },
+        //   enabled: false,
+      },
+    },
+  });
+
+  const help = fs.readFileSync("HELP.md", { encoding: "utf8" });
+  helpWidget.setMarkdown(help);
+  return helpWidget;
+};
+
+module.exports = HelpWidget;

src/widgets/help.js

@@ -33,7 +33,9 @@ function make(grid, x, y, xSpan, ySpan, page = -1) {
       "Reconnect All": () => {
         store.reconectAll();
       },
-      Help: () => {},
+      Help: () => {
+        store.setCurrentPage(6);
+      },
       Exit: () => {
         App.exit();
       },