https://github.com/iberianpig/fusuma-plugin-keypress
Keypress combination plugin for Fusuma
https://github.com/iberianpig/fusuma-plugin-keypress
fusuma fusuma-plugin keyboard keypress linux
Last synced: about 1 year ago
JSON representation
Keypress combination plugin for Fusuma
- Host: GitHub
- URL: https://github.com/iberianpig/fusuma-plugin-keypress
- Owner: iberianpig
- License: mit
- Created: 2019-10-22T16:22:11.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-01-14T02:42:50.000Z (over 1 year ago)
- Last Synced: 2025-03-29T04:08:10.135Z (about 1 year ago)
- Topics: fusuma, fusuma-plugin, keyboard, keypress, linux
- Language: Ruby
- Homepage: https://github.com/iberianpig/fusuma#available-plugins
- Size: 78.1 KB
- Stars: 28
- Watchers: 4
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Fusuma::Plugin::Keypress [](https://badge.fury.io/rb/fusuma-plugin-keypress) [](https://github.com/iberianpig/fusuma-plugin-keypress/actions/workflows/main.yml)
Keyboard + Touchpad combination plugin for [Fusuma](https://github.com/iberianpig/fusuma)
* Customize gestures with modifier keys
* Supports multiple modifier key combinations
NOTE: **Note: This plugin reads key input from keyboard to identify pressed key and assign it to an action.**
## Installation
Run the following code in your terminal.
### Install fusuma-plugin-keypress
This plugin requires [Fusuma](https://github.com/iberianpig/fusuma#update) version 1.4 or later.
```sh
$ sudo gem install fusuma-plugin-keypress
```
## Properties
### Keypress
Add `keypress:` property in `~/.config/fusuma/config.yml`.
Keys following are available for `keypress`.
* `CAPSLOCK`
* `LEFTALT`
* `LEFTCTRL`
* `LEFTMETA`
* `LEFTSHIFT`
* `RIGHTALT`
* `RIGHTCTRL`
* `RIGHTSHIFT`
* `RIGHTMETA`
## Example
Set `keypress:` property and values under gesture in `~/.config/fusuma/config.yml`.
```yaml
swipe:
4:
up:
command: 'xdotool key super+s'
keypress:
LEFTMETA:
command: 'xdotool key --clearmodifiers XF86MonBrightnessUp'
LEFTMETA+LEFTALT:
command: 'xdotool key --clearmodifiers XF86AudioRaiseVolume'
down:
command: 'xdotool key super+a'
keypress:
LEFTMETA:
command: 'xdotool key --clearmodifiers XF86MonBrightnessDown'
LEFTMETA+LEFTALT:
command: 'xdotool key --clearmodifiers XF86AudioLowerVolume'
```
* Swipe up/down with four fingers while keypress LEFTMETA key to change display brightness.
* Swipe up/down with four fingers while keypress LEFTMETA and LEFTALT keys to change audio volume.
- If you want to combine a gesture with two keys, combine modifier keys with `+`
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/iberianpig/fusuma-plugin-keypress. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Fusuma::Plugin::Keypress project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/iberianpig/fusuma-plugin-keypress/blob/master/CODE_OF_CONDUCT.md).