tweekmonster / hammerspoon-vimouse

Control the mouse with Hammerspoon in a Vim-ish way

Hammerspoon Vi Mouse

Control the mouse with Hammerspoon in a Vim-ish way.

Install

Download vimouse.lua and add it to ~/.hammerspoon. In ~/.hammerspoon/init.lua add:

local vimouse = require('vimouse')
vimouse('cmd', 'm')

This sets ⌘-m as the key that toggles Vi Mouse mode.

Usage

-- h/j/k/l moves the mouse cursor by 20 pixels.  Holding shift moves by 100
-- pixels, and holding alt moves by 5 pixels.
--
-- Pressing <space> sends left mouse down.  Releasing <space> sends left mouse
-- up.  Holding <space> and pressing h/j/k/l is mouse dragging.  Tapping
-- <space> quickly sends double and triple clicks.  Holding ctrl sends right
-- mouse events.
--
-- <c-y> and <c-e> sends the scroll wheel event.  Holding the keys will speed
-- up the scrolling.
--
-- Press <esc> or the configured toggle key to end Vi Mouse mode.

hammerspoon-vimouse's Issues

Don't restore original cursor position

When I toggle vimouse off, the cursor returns to the position it was before toggling vimouse on. I expect the cursor to remain in its last position. Thanks in advance!

License

First, thank you for sharing this code. I've found it very helpful for working without a mouse.

In fact, I just started working on a fork of this project (to convert it to a more configurable "Spoon"), but soon realized that there is no license specified here. Could you please choose a license so I can properly attribute copyright for your original work?

For what it's worth, the MIT license appears to be a common choice for Hammerspoon Spoons.

Thank you!

Using two modifier keys with braces

This is really cool! One minor thing, if I use

local vimouse = require('vimouse')
vimouse({'shift', 'cmd'}, 'm')    

then pressing Shift + Cmd + m will start Vi mouse mode but it won't toggle it (i.e it won't turn it off). Mmm I think it has something to do with using {} as the modifier key.
Thanks in advance for looking into this!