KeyFlow

KeyFlow is a powerful C++ project that helps users enhance their productivity by creating customized cheat codes and key combinations. KeyFlow can be used to launch programs, open documents, and emulate keystrokes. Using this tool, you can assign a cheat code or a key combination (shortcut) to execute a program or flush some predetermined string to the active window on a Windows machine.

Features

• Customizable cheat codes: Personalize your experience by assigning unique codes like "pizza," "alarm," or "goodnight" to instantly print specific strings or execute specific programs.
• Convenient shortcuts: Easily fill in frequently-used file names or other phrases using intuitive shortcuts.
• Expanded punctuation options: Enhance your typing with access to punctuation marks not available on your keyboard, such as curved quotes (“…”), copyright symbol (©), or currency symbols (₹, €) effortlessly.
• Quick access to programs, documents, and websites: Launch your favorite programs, open documents, or visit websites with simple keystrokes.
• Personalized signatures: Add a signature to your emails, message boards by just a few key strokes.
• Advanced key combinations: Assign complex key combinations like CTRL+ALT+Q, WINDOWS+Z, or any other combination to execute desired actions efficiently.
• Hotword printing: Define key combinations like CTRL+ALT+M to automate the printing of frequently-used phrases or statements in any active window.
• Seamless integration: KeyFlow seamlessly integrates with MS Windows, allowing you to use cheat codes and key combinations across all applications.

Getting Started To start using KeyFlow, follow these simple steps:

1. Clone the KeyFlow repository to your local machine.
2. Build the project using Visual Studio 2022 IDE and the MSVC compiler:

• Open the KeyFlow solution (.sln) file in Visual Studio 2022.
• Build the solution using the IDE's build commands.

3. Run the executable file to launch the KeyFlow application. Ensure that the configuration files (../config/codes.config and ../config/shortcuts.config) are located in their respective directories.

4. In case the configuration files are not found in their default locations, you can provide custom paths through command line arguments. Right click on KeyFlow project in the solution explorer and click "Properties". Specify command line arguments in "Configuration Properties > Debugging > Command Arguments".

5. Customize your cheat codes, key combinations, hotwords, and associated actions using the provided guide below.

   For shortcuts.config:

   • The left-hand side of the operator represents the desired key combination. To understand more about nomanclature of keys, refer to the table at the end.
   • Depending on the operator used, the right-hand side can either be a string to be printed in the active window or the path to an executable program.
   • If the operator is $, the string on the right indicates the path of the executable to launch when the key combination is pressed.
   • If the operator is :, the string on the right will be printed in the active window.
   • Each operation should be written on a single line.
   • Comments can be added to the file, but they should be placed on separate lines.

   # This is a comment.
   # The following string will be flushed to the active window at the cursor position 
   # when the user presses LEFT CONTROL + LEFT ALT + A.
   LCONTROL+LMENU+A :PRINT this entire string!
   
   # The following program will be launched when the user presses LEFT ALT + A.
   LMENU+A $C:\Program Files\Sublime Text 3\sublime_text.exe
   

For codes.config:

• Specify the desired length of your cheats at the beginning of the file.

• The left-hand side of the operator should contain the cheat code.

• Depending on the operator used, the right-hand side can be a string to be printed in the active window or the path to an executable program.

• If the operator is $, the string on the right indicates the path of the executable to launch when the cheat code is triggered.

• If the operator is :, the string on the right will be printed in the active window.

• Each operation should be written on a single line.

• It's possible to include comments in the file, but they should be placed on separate lines.

  # All over cheat codes will be of length 5.
  CODE LENGTH = 5
  # Typing hello, regardless of the status of caps lock, 
  # will print WORLD on the active window
  HELLO :WORLD
  APPLE :Stay away, Doc!
  # Typing GTAV5 will launch GTA5.exe, if present, of course.
  GTAV5 $C:\Games\Grand Theft Auto V\GTA5.exe
  

These instructions will help you get started with KeyFlow and enable you to customize its functionalities according to your preferences.

Contributing

• We welcome contributions from the open-source community to enhance KeyFlow's functionality and user experience.

Keyboard Key Codes and Corresponding Key Names

• This table serves as a reference for specifying shortcuts in the shortcuts.config file. It provides the decimal and hexadecimal values of keyboard keys, along with their corresponding constant names and descriptions. These constant names can be used to generate shortcuts in shortcuts.config as shown in the aforementioned example.

• For more detailed information on virtual key codes, you can visit the Microsoft documentation.

| Decimal Value | Hex-Value | Constant | Description | | ------------- | --------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 1 | 0x01 | LBUTTON | Left mouse button | | 2 | 0x02 | RBUTTON | Right mouse button | | 3 | 0x03 | CANCEL | Control-break processing | | 4 | 0x04 | MBUTTON | Middle mouse button (three-button mouse) | | 5 | 0x05 | XBUTTON1 | X1 mouse button | | 6 | 0x06 | XBUTTON2 | X2 mouse button | | 8 | 0x08 | BACK | BACKSPACE key | | 9 | 0x09 | TAB | TAB key | | 12 | 0x0C | CLEAR | CLEAR key | | 13 | 0x0D | RETURN | ENTER key | | 16 | 0x10 | SHIFT | SHIFT key | | 17 | 0x11 | CONTROL | CTRL key | | 18 | 0x12 | MENU | ALT key | |