Skip to content

hyprwm/hyprland-plugins

Repository files navigation

hyprland-plugins

This repo houses official plugins for Hyprland.

Plugin list

  • borders-plus-plus -> adds one or two additional borders to windows
  • csgo-vulkan-fix -> fixes custom resolutions on CS:GO with -vulkan
  • hyprbars -> adds title bars to windows
  • hyprexpo -> adds an expo-like workspace overview
  • hyprfocus -> flashfocus for hyprland
  • hyprscrolling -> adds a scrolling layout to hyprland
  • hyprtrails -> adds smooth trails behind moving windows
  • hyprwinwrap -> clone of xwinwrap, allows you to put any app as a wallpaper
  • xtra-dispatchers -> adds some new dispatchers

Install

Important

hyprland-plugins only officially supports installation via hyprpm. hyprland-plugins follows hyprland-git and requires you to be on hyprland-git or tagged >= v0.33.1.

Install with hyprpm

To install these plugins, from the command line run:

hyprpm update

Then add this repository:

hyprpm add https://github.com/hyprwm/hyprland-plugins

then enable the desired plugin with

hyprpm enable <plugin-name>

See the respective README's in the subdirectories for configuration options.

See the plugins wiki and hyprpm -h for more details.

Install on Nix

To use these plugins, it's recommended that you are already using the Hyprland flake. First, add this flake to your inputs:

inputs = {
  # ...
  hyprland.url = "github:hyprwm/Hyprland";
  hyprland-plugins = {
    url = "github:hyprwm/hyprland-plugins";
    inputs.hyprland.follows = "hyprland";
  };

  # ...
};

The inputs.hyprland.follows guarantees the plugins will always be built using your locked Hyprland version, thus you will never get version mismatches that lead to errors.

After that's done, you can use the plugins with the Home Manager module like this:

{inputs, pkgs, ...}: {
  wayland.windowManager.hyprland = {
    enable = true;
    # ...
    plugins = [
      inputs.hyprland-plugins.packages.${pkgs.system}.hyprbars
      # ...
    ];
  };
}

If you don't use Home Manager:

{ lib, pkgs, inputs, ... }:
with lib; let
  hyprPluginPkgs = inputs.hyprland-plugins.packages.${pkgs.system};
  hypr-plugin-dir = pkgs.symlinkJoin {
    name = "hyrpland-plugins";
    paths = with hyprPluginPkgs; [
      hyprexpo
      #...plugins
    ];
  };
in
{
  environment.sessionVariables = { HYPR_PLUGIN_DIR = hypr-plugin-dir; };
}

And in hyprland.conf

# load all the plugins you installed
exec-once = hyprctl plugin load "$HYPR_PLUGIN_DIR/lib/libhyprexpo.so"

Contributing

Feel free to open issues and MRs with fixes.

If you want your plugin added here, contact vaxry beforehand.

About

Official plugins for Hyprland

Resources

License

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published