2017-09-22 00:30:56 -04:00
rusty-keys
2020-11-23 18:50:09 -05:00
==========
[](https://ci.moparisthe.best/job/moparisthebest/job/rusty-keys/job/master/)
2021-09-23 23:29:56 -04:00
low level keyboard mapper for linux and windows, with advanced caps lock and shift swapping behavior
2017-09-22 00:30:56 -04:00
2021-09-23 23:29:56 -04:00
This is the only keymapper I am aware of capable of implementing this layout, which I call Unix Programmer's Dvorak, which has been my daily driver since 2014:
2017-09-22 00:30:56 -04:00
The Problem
-----------
2017-11-17 00:03:45 -05:00
If you ever have mapped keys on linux, you know that there is the console keymap (loadkeys) and the X keymap (setxkbmap),
2017-09-22 00:30:56 -04:00
also things like SDL and Virtualbox grab the input directly and respect no maps. Lastly I want to revert to QWERTY when
holding ctrl so ctrl+c works just like normal, without remapping all programs to ctrl+j. Linux keymaps cannot do this either.
The Solution
------------
1. Grab a keyboard device directly so only we can read events from it.
2017-11-17 00:03:45 -05:00
2. Create a new keyboard input device with uinput, this looks identical to any other keyboard device to anything running on the box.
3. Read input_events from the real device, map them, send them to our created device.
2017-09-22 00:30:56 -04:00
2021-09-23 23:29:56 -04:00
This solution is what rusty-keys implements, it works in ttys, in X, in Wayland, in virtualbox even running windows or whatever,
2017-09-22 00:30:56 -04:00
on SDL games, it will work literally everywhere, because rusty-keys just creates a regular keyboard.
How to run
----------
2017-11-17 00:03:45 -05:00
When ran, it will read a keymap.toml configuration file, refer to example and tweak to suit.
2016-04-25 17:57:45 +02:00
```
2017-11-17 00:03:45 -05:00
Usage: rusty-keys [options] [device_files...]
2017-09-22 00:30:56 -04:00
Options:
-h, --help prints this help message
-v, --version prints the version
2017-11-17 00:03:45 -05:00
-c, --config FILE specify the keymap config file to use (default:
/etc/rusty-keys/keymap.toml)
2017-09-22 00:30:56 -04:00
```
2017-11-17 00:03:45 -05:00
when ran without specifying input devices, it maps all currently connected keyboards, and watches /dev/input/ with
inotify and starts mapping any new keyboards that are plugged in forever, until you kill it:
2017-09-22 00:30:56 -04:00
`rusty-keys`
2017-11-17 00:03:45 -05:00
or you can specify one or multiple input devices, and it will run until all are disconnected, then stop:
`rusty-keys /dev/input/event0` or `rusty-keys /dev/input/event0 /dev/input/event2`
2017-09-22 00:30:56 -04:00
2017-11-17 00:03:45 -05:00
An example systemd service is in systemd/rusty-keys.service, enable it to have mapped keyboards all the time.
2017-09-22 23:57:26 -04:00
How to install
--------------
* `cargo install rusty-keys`
2017-11-17 00:03:45 -05:00
* Arch Linux [rusty-keys ](https://aur.archlinux.org/packages/rusty-keys/ ) [rusty-keys-git ](https://aur.archlinux.org/packages/rusty-keys-git/ )
2021-09-23 23:29:56 -04:00
* Download a static binary for your system from the [releases ](https://code.moparisthebest.com/moparisthebest/rusty-keys/releases ) section. [github mirror ](https://github.com/moparisthebest/rusty-keys/releases )
2017-09-22 23:57:26 -04:00
2017-09-22 00:30:56 -04:00
License
-------
AGPLv3 for now, message me if you have a problem with this
Notes
-----
Technically this is a re-implementation of a [previous ](https://code.moparisthebest.com/moparisthebest/uinput-mapper/src/master/uinputmapper/keymapper.py ) [python ](https://code.moparisthebest.com/moparisthebest/uinput-mapper/src/master/keymaps/dvorak.py ) [program ](https://code.moparisthebest.com/moparisthebest/uinput-mapper/src/master/input-read#L151 )
I had been using for 3 years previously.
