https://github.com/bakkeby/encircle
A Xinerama X cursor monitor wrapper
https://github.com/bakkeby/encircle
mouse-movement mouse-tracking x11-cursor xinerama xinput
Last synced: about 1 month ago
JSON representation
A Xinerama X cursor monitor wrapper
- Host: GitHub
- URL: https://github.com/bakkeby/encircle
- Owner: bakkeby
- License: mit
- Created: 2022-09-07T12:13:47.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-05-15T13:39:28.000Z (about 2 years ago)
- Last Synced: 2025-03-24T02:04:34.842Z (2 months ago)
- Topics: mouse-movement, mouse-tracking, x11-cursor, xinerama, xinput
- Language: C
- Homepage:
- Size: 14.6 KB
- Stars: 12
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `encircle`: A Xinerama X cursor monitor wrapper
`encircle` is a window manager agnostic tool that wraps your X cursor around the
edges of the screen and is specifically designed to work with asymmetric
multi-monitor Xinerama setups.
In practice what this means is that the screen area is turned into a flat
torus in that when the cursor hits a screen edge then it will continue and
reappear on the opposite edge.
If the cursor position is not within the target screen then the cursor will
snap to the nearest edge of that screen.
By default cursor wrapping is enabled on both horizontal and vertical axes.
```c
┌───────┐
│ 1┄┤
│ │┌───────────────^─┐┌───────┐
│ │├┄1┄> 4 ││ │
│ ││ ││ │
│ A ││ B ││ C │
│ ││ ││ │
├┄2 │├┄3┄> ││ <┄2┄┤
│ │└───────────────^─┘│ │
│ 3┄┤ │ │
└───────┘ └───────┘
```
In the above example we have four transitions:
1) snaps to the adjacent monitor (rather than hitting a hard wall)
2) wraps the cursor from monitor A to monitor C which is the rightmost monitor
3) snaps to the adjacent monitor (rather than hitting a hard wall)
4) wraps around monitor B because there is no other monitor above or below
If the monitor arrangement is changed (e.g. using xrandr) then encircle will be
notified of that and update monitor positions and dimensions accordingly.
## Installation
```
$ git clone https://github.com/bakkeby/encircle.git
$ cd encircle
$ sudo make install
$ encircle
```
This is also available in the [AUR](https://aur.archlinux.org/packages/encircle).
## Dependencies
### Arch
- base-devel
- extra/libxinerama
- libxi
```sh
sudo pacman -S base-devel extra/libxinerama libxi
```
### Debian
- build-essential
- libxinerama-dev
- libxi-dev
```sh
sudo apt install build-essential libxinerama-dev libxi-dev
```
### Void
- base-devel
- libXinerama-devel
- libXi-devel
```sh
xbps-install -Su base-devel libXinerama-devel libXi-devel
```
## Credits
This work is largely derived from the [dwm](https://dwm.suckless.org/) window manager in relation
to its handling of monitors in a Xinerama setup. The work is inspired by
[xoop](https://mcol.xyz/code/xoop/) and [taralli](https://github.com/kmcallister/taralli).
## License
`encircle` is available under an MIT license. See the `LICENSE` file.