https://github.com/tremeschin/nvibrant
🟢 Nvidia Digital Vibrance on Wayland
https://github.com/tremeschin/nvibrant
nvidia nvidia-gpu nvidia-modeset nvidia-settings open-gpu-kernel-modules wayland
Last synced: 5 days ago
JSON representation
🟢 Nvidia Digital Vibrance on Wayland
- Host: GitHub
- URL: https://github.com/tremeschin/nvibrant
- Owner: Tremeschin
- License: gpl-3.0
- Created: 2025-03-27T15:13:11.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2026-02-28T17:24:46.000Z (11 days ago)
- Last Synced: 2026-03-01T01:17:22.839Z (11 days ago)
- Topics: nvidia, nvidia-gpu, nvidia-modeset, nvidia-settings, open-gpu-kernel-modules, wayland
- Language: C++
- Homepage:
- Size: 135 KB
- Stars: 173
- Watchers: 1
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: license.txt
Awesome Lists containing this project
README
> [!NOTE]
> This project is complete and stable, no actions are needed unless a driver update breaks it!
nvibrant
Configure Nvidia's Digital Vibrance on Wayland
## 🔥 Description
NVIDIA GPUs have a nice feature called *Digital Vibrance* that increases the colors saturation of the display. The option is readily available on [nvidia-settings](https://github.com/NVIDIA/nvidia-settings/) in Linux, but is too coupled with `libxnvctrl`, making it softly "exclusive" to the X11 display server over wayland; but I paid for my pixels to glow :^)
An interesting observation is that the setting persists after modifying it on X11 and then switching to Wayland. I theorized [(1)](https://github.com/libvibrant/vibrantLinux/issues/27#issuecomment-2729822152) [(2)](https://www.reddit.com/r/archlinux/comments/1gx1hir/comment/mhpe2pk/?context=3) it was possible to call some shared library or interface to configure it directly in their driver, independently of the display server, and indeed, it is possible!
This repository uses `nvidia-modeset` and `nvkms` headers found at [nvidia/open-gpu-kernel-modules](https://github.com/NVIDIA/open-gpu-kernel-modules/) to make [ioctl](https://en.wikipedia.org/wiki/Ioctl) calls in the `/dev/nvidia-modeset` device for configuring display attributes. These headers are synced with the proprietary releases, should work fine if you're on any of `nvidia-dkms`, `nvidia-open` or `nvidia`.
**Note**: A future, and intended way, will be through [NVML](https://developer.nvidia.com/management-library-nvml), as evident by some [nvidia-settings](https://github.com/NVIDIA/nvidia-settings/blob/6c755d9304bf4761f2b131f0687f0ebd1fcf7cd4/src/libXNVCtrlAttributes/NvCtrlAttributesNvml.c#L1235) comments
❤️ Consider [supporting](https://github.com/sponsors/Tremeschin/) my work, this took 26 hours to figure out, implement, write a readme, make it convenient 🫠
## 📦 Installation
There's multiple ways to get nvibrant, do check the [usage](#-usage) and [autostarting](#-autostarting) sections afterwards!
### 🔴 Python package
This utility [finds the best](https://github.com/Tremeschin/nvibrant/blob/4d9cc065f13c8110e5dd22368715ff07299b8192/nvibrant/__init__.py#L73-L95) nvibrant binary for your driver, already bundled in the package for all known [tags](https://github.com/NVIDIA/open-gpu-kernel-modules/tags) at release time. Simply install the [`pypi/nvibrant`](https://pypi.org/project/nvibrant/) package, where [`uvx`](https://docs.astral.sh/uv/) • [`tools`](https://docs.astral.sh/uv/concepts/tools/) usage is recommended:
```sh
# With standard python tooling
$ python3 -m pip install nvibrant
$ python3 -m nvibrant 512 512
# Always latest, simpler
$ uvx nvibrant 512 512
```
For more stability, pin to a specific version and only update for new features or newer drivers support:
```sh
$ python3 -m pip install nvibrant==1.2.0
$ uvx nvibrant==1.2.0 (args)
```
Note: This package is an official release channel for nvibrant
### 🟡 Package manager
Install from your distro's package manager, it may use the python package at system level:
Distro
Installation
Maintainer
Arch Linux
Install the nvibrant-bin AUR package:
@Incognitux
Nix Flakes
Use the nix-nvibrant flake.
See repo for instructions.
@mikaeladev
Fedora
Install the nvibrant rpm.
See repo for instructions.
@ykshek
...
...
Help me by packaging for your distro!
❤️ Thanks to all maintainers for your work! ❤️
You 🙂
Obligatory: Community packages are often safe, but not always checked by me
### 🟢 Prebuilt binaries
You can download all builds made by GitHub Actions in the [releases](https://github.com/Tremeschin/nvibrant/releases) page as `.whl` zips, eg. extract with:
```sh
# Selective unzip and ensure executable files
unzip -j "nvibrant-*.whl" "nvibrant/resources/*" -d bin
chmod +x "bin/*"
```
Run them directly as `./bin/nvibrant-$driver (...)`
> [!NOTE]
> There is some level of compatibility across different nvibrant and driver versions, as the related code is mostly stable on nvidia's side. Always prefer using the closest, but not newer, version to your driver!
> - **Example**: Running `nvibrant-575.51.03` on driver `v575.64.03` works
> - This is automatically handled by the python utility, hence the strong recommendation :)
### 🔵 Build it yourself
**Requirements**: Have `git`, `gcc` compilers; `meson` and `ninja` are included on `python` dependencies
```sh
# Clone the code alongside open-gpu-kernel-modules
git clone https://github.com/Tremeschin/nvibrant && cd nvibrant
git submodule update --init
```
From here, you can either build only the C++ part for a target driver:
```sh
# Any tag from https://github.com/NVIDIA/open-gpu-kernel-modules/tags
$ cd open-gpu && git checkout 575.64.03 && cd ..
# Configure and compile project, final binary at 'build' directory
$ meson setup --buildtype release ./build && ninja -C ./build
$ ./build/nvibrant 512 512
```
Or make a wheel for all drivers at `dist/*` for your host platform:
```sh
$ uv build --wheel
```
## 🚀 Usage
**Inputs**: Vibrance Levels are numbers from `-1024` to `1023` that determines the intensity of the effect. Zero being the "no effect" (default at boot), `-1024` grayscale, and `1023` max saturation (200%)
The values are passed as arguments to `nvibrant`'s binary, matching the _order of physical ports_ in your GPU (not the index of the video server). For example, I have two monitors on HDMI and DisplayPort in an RTX 3060 first two outputs, to set vibrance to `512` and `1023`, respectively, I would run:
```sh
$ nvibrant 512 1023
Display 0:
• (0, HDMI) • Set Vibrance ( 512) • Success
• (1, DP ) • Set Vibrance ( 1023) • Success
• (2, DP ) • Set Vibrance ( 0) • None
...
```
Note: You might need to set `nvidia_drm.modeset=1` kernel parameter, but I think it's enabled by default on recent drivers.
If a value is not passed for the Nth physical output, nvibrant will default to zero. When no argument is passed, it will effectively clear the vibrance for all outputs. `None` means the output is disconnected.
✅ You might have a display at the later ports, in which case use as:
```sh
$ nvibrant 0 0 0 1023
Display 0:
• (0, HDMI) • Set Vibrance ( 0) • None
• (1, DP ) • Set Vibrance ( 0) • None
• (2, DP ) • Set Vibrance ( 0) • None
• (3, DP ) • Set Vibrance ( 1023) • Success
• (4, DP ) • Set Vibrance ( 0) • None
```
### 🔴 Autostarting
For simplicity, a Systemd user service running either [`uvx`](https://docs.astral.sh/uv/concepts/tools/) for the latest releases (in case of driver updates), or a [prebuilt binary](https://github.com/Tremeschin/nvibrant/releases) directly should cover most users, plus it integrates well with [dotfiles](https://github.com/Tremeschin/DotFiles/blob/main/.config/systemd/user/nvibrant.service) repositories!
Create a file at `~/.config/systemd/user/nvibrant.service` with the content:
```ini
[Unit]
Description=Apply nvibrant
After=graphical.target
[Service]
Type=oneshot
ExecStartPre=/bin/sleep 5
ExecStart=uvx nvibrant 1023 1023
[Install]
WantedBy=default.target
```
Enable the service with `systemctl --user enable --now nvibrant.service`
- You can also pin it to a specific version with `uvx nvibrant==1.2.0 (args)` to have more control
- Or a C++ binary at `~/.local/bin/nvibrant` and use `ExecStart=%h/.local/bin/nvibrant (args)`
- Sleeping for a few seconds can prevent racing conditions with the display server starting up
Another option is to use [uv tools](https://docs.astral.sh/uv/concepts/tools/) for manual control and/or offline usage:
- Run `uv tool install nvibrant` once (upgrade with `uv tool update nvibrant`)
- Use `ExecStart=uv tool run nvibrant (args)` in the service
### 🟡 Laptops, Hybrid Systems
Chime in https://github.com/Tremeschin/nvibrant/issues/22
### 🟢 Dithering
Some users have reported issues with dithering causing flickering or artifacts on their displays [(1)](https://github.com/Tremeschin/nvibrant/issues/18) [(2)](https://www.reddit.com/r/linux_gaming/comments/1jmsva0/comment/mkehyuk/), which also lacks a Wayland option to disable in `nvidia-settings`. Fear not, you can change it with nvibrant too!
- **Run**: `ATTRIBUTE=dithering uvx nvibrant` to disable it on all displays (v1.1+)
Minor quirk, here's the values meanings, default is 2:
```cpp
enum NvKmsDpyAttributeRequestedDitheringValue {
...AUTO = 0,
...ENABLED = 1,
...DISABLED = 2,
};
```
### 🔵 Multiple GPUs
If you have multiple devices, specify a `NVIDIA_GPU=N` index:
```sh
$ NVIDIA_GPU=1 nvibrant 0 100
Display 0:
• (0, HDMI) • Set Vibrance ( 0) • Success
• (1, DP ) • Set Vibrance ( 100) • Success
```
## Common Issues
Please [report](https://github.com/Tremeschin/nvibrant/issues) unknown or unlisted issues to be added here!
- If you get a _"Driver version mismatch"_ or `ioctl` errors, maybe try rebooting (if you haven't) since the last driver update. Otherwise, you can force the version with `NVIDIA_DRIVER_VERSION=x.y.z`. It must match what `/dev/nvidia-modeset` expects and is currently loaded in the kernel.
- Ensure you have the `nvidia-modeset` kernel module loaded, as it is required for the ioctl calls to work. You can check this with `lsmod | grep nvidia`. Else, add it to your kernel boot parameters.
- It's possible that nvibrant may fail on future or older drivers due to differences between the internal structs and enums in the latest `nvkms` headers, hit me up for a patch release!