Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/donovanglover/hyprdim
Automatically dim windows in Hyprland when switching between them.
https://github.com/donovanglover/hyprdim
hyprland linux rust
Last synced: 17 days ago
JSON representation
Automatically dim windows in Hyprland when switching between them.
- Host: GitHub
- URL: https://github.com/donovanglover/hyprdim
- Owner: donovanglover
- License: gpl-3.0
- Created: 2023-07-25T22:40:06.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2024-06-04T19:14:48.000Z (18 days ago)
- Last Synced: 2024-06-04T21:23:06.751Z (18 days ago)
- Topics: hyprland, linux, rust
- Language: Rust
- Homepage: https://donovan.is/hyprdim
- Size: 371 KB
- Stars: 22
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: .github/SECURITY.md
Lists
- awesome-hyprland - hyprdim
README
# hyprdim
hyprdim is a daemon that automatically dims windows in [Hyprland](https://hyprland.org/) 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).
[](https://repology.org/project/hyprdim/versions)
### [NixOS](https://wiki.nixos.org/wiki/Overview_of_the_NixOS_Linux_distribution) (Recommended)
Add [`hyprdim`](https://search.nixos.org/packages?channel=unstable&query=hyprdim) to your `systemPackages` and rebuild.
```nix
{ pkgs, ... }:
{
environment.systemPackages = with pkgs; [
hyprdim
];
}
```
Alternatively, use `nix run nixpkgs#hyprdim` to start hyprdim without installing it.
### [Arch Linux](https://archlinux.org/) (AUR)
Use an AUR helper like [yay](https://github.com/Jguer/yay) to install [`hyprdim`](https://aur.archlinux.org/packages/hyprdim).
```fish
yay hyprdim
```
### [Fedora](https://fedoraproject.org/) (Copr)
[`hyprdim`](https://copr.fedorainfracloud.org/coprs/solopasha/hyprland/package/hyprdim) is available in the [solopasha/hyprland](https://copr.fedorainfracloud.org/coprs/solopasha/hyprland) Copr repository.
```fish
sudo dnf copr enable solopasha/hyprland && sudo dnf install hyprdim
```
### Other distributions
Follow the [install guide](https://www.rust-lang.org/tools/install) for Rust. Then, use cargo to install hyprdim.
```fish
cargo install --git https://github.com/donovanglover/hyprdim --tag 2.2.5
```
Make sure `$HOME/.cargo/bin` is in your `$PATH` if it isn't already.
## Usage
```man
Usage: hyprdim [OPTIONS]
Options:
-s, --strength A value from 0 (no dim) to 1 (maximum dim) [default: 0.4]
-d, --duration How many milliseconds to wait before removing dim [default: 800]
-f, --fade Fade animation speed from 0 (instantaneous) to 255 (very slow) [default: 7]
-b, --bezier Bezier curve used for the animation [default: default]
-p, --persist Prevent dim_inactive from being disabled by `hyprctl reload` etc
-n, --no-dim-when-only Don't dim when switching to a workspace that only has one visible window
-i, --ignore-entering-special Don't dim when opening a special workspace
-I, --ignore-leaving-special Don't dim when closing a special workspace
-D, --dialog-dim [] Dim windows if they're the same class and floating (strength_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
As far as I'm aware, this software is bug free. That said, if you know how to do things better, feel free to open an issue or make a pull request.
## Thanks
- [Yavor Kolev](https://github.com/yavko), [Cyril Levis](https://github.com/cyrinux), and [contributors](https://github.com/hyprland-community/hyprland-rs/graphs/contributors) for [hyprland-rs](https://github.com/hyprland-community/hyprland-rs)
- [Kevin K.](https://github.com/kbknapp), [Ed Page](https://github.com/epage), and [contributors](https://github.com/clap-rs/clap/graphs/contributors) for [clap-rs](https://github.com/clap-rs/clap)
- [Antti Keränen](https://github.com/Detegr) and [contributors](https://github.com/Detegr/rust-ctrlc/graphs/contributors) for [rust-ctrlc](https://github.com/Detegr/rust-ctrlc)
- [Liu BoFan](https://github.com/WLBF) and [contributors](https://github.com/WLBF/single-instance/graphs/contributors) for [single-instance](https://github.com/WLBF/single-instance)