Skip to content

iberianpig/fusuma-plugin-keypress

Repository files navigation

Fusuma::Plugin::Keypress Gem Version Build Status

Keyboard + Touchpad combination plugin for 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 version 1.4 or later.

$ 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.

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 code of conduct.

License

The gem is available as open source under the terms of the MIT License.

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.