KeyCat

Overview

KeyCat is a program that works in the background, analyzing the user's keyboard and mouse actions. When KeyCat detects a mouse action that can also be performed with a keyboard, it shows a notification in the corner of the screen. A keyboard shortcut that can be used to achieve the same result is displayed in that notification. The notification will fade away on its own in order not to disrupt the normal workflow of the user. Over time the user will start remembering more shortcuts and become more proficient in using their keyboard.

KeyCat holds a list of program specific shortcuts, which can also be customized according to users' needs.

Users can also view statistics on their keyboard and mouse usage, which will give them an overview of their progress and encourage further improvements.

Although these kind of programs already exist, there are currently no programs like this for Linux, which is what we are going to change. Examples of currently existing programs: KeyRocket (Windows), AltMOUSE (Windows), Hotkey EVE (Mac), KeyCue (Mac).

Check it out in virtual machine

Current version of KeyCat runs only in Ubuntu (LXDE or Gnome) and works with Chrome. For Your convenience use this link to download virtualbox disk with clean install of Ubuntu with Chrome.

Create a Linux 64 bit virtual machine in VirtualBox and use the downloaded file as existing disk for the machine. Run the machine and visit this page for further install or build instructions. The user password is 12345.

Installation for user

To install keycat run install.sh script in terminal:

sudo sh install.sh

Running

Run in terminal:

keycat

To close type Ctrl+C

Installation for developer

To set up the build environment for keycat follow these steps:

Cloning

To clone this repository run

git clone <url>

Updating

To pull the changes in this repository run

git pull

Run from source code

To install all project dependencies run from command line

sudo sh setup.sh

This will also link keycat program in your local (cloned or downloaded) into /usr/local/bin folder. This way you can edit the source file and the changes will take effect when you run the program.

Run the program from command line

keycat

Close program

Ctrl + C

Running tests

python setup.py test

Feedback

Give us feedback: https://goo.gl/forms/QIYtO0rRFYkRwBMn2