Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Gnarus-G/maccel
Mouse acceleration driver and kernel module for Linux.
https://github.com/Gnarus-G/maccel
linux linux-kernel-module mouse-accel-driver mouse-acceleration
Last synced: about 2 months ago
JSON representation
Mouse acceleration driver and kernel module for Linux.
- Host: GitHub
- URL: https://github.com/Gnarus-G/maccel
- Owner: Gnarus-G
- License: gpl-2.0
- Created: 2024-01-16T01:20:24.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-04-26T02:27:29.000Z (about 2 months ago)
- Last Synced: 2024-04-26T03:29:03.799Z (about 2 months ago)
- Topics: linux, linux-kernel-module, mouse-accel-driver, mouse-acceleration
- Language: C
- Homepage: https://maccel.org
- Size: 608 KB
- Stars: 21
- Watchers: 3
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-ratatui - maccel - A mouse acceleration driver for linux, and a TUI to control some parameters. (💻 Apps / 🌌 Other)
README
# maccel
Linear mouse acceleration.
## Acceleration Funcion
$$V = \frac{\sqrt{dx_0^2 + dy_0^2}}{i}$$
$$dx_f = dx_0 * (1 + aV)$$
$$dy_f = dy_0 * (1 + aV)$$
Where $dx$ and $dy$ are the directional displacements read from the mouse,
$i$ is the polling interval of the mouse; this would be 1ms if the polling rate is 1000Hz,
and $a$ is the user provided
acceleration factor
## Install
Clone the repo, and run some make commands.
```sh
git clone https://github.com/Gnarus-G/maccel.git
cd maccel
```
### Install the cli.
If you don't have `cargo`, then get it with rust
from https://www.rust-lang.org/tools/install
```sh
cargo install --path maccel-cli
```
### Instal the driver and the udev rules.
```sh
make install
make udev_install # This depends on the cli and will install in /usr/local/bin
```
Optionally, it's recommended that you add yourself to the `maccel` group;
and remember to restart your session after you do so it takes effect.
Adding yourself to that `maccel` group allows you to run the maccel-cli
to set parameter values without `sudo`
### Uninstall
```sh
make uninstall
make udev_uninstall
```
## CLI Usage
```
CLI to control the paramters for the maccel driver, and manage mice bindings
Usage: maccel
Commands:
tui Open the Terminal UI to manage the parameters and see a graph of the sensitivity
bind Attach a device to the maccel driver
bindall Attach all detected mice to the maccel driver
unbind Detach a device from the maccel driver, reattach to the generic usbhid driver
unbindall Detach all detected mice from the maccel driver reattach them to the generic usbhid driver
set Set the value for a parameter of the maccel driver
get Get the value for a parameter of the maccel driver
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
-V, --version Print version
```
## Notes
One should disable the acceleration done by default in some distros, e.g. by `xset` or `libinput`.
[Full Guide](https://wiki.archlinux.org/title/Mouse_acceleration#Disabling_mouse_acceleration)
Here is [Breakdown of why and how I ended up making this](https://www.bytin.tech/blog/maccel/)
## References
- https://lwn.net/Kernel/LDD3/
- https://github.com/torvalds/linux/blob/master/drivers/hid/usbhid/usbmouse.c
- https://www.kernel.org/doc/html/latest/input/index.html
- https://github.com/a1xd/rawaccel/blob/master/doc/Guide.md
- https://github.com/Skyl3r/leetmouse/blob/master/driver/accel.c
- https://sourceforge.net/p/fixedptc/code/ci/default/tree/