https://github.com/it-ankka/pymouseless
A cross-platform python script which allows you to control your mouse using the keyboard
https://github.com/it-ankka/pymouseless
ergonomics keyboard-layout keyboard-shortcuts mouse-emulation mouseless python scripts
Last synced: 5 months ago
JSON representation
A cross-platform python script which allows you to control your mouse using the keyboard
- Host: GitHub
- URL: https://github.com/it-ankka/pymouseless
- Owner: it-ankka
- Created: 2022-06-05T13:05:51.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-06T19:32:02.000Z (about 4 years ago)
- Last Synced: 2024-11-23T22:28:26.777Z (over 1 year ago)
- Topics: ergonomics, keyboard-layout, keyboard-shortcuts, mouse-emulation, mouseless, python, scripts
- Language: Python
- Homepage:
- Size: 16.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PyMouseless
A cross-platform python script which allows you to control your mouse using the keyboard
## How to use
#### 1. First install the dependecies
- **Globally** ( **Required on Linux**, use sudo ): \
`pip install keyboard mouse psutil`
- **Using pipenv:** \
`pipenv install keyboard mouse psutil`
#### 1.5 Linux users: install xdotool
- Linux mouse clicks require xdotool to work due to limitations of the mouse library on linux
#### 2.0 Set your configurations in config.json
- `"base_speed"` : Sets the base speed of the cursor
- `"scroll_speed"` : **Doesn't work on Linux**
- Sets the scrolling speed
- `"move_speeds"` : Sets the speeds of the different movement speed modifiers
- `"poll_rate"` : Sets the amount of times the mouse will be updated in one second
- `"keybinds"` : Contains all your keybinds
- **"scroll_left" and "scroll_right" only available in linux** \
However sideways scrolling can be achieved by not assigning the shift key in keybinds and pressing it while scrolling
- `"keyboard_id"` : **Linux only**
- Id of the keyboard which will be disabled
- Needed for disabling and re-enabling the x11 keyboard
- **[How to get the id](https://askubuntu.com/a/178741)**
- `"master_id"` : **Linux only**
- Id of the master keyboard
- Needed for disabling and re-enabling the x11 keyboard
- **[How to get the id](https://askubuntu.com/a/178741)**
- `"custom_keybinds"` : custom keybinds for mouse mode
### 3.0 make the script easily runnable
- Run it using python3 (sudo required for linux) **OR** Create a shell script to run it and add it to the path