Skip to content

horriblename/hyprgrass

Hyprgrass

Gestures for your touch screen

Warning

Even though hyprgrass is mostly stable now, there used to be some bugs that render your touch device unusable until you unload the plugin/close Hyprland see issue #27, keep a keyboard in hand the first time you try this. This plugin is still in alpha, expect breaking changes!

Please open an issue if you find any bugs. Feel free to make a feature request if you have a suggestion.

Features/Roadmap

  • Workspace Swipe
  • Custom commands
  • Swipe From Edge
  • Multi-finger swipe

Installation

Dependencies

Besides Hyprland (duh), this plugin has the following dependencies:

glm

# build dependencies
meson
ninja

# extra dependencies for hyprgrass-pulse
libpulseaudio

Install via hyprpm

First, install all dependencies. Then, run these commands:

hyprpm add https://github.com/horriblename/hyprgrass
hyprpm enable hyprgrass

# optional integration with pulse-audio, see examples/hyprgrass-pulse/README.md
hyprpm enable hyprgrass-pulse

You can add exec-once = hyprpm reload -n to your hyprland config to have plugins loaded at startup. -n will make hyprpm send a notification if anything goes wrong (e.g. update needed)

see hyprland wiki for more info

Install via Hyprload

(hyprload is deprecated, please use hyprpm instead)

  1. install all dependencies

  2. install hyprload by following the instructions here

  3. put this in ~/.config/hypr/hyprload.toml:

    plugins = [
        "horriblename/hyprgrass",
    ]
  4. run this command:

    # install the plugins
    hyprctl dispatch hyprload install
    
    # load plugins
    hyprctl dispatch hyprload load

Manual compilation

meson setup build
ninja -C build

On the meson setup step you can pass these options:

  • -Dhyprgrass-pulse=true to enable building hyprgrass-pulse

Install via nix

Flakes are highly recommended (because I don't know how to do anything without them)

Put this in your flake.nix file:

{
   inputs = {
      # ...
      hyprland.url = "github:hyprwm/Hyprland";
      hyprgrass = {
         url = "github:horriblename/hyprgrass";
         inputs.hyprland.follows = "hyprland"; # IMPORTANT
      };
   };
}

and in your home-manager module:

wayland.windowManager.hyprland = {
   plugins = [
      inputs.hyprgrass.packages.${pkgs.system}.default

      # optional integration with pulse-audio, see examples/hyprgrass-pulse/README.md
      inputs.hyprgrass.packages.${pkgs.system}.hyprgrass-pulse
   ];
};

Configuration

See docs

Other touch screen goodies

Touch screen related tools I liked.

On-screen keyboards:

  • squeekboard: has auto show/hide but doesn't work well with IME (fcitx/IBus etc.)
  • wvkbd: relatively simple keyboard but still has most important features.
  • fcitx-virtual-keyboard-adapter: NOT a keyboard but an fcitx addon that auto show/hides any on-screen keyboard.

Miscellanaeious:

Acknowledgements

  • Special thanks to wayfire for the awesome wf-touch library!
  • Some parts are based on AOSP, licensed under Apache License 2.0
  • Example plugins are heavily based on Waybar, licensed under MIT License

About

hyprland plugin for touch screen gestures

Topics

Resources

License

BSD-3-Clause, Apache-2.0 licenses found

Licenses found

BSD-3-Clause
LICENSE
Apache-2.0
LICENSE.aosp

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 13