Skip to content

Commit

Permalink
setup fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
akademi4eg committed Mar 18, 2019
1 parent a8e376d commit 5172c0c
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 10 deletions.
26 changes: 17 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,40 @@
# MiceLess
Utitlity that helps binding keyboard shortcuts for some of the operations that you do with mouse.

# Usecase
## Usecase
Primary usecase that this tool was written for is switching focus between windows on different monitors.
In some cases, e.g. multiple desktops, simple `Alt-TAB` wont help,
because it would either switch you to latest used app or would require you to press this combo several times,
until you reach target window. With this tool you can configure shortcuts so that, for example, `Ctrl-Alt-1` would
set window in left monitor in focus and `Ctrl+Alt+2` would set focus for window in right monitor.

# Manual
MiceLess stores a mapping between key-combos and sequences of mouse clicks.
To run the app, execute `run.py` with `python3` interpreter.
## Installation
Via PIP:
```bash
pip install miceless
```
To run the app, execute:
```python3
python3 -m miceless.run
```

App config would be stored in home folder in `.miceless` file.

## Manual
MiceLess stores a mapping between key-combos and sequences of mouse clicks.
App config would be stored in home folder in `.miceless` file.
The app should work anywhere where `pynput` works, yet it has been tested only on Ubuntu with X server.

## Modes
### Modes
The tool has two operation modes: **recording** and **playback**. You can switch between modes by pressing `Ctrl+Alt+~`.

## Recording
### Recording
While in **recording** mode, `Ctrl-Alt-<key>` combo would **append** click in current mouse location to the list
of events for a given combo. Pressing special combination `Ctrl+Alt+0` would clear events list for last used key combo.

## Playback
### Playback
In playback mode pressing `Ctrl+Alt+<key>` combo would invoke a sequence of events stored for that combination.

# Known issues
## Known issues
* Playback clicks are executed with `Ctrl+Alt` pressed, because all combos have these keys in them.
This might be a problem for some applications.
* There might be collisions with app-specific hotkeys that would result in not desired firings of event sequences.
Expand Down
4 changes: 3 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@
"Programming Language :: Python :: 3",
"License :: OSI Approved :: Apache Software License",
"Operating System :: POSIX :: Linux",
"Topic :: Multimedia :: Sound/Audio",
"Environment :: X11 Applications",
"Intended Audience :: End Users/Desktop",
"Topic :: Utilities",
],
)

0 comments on commit 5172c0c

Please sign in to comment.