input-remapper/README.md
Kristen McWilliam b5c03ff89b
docs: remove redundant install step on Fedora (#807)
The `--now` flag to `systemctl enable` already starts the service immediately, no need to run a start command again.
2023-11-12 22:47:44 +01:00

85 lines
2.6 KiB
Markdown

<p align="center"><img src="data/input-remapper.svg" width=100/></p>
<h1 align="center">Input Remapper</h1>
<p align="center">
An easy to use tool to change the behaviour of your input devices.<br/>
Supports X11, Wayland, combinations, programmable macros, joysticks, wheels,<br/>
triggers, keys, mouse-movements and more. Maps any input to any other input.
</p>
<p align="center"><a href="readme/usage.md">Usage</a> - <a href="readme/macros.md">Macros</a> - <a href="#installation">Installation</a> - <a href="readme/development.md">Development</a> - <a href="readme/examples.md">Examples</a></p>
<p align="center"><img src="readme/pylint.svg"/> <img src="readme/coverage.svg"/></p>
<p align="center">
<img src="readme/screenshot.png" width="48%"/>
&#160;
<img src="readme/screenshot_2.png" width="48%"/>
</p>
## Installation
##### Manjaro/Arch
```bash
yay -S input-remapper-git
sudo systemctl restart input-remapper
sudo systemctl enable input-remapper
```
##### Ubuntu/Debian
Get a .deb file from the [release page](https://github.com/sezanzeb/input-remapper/releases)
or install the latest changes via:
```bash
sudo apt install git python3-setuptools gettext
git clone https://github.com/sezanzeb/input-remapper.git
cd input-remapper && ./scripts/build.sh
sudo apt install -f ./dist/input-remapper-2.0.1.deb
```
input-remapper is available in [Debian](https://tracker.debian.org/pkg/input-remapper)
and [Ubuntu](https://packages.ubuntu.com/jammy/input-remapper).
input-remapper ≥ 2.0 requires at least Ubuntu 22.04.
##### Fedora
```bash
sudo dnf install input-remapper
sudo systemctl enable --now input-remapper
```
##### Manual
Dependencies: `python3-evdev` ≥1.3.0, `gtksourceview4`, `python3-devel`, `python3-pydantic`, `python3-pydbus`
Python packages need to be installed globally for the service to be able to import them. Don't use `--user`
Conda can cause problems due to changed python paths and versions.
If it doesn't seem to install, you can also try `sudo python3 setup.py install`
```bash
sudo pip install evdev -U # If newest version not in distros repo
sudo pip uninstall key-mapper # In case the old package is still installed
sudo pip install --no-binary :all: git+https://github.com/sezanzeb/input-remapper.git
sudo systemctl enable input-remapper
sudo systemctl restart input-remapper
```
## Migrating beta configs to version 2
By default, Input Remapper will not migrate configurations from the beta.
If you want to use those you will need to copy them manually.
```bash
rm ~/.config/input-remapper-2 -r
cp ~/.config/input-remapper/beta_1.6.0-beta ~/.config/input-remapper-2 -r
```
Then start input-remapper