https://github.com/petoncle/mousemaster
Efficiently control your mouse with keyboard inputs only.
https://github.com/petoncle/mousemaster
accessibility cursor ergonomic graalvm java keyboard keynav mouse mouse-emulator mouseless pointer productivity thinkpad trackpoint vim vimium windows
Last synced: 20 days ago
JSON representation
Efficiently control your mouse with keyboard inputs only.
- Host: GitHub
- URL: https://github.com/petoncle/mousemaster
- Owner: petoncle
- Created: 2023-12-24T20:19:28.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-22T07:34:57.000Z (10 months ago)
- Last Synced: 2024-08-02T13:33:59.152Z (10 months ago)
- Topics: accessibility, cursor, ergonomic, graalvm, java, keyboard, keynav, mouse, mouse-emulator, mouseless, pointer, productivity, thinkpad, trackpoint, vim, vimium, windows
- Language: Java
- Homepage:
- Size: 1.01 MB
- Stars: 18
- Watchers: 4
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- my-awesome-github-stars - petoncle/mousemaster - Efficiently control your mouse with keyboard inputs for a completely mouseless experience. (Java)
README
# mousemaster
- A keyboard driven interface for mouseless mouse manipulation
- Heavily inspired by [warpd](https://github.com/rvaiya/warpd)
and [mouseable](https://github.com/wirekang/mouseable/)
Demo •
Installation •
Features
# Demo
## Hints Demo
https://github.com/user-attachments/assets/cfba2c70-7edd-44bf-b63e-ded1613368da
## Hint Styling Showcase
## Grid Demo
https://github.com/petoncle/mousemaster/assets/39304282/12677e9e-3126-4694-b4bc-5a18e9438bc9
## Mouse Movements Demo
https://github.com/petoncle/mousemaster/assets/39304282/2dadbfa0-1270-41ff-9e18-3fb3a28d5b6f
# Installation
1. Download **mousemaster.exe** (a portable executable) from
the [Release page](https://github.com/petoncle/mousemaster/releases/latest), or build
it from source.
2. In the same Release page, choose then download one of the existing configuration files:
- **neo-mousekeys-ijkl.properties** (***recommended***): an IJKL configuration ([see documentation](configuration/neo-mousekeys-ijkl.md))
- **neo-mousekeys-wasd.properties**: a WASD configuration ([see documentation](configuration/neo-mousekeys-wasd.md))
- **warpd.properties**: an HKJL configuration ([see documentation](configuration/warpd.md))
- **mouseable.properties**: another HKJL configuration ([see documentation](configuration/mouseable.md))
- **author.properties**: an IJKL configuration designed to control everything with the right hand only. ([see documentation](configuration/author.md))
3. Place the executable and the configuration file of your choice in the same directory.
4. Rename the configuration file to **mousemaster.properties**.
5. Run **mousemaster.exe**: make sure to run it as administrator if you want the
mousemaster overlay to be displayed on top of everything else.
6. Feel free to open a [GitHub Issue](https://github.com/petoncle/mousemaster/issues)
or join the [Discord](https://discord.gg/GSB6MaKb2R) if you need help creating your own
configuration. If you have ideas for a better configuration that
you would like to share, I'd love to hear from you.
7. If you enjoy mousemaster, consider making a [donation](https://ko-fi.com/petoncle) or stop by the Discord to show your support!
# Features
1. **Advanced key combinations (key combos):** mousemaster offers a high level
of customization for key combinations. It allows for advanced key combos like "hold
alt for 1 second", "press then release alt, twice in a row", or "hold alt while pressing A then B".
2. **Custom modes:** Users have to define their own modes, with each mode
having its own key combo-to-command map and mouse settings. There is only one
predefined mode, the "idle-mode", which has no key combos predefined (this is the
"mousemaster is disabled mode").
3. **Flexible key combo to command mappings:** The same key combo can be used to
trigger multiple commands. Multiple key combos can be used to trigger the same command.
4. **Multi-screen navigation:** mousemaster allows for mouse movement across multiple screens.
5. **Grids:** mousemaster includes a grid-based navigation system. A grid can cover the
active screen or the active window.
6. **Hints:** mousemaster includes a hint-based navigation system similar
to Vimium's. A hint grid can cover the active screen, the active window, or all
screens (which can be used for screen selection hints). A mouse button click
can be automatically triggered after a hint is selected.
7. **Key remapping:** mousemaster includes a way to remap keys and activate the remapping
only in specific modes. For example, you can make it so pressing a single key is
equivalent to sending the combo _⊞ Win + down arrow_, which will minimize the current
window.
8. **Zoom:** it is possible to configure zoom behavior for a specific mode. For example,
you can set it to zoom in when performing a slow and precise mouse movement.
9. **App-specific modes:** it is possible to create modes that are active only when a specific
app is in focus. For example, you can disable all mousemaster shortcuts while
playing a game.
10. **Dynamic configuration:** The configuration file is live, mousemaster automatically
reloads it whenever the file is saved.
11. **Visual mouse indicator:** The optional and customizable mouse indicator (a
plain-color square drawn next to the mouse cursor) changes colors based on mouse
activity—idle, moving, button pressing, or scrolling. It repositions itself to stay
visible when the mouse is near screen edges.
12. **Left/right key distinction:** mousemaster distinguishes between left and right
alt/ctrl/shift keys, meaning that left alt and right alt can be used to trigger
different commands.
13. **Position history hints:** absolute positions can be saved on the fly to make
it possible to move the mouse to them later.