Plover output plugin for linux using uinput

This plugin directly emulates the keyboard using uinput, which is present on most linux distributions. This means that it will work on X11, wayland and even in the tty.

Setup

Add your user to the input group, and install this udev rule:

KERNEL=="uinput", GROUP="input", MODE="0660", OPTIONS+="static_node=uinput"

Set the PLOVER_UINPUT_LAYOUT environment variable to your two-letter xkb keyboard layout, for example us, no or fr. This is not necessary if you're using a US keyboard.

Issues

Unicode characters

If you want to use unicode characters, either iBus or fcitx5 has to be installed. You might have to increase the key press delay in plover if some characters do not output properly.

Other issues

If you encounter any other problems, feel free to open an issue, pull request or send a message on discord (lilleaila)! Before asking for help, please check if the plugin is enabled in the settings.

Inspired by:

• halbGefressen/plover-output-dotool
• svenkeidel/plover-wtype-output

TODO

• Implement keyboard capture
• Make it easier to install udev rules
• Add a github action for publishing to PyPi

Copyright (c) 2024 LilleAila

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.