Skip to content

Latest commit

 

History

History
86 lines (58 loc) · 3.57 KB

README.md

File metadata and controls

86 lines (58 loc) · 3.57 KB
Raw

hyprdim

hyprdim is a daemon that automatically dims windows in Hyprland when switching between them.

Features

  • Easily see which window has focus, even with subtle or no borders.
  • Windows only dim when switching windows, eliminating the need to toggle dim on/off when you want to see other windows.
  • Prevent windows from being dimmed if there are no other visible windows in a workspace.
  • Prevent windows from being dimmed when toggling special workspaces.
  • Dim background windows when dialog windows open.

Installation

hyprdim has official support for NixOS, Arch Linux (AUR), and Fedora (Copr).

Packaging status

NixOS (Recommended)

Add hyprdim to your systemPackages and rebuild.

{ pkgs, ... }:

{
  environment.systemPackages = with pkgs; [
    hyprdim
  ];
}

Alternatively, use nix run nixpkgs#hyprdim to start hyprdim without installing it.

Arch Linux (AUR)

Use an AUR helper like yay to install hyprdim.

yay hyprdim

Fedora (Copr)

hyprdim is available in the solopasha/hyprland Copr repository.

sudo dnf copr enable solopasha/hyprland && sudo dnf install hyprdim

Other distributions

Follow the install guide for Rust. Then, use cargo to install hyprdim.

cargo install --git https://github.com/donovanglover/hyprdim --tag 3.0.0

Make sure $HOME/.cargo/bin is in your $PATH if it isn't already.

Usage

Usage: hyprdim [OPTIONS]

Options:
  -s, --strength <STRENGTH>      A value from 0 (no dim) to 1 (maximum dim) [default: 0.4]
  -d, --duration <DURATION>      How many milliseconds to wait before removing dim [default: 800]
  -f, --fade <FADE>              Fade animation speed from 0 (instantaneous) to 255 (very slow) [default: 7]
  -b, --bezier <BEZIER>          Bezier curve used for the animation [default: default]
  -D, --dialog-dim <DIALOG_DIM>  Strength of dim for windows that are the same class and floating [default: 0.7]
  -v, --verbose                  Show information about what hyprdim is doing
  -h, --help                     Print help (see more with '--help')
  -V, --version                  Print version

Contributing

Use cargo clippy, cargo fmt, and cargo test to check your work.

Thanks