NumCuts GUI

---

This branch of the Num-Cuts GUI contains the Source Code for the HTML/CSS based UI, made using NodeJS and Electron Framework.

---

Master Branch:

Contains the back-end code constructed in C++ and Batch. It is responsible for self-installation to C:\ScrRunner (modifiable) and Startup, and executing the Scripts and GUI based on shortcuts.

Master-GUI Branch(this):

Contains the front-end GUI interface made through HTML, CSS and JavaScript, built into an app using Nodejs and the Electron framework.

---

Installation:

1. Grab the latest version from the Releases page.
2. Download and extract all the contents of the compressed Release file into the same folder and run NumCuts.exe.
3. Choose whether you'd like to hold Num-Lock or Caps-Lock to run the Shortcuts.
4. Once it's done installing and NumCutsGUI runs, add your own Shorctcuts and close the GUI. You may remove the extracted files then, if you wish.
5. Run your assigned shortcuts with Num-Lock + (the assigned key) or Caps Lock + (the assigned key) if so set.
6. If needed, open the GUI again to reconfigure shorcuts, using Num-Lock + 0 or Caps Lock + 0 if so set.

Usage:

1. If not already open, open NumCuts-GUI using Num-Lock + 0 or Caps-Lock + 0, as chosen during installation
2. Head to New Shortcuts Section and assign your own Shortcut key with the location of the file or a multi-line script.
3. Click on Add this new Shortcut Button.
4. In case of multi-line script, give it a name(and extension).
5. In case of multi-line script, you may also specify what program to execute the script with.

Example: python for .py scripts, node for NodeJS scripts, etc.

6. Once the script/file location/website URL has been saved, run it with your assigned key while holding Num-Lock or Caps-Lock, as chosen during installation.
7. Scroll down to Your Shortcuts Section to view your assigned Shortcuts and corresponding Scripts in tabular form.
8. Remove any scripts, if needed, by clicking Remove this Shortcut button after specifying Shortcut number. Or clear all assigned shortcuts by clicking on the Clear all existing Shortcuts button.
9. Close the GUI. Execute your scripts anytime your machine is on, by pressing corresponding shortcut keys.
10. If needed, open the GUI again to reconfigure shorcuts, using Num-Lock + 0 or Caps Lock + 0 as set.

Source Code usage:

1. Modify the Source codes in either branch as needed.
2. Compile the Source code of Master(C++), and package Master-GUI(Nodejs Electron).
3. The Release can only be executed on the specific OS and architecture it's been built for.
4. Rename the output GUI executable in the folder obtained after packaging the source code in Master-GUI branch, to NumCutsGUI.exe.
5. Place the compiled output of the source code of Master, and the packaged output folder of Master-GUI, in the same folder.
6. Rename the packaged output folder of Master-GUI, to "NumCuts-GUI". This folder must have a file called NumCutsGUI.exe. If it doesn't, take necessary action.
7. Move Reload.bat and move_to_startup.bat from Master-GUI branch to "Numcuts-GUI" folder.
8. Execute NumCuts.exe to set everything up. The original files can then be deleted.

---

Software/Dependencies used to create this tool:

The GUI:

1. Electron Framework v8.2.3
2. Nodejs v13.13.0 and it's depenencies, (mostly 'fs')
3. HTML5
4. CSS
5. JavaScript
6. Bootstrap
7. Based on Agency, a free Bootstrap Template
8. Adobe DreamWeaver

The execution tool:

1. C++14
2. [Basic Windows Shell Script]
3. MingW-w64 Toolchain(for compiling and making the cpp)
4. Jetbrains products: CLion, WebStorm

Screenshots:

Notes:

1. NumCuts has been programmed to automatically move to Windows Startup, so it can launch automatically every time the PC starts.
2. The console also hides itself after installation. No Window is visible at all, thereby other operations are not disturbed.
3. Being built around Batch commands, it will only work on Windows. Feel free to make your own versions for other systems.