hyprland-plugins/README.md

63 lines
1.6 KiB
Markdown
Raw Normal View History

2023-02-27 15:01:11 +01:00
# hyprland-plugins
2023-02-27 15:02:21 +01:00
This repo houses official plugins for Hyprland.
2023-10-29 21:00:17 +01:00
> [!IMPORTANT]
2023-12-13 02:16:25 +01:00
> 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.
2023-10-29 21:00:17 +01:00
2023-02-27 15:02:21 +01:00
# Plugin list
2023-02-27 16:25:21 +01:00
- borders-plus-plus -> adds one or two additional borders to windows
2023-02-27 15:02:21 +01:00
- csgo-vulkan-fix -> fixes custom resolutions on CS:GO with `-vulkan`
2023-02-28 21:30:51 +01:00
- hyprbars -> adds title bars to windows
2024-04-03 20:14:34 +02:00
- hyprexpo -> adds an expo-like workspace overview
2023-11-04 01:54:08 +01:00
- hyprtrails -> adds smooth trails behind moving windows
2023-11-24 22:13:34 +01:00
- hyprwinwrap -> clone of xwinwrap, allows you to put any app as a wallpaper
2024-12-19 21:35:00 +01:00
- xtra-dispatchers -> adds some new dispatchers
2023-02-27 15:02:21 +01:00
2023-11-02 18:31:30 +01:00
# Nix
To use these plugins, it's recommended that you are already using the
[Hyprland flake](https://github.com/hyprwm/Hyprland).
First, add this flake to your inputs:
```nix
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:
```nix
{inputs, pkgs, ...}: {
wayland.windowManager.hyprland = {
enable = true;
# ...
plugins = [
inputs.hyprland-plugins.packages.${pkgs.system}.hyprbars
# ...
];
};
}
```
2023-02-27 15:02:21 +01:00
# Contributing
Feel free to open issues and MRs with fixes.
2023-11-02 18:31:30 +01:00
If you want your plugin added here, contact vaxry beforehand.