alaricweb/keymouse

Simple Vimium like program for Windows applications.

KeyMouse

KeyMouse is a program which works like the chrome plugin vimium, but is designed for other programs(like windows file browser).

Installation

Download the zip file in release page and unzip it.

Usage

• Select mode: Press Alt + ; to enter select mode, then press tag to select item. If you hit rightClickPrefix before hitting tag, KeyMouse will simulate right click instead.
• Fast Select mode: Alt + J to enter fast select mode. This mode may fail in some situations.
• Esc Select mode: Press Esc to esc.
• Disable: Press Alt + [ to enable/disable the program.
• Scroll down: Press Alt + J.
• Scroll up: Press Alt + K.
• Force not use cache: When enableCache is true and you're in select mode. Press space to force not use cache.

if KeyMouse doesn't work, try to run as Administrator.

Configuration

KeyMouse supports configuration for hot keys and profile.you can put your configuration in config.json(put in the path the same as KeyMouse.exe). there is a typical configuration:

{
    "profile":
    {
        "runOnStartUp": true,
        "backgroundColor": "#CCFFCC",
        "fontColor": "#000000",
        "fontSize": 9,
        "font": "Arial Rounded MT Bold",
        "windowBkgdColor": "#CCBBAA",
        "windowFontSize": 11,
        "opacity": 70,
        "invertClickType": false,
        "onlyForeWindow": true,
        "enableWindowSwitching": true,
        "enableCache": false
    },
    "keybindings":
    {
        "toggleEnable": "alt+[",
        "scrollUp": "alt+k",
        "scrollDown": "alt+j",
        "selectMode": "alt+;",
        "escape": "esc",
        "fastSelectMode": "alt+i",
        "rightClickPrefix": "shift+a",
        "singleClickPrefix": "shift+s",
        "forceNotUseCache": "space",
        "selectModeSingle": "disabled"
    }
}

options

The options of profile is listed below:

Options	Type	Default	Description
runOnStartUp	bool	false	When this option is true, the app will be launched when windows starts up.
backgroundColor	string	#CCFFCC	The background color of hints. Use RGB format
fontColor	string	#000000	The font color of hint. Use RGB format
fontSize	int	10	The font size of hint.
font	string	Arial Rounded MT Bold	The font type of hint. You can find the font name supported by your system through Settings->Personalization->fonts. Make sure to use the full name of font.
windowBkgdColor	string	#CCBBAA	This option is for switch window tag. Indicate the background color of switch window tag.
windowFontColor	string	#000000	This option is for switch window tag. Indecate tor font color of switch window tag.
windowFontSize	int	12	This option is for switch window tag.
windowFont	string	Arial Rounded MT Bold	this option is for switch window tag. Indecate the font type of switch window tag.
opacity	int	100	The opacity of tags. value is from 0-100.
invertClickType	bool	false	When it's true, KeyMouse will use right click as main click.
onlyForeWindow	bool	true	When using multiple monitors, only enumerate hints on foreground window. If setting to false, It will try to enumerate windows on other monitors(might be slow.)
enableWindowSwitching	bool	true	Window switching feature may cause a high delay on some Windows versions.
enableCache	bool	false	(experimental) Try to cache the target window's hints when it's possible. (target window may be frozen if it's hint-intensive.)

The hot keys support alt, shift, ctrl, win and most keys on the keyboard. Please use lowercase and use + to connect different keys. some typical keybings: alt+j, shift+alt+j, f11. You can also use disabled to disable hot key.

The option of hot keys is listed below:

Options	Type	Default	Description
toggleEnable	string	alt+[	Enable/Disable this app.
scrollUp	string	k	Scroll up.
scrollDown	string	j	Scroll down.
selectMode	string	alt+;	Enter select mode.
fastSelectMode	string	alt+j	Enter fast select mode. the difference between select mode and fast select mode is that FSM will continually enter select mode. may fail in some situations.
escape	string	esc	Leave select mode.
rightClickPrefix	string	shift+a	When you're in select mode. Hitting rightClickPrefix before hitting tag will simulate right click instead.
singleClickPrefix	string	shift+s	When you're in select mode. Hitting singleClickPrefix before hitting tag will simulate single click instead.
forceNotUseCache	string	space	When enableCache is true and you're in select mode. Hitting forceNotUseCache will retrieve hints directly instead of using cache.
selectModeSingle	string	disabled	Select Mode using single left click.

Build

Prerequisities

1. require json lib from nlohmann/json.

you can either add --recurse-submodules option when cloning this repo or get a copy from nlohmann/json/single_include/nlohmann/json.hpp to /KeyMouse/KeyMouse/json/single_include/nlohmann/json.hpp.

Step

1. run git clone --recurse-submodules https://github.com/iscooool/KeyMouse.git.
2. Install Visual Studio and Import this project.
3. Ensure to build this project in x64.