Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
garywill committed Nov 19, 2023
1 parent 8fd23e3 commit 70a63f1
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Let's do some tries to dump traditional mouse
Let's do some tries to dump traditional mouse. Inspired by Vim & Vimium.

# viScreenMouse
# viMouse

Use keyboard to click anywhere of screen. OpenCV based screenshot visual recognition.
Use keyboard to click anywhere of screen. OpenCV based screenshot **visual recognition**.

> The **vi** in the name here can mean "Vim", "Vision-recognition" or whatever
Expand All @@ -21,31 +21,31 @@ This is still very simple and **in alpha preview** stage currently. Anything cou
cd into folder and run `python3 main.py` to start.

1. Hit `ctrl + meta` to find clickable objects on screen and show keys

> meta key = win key = super key
> During keys shown, any key events are blocked from being sent to any other apps
To cancel, press ESC or `,`(comma). To return to last step, press backspace

2. Press keys to move mouse to that position

3. It triggers click (if `autoClick=True`. Otherwise hit `meta + ctrl` to trigger click)

> Edit file `g.py` and configure for your need: screenshotDelay, whole screen, autoClick ...

Algorithm (filtering, recognizing, parameters... ) can be improved. If you don't have a high contrast GUI, or some icons or buttons don't have clear contour, or two objects too close, it may fail to recognize.

We're expecting experts comming !


## Other vi / keybinding projects

Keyboard clicking:

- [hunt-and-peck](https://github.com/zsims/hunt-and-peck) Simple vimium/vimperator style navigation for Windows applications based on the UI Automation framework.

- [warpd](https://github.com/rvaiya/warpd) A modal keyboard driven interface for mouse manipulation.

- [vimac](https://github.com/dexterleng/vimac) keyboard-driven navigation and control of the macOS Graphical User Interface (GUI)

- [vimium-everywhere](https://github.com/phil294/vimium-everywhere) OS-wide Keyboard navigation for Linux and Windows
Expand Down

0 comments on commit 70a63f1

Please sign in to comment.