# 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](https://github.com/halbGefressen/plover-output-dotool)
- [svenkeidel/plover-wtype-output](https://github.com/svenkeidel/plover-wtype-output/tree/main)
# 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/LilleAila/plover-uinput",
"name": "plover-uinput",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "plover plover_plugin",
"author": "LilleAila",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/1b/35/6ace19ad459c1c87bcf25bdfd44f8e71f8fe7fae1e29c0b2c81c72c5244a/plover_uinput-0.0.15.tar.gz",
"platform": null,
"description": "# Plover output plugin for linux using uinput\nThis 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.\n\n## Setup\nAdd your user to the `input` group, and install this `udev` rule:\n```\nKERNEL==\"uinput\", GROUP=\"input\", MODE=\"0660\", OPTIONS+=\"static_node=uinput\"\n```\nSet 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.\n\n## Issues\n### Unicode characters\nIf 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.\n\n### Other issues\nIf 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.\n\n## Inspired by:\n- [halbGefressen/plover-output-dotool](https://github.com/halbGefressen/plover-output-dotool)\n- [svenkeidel/plover-wtype-output](https://github.com/svenkeidel/plover-wtype-output/tree/main)\n\n# TODO\n- [ ] Implement keyboard capture\n- [ ] Make it easier to install udev rules\n- [ ] Add a github action for publishing to PyPi\n\nCopyright (c) 2024 LilleAila\n\nPermission 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:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE 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.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Plover output plugin for linux using evdev / uinput",
"version": "0.0.15",
"project_urls": {
"Homepage": "https://github.com/LilleAila/plover-uinput"
},
"split_keywords": [
"plover",
"plover_plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8e417b5d72bd4d9f1cfa78903f069950f7e897e9ad91880b1062d50199a8c74f",
"md5": "52365ae6bff6de8b8ab75221f376d43b",
"sha256": "6f455bf268d5fe4f1836e8ea49d9cbc25d6bf99baf3500b52cf3d3cf3f5481e2"
},
"downloads": -1,
"filename": "plover_uinput-0.0.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "52365ae6bff6de8b8ab75221f376d43b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11255,
"upload_time": "2024-09-01T20:17:46",
"upload_time_iso_8601": "2024-09-01T20:17:46.590830Z",
"url": "https://files.pythonhosted.org/packages/8e/41/7b5d72bd4d9f1cfa78903f069950f7e897e9ad91880b1062d50199a8c74f/plover_uinput-0.0.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1b356ace19ad459c1c87bcf25bdfd44f8e71f8fe7fae1e29c0b2c81c72c5244a",
"md5": "5987519d2b4468ec29d3c70043986741",
"sha256": "7f87aa0f8115ca5d42d25cd1dd3b72fa1a95d81eaeb2695c635c510071a5e8f2"
},
"downloads": -1,
"filename": "plover_uinput-0.0.15.tar.gz",
"has_sig": false,
"md5_digest": "5987519d2b4468ec29d3c70043986741",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 11020,
"upload_time": "2024-09-01T20:17:48",
"upload_time_iso_8601": "2024-09-01T20:17:48.544274Z",
"url": "https://files.pythonhosted.org/packages/1b/35/6ace19ad459c1c87bcf25bdfd44f8e71f8fe7fae1e29c0b2c81c72c5244a/plover_uinput-0.0.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-01 20:17:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "LilleAila",
"github_project": "plover-uinput",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "plover-uinput"
}