/vimouse-rs

Use keyboard to control your mouse

Primary LanguageRustBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

vimouse-rs
==========

vimouse is an utility that allow you to control your mouse with keyboard.

This application is designed to be used right after execution, that mean, you
should not run this as a background process. Instead, use a launcher to start
it on demand (dmenu, rofi on Linux or spotlight, alfred, raycast on macOS).

How to install?
---------------

Clone this repository to your local machine, and build with:

  $ cargo build --release

Then move the /target/release/vimouse binary file to somewhere that you
can find later, for example /usr/local/bin


How to use?
-----------

Movements:

  y  k  u
   ↖ ↑ ↗
 h ← . → l
   ↙ ↓ ↘
  b  j  n

Quick jump to a specific section on the screen:

 ┌─────┬─────┬─────┬─────┐
 │  Q  │  W  │  E  │  R  │
 ├─────┼─────┼─────┼─────┤
 │  A  │  S  │  D  │  F  │
 ├─────┼─────┼─────┼─────┤
 │  Z  │  X  │  C  │  V  │
 └─────┴─────┴─────┴─────┘

Mouse clicks:

- Space: Left click
- Ctrl: Right click

Scrolling:

- Hold G + j: Scroll down
- Hold G + k: Scroll up
- Hold G + h: Scroll left
- Hold G + l: Scroll right

Or press T to toggle scrolling mode, so you don't have to hold G at all.

Changing mouse speed:

- Holding Shift: slower speed
- Holding Alt/Opt: faster speed

Use ESC to exit vimouse.

For Raycast users
-----------------

If you use Raycast, you can create a new custom script and copy the content
of the scripts/vimouse.sh file. So you can trigger vimouse from Raycast menu.