Skip to content

Installation

Before you start

Core nvibrant is a pure a C++ binary targeting a specific nvidia driver, which may work across future major versions (590.xx, 595.xx, etc), but will eventually break on nvidia's open-gpu changes.

  • For supporting transitional periods, older drivers (LTS, distros) and GPUs, a solution is to make and bundle files for all known drivers at release time, and chose a best one dynamically at runtime.

  • Don't panic when it breaks, follow this FAQ section for a workaround and asking a patch release.

There's multiple ways to get nvibrant, pick your choice:

  • Python Registry: Main release channel, small utility to find a best binary for the current driver from bundled wheel resources. (Recommended, official release channel)

  • Package Manager: Community packaging effort for native management in your distro, may use the same python utility or alternative 'wrappers' such as a bash script instead.

  • Workflow Builds: Download prebuilt assets from the GitHub Actions release Workflow, same files uploaded on PyPI via Trusted Publishing, with Immutable Releases.

  • Source Build: Make it yourself from the source code, pure C++ or Python utility.

  • Community: Derivative work, such as TUIs, GUIs, Integrations, etc.

After installing, go for the Documentation section above for usage, autostarting, etc!