Compare commits
1 Commits
77c96e887b
...
3c348d13dd
| Author | SHA1 | Date |
|---|---|---|
Simon Vedaa
|
3c348d13dd |
|
|
@ -118,7 +118,7 @@ set.
|
|||
|
||||
## Workspaces
|
||||
|
||||
You have nine choices:
|
||||
You have eight choices:
|
||||
|
||||
- ID: e.g. `1`, `2`, or `3`
|
||||
|
||||
|
|
@ -132,7 +132,7 @@ You have nine choices:
|
|||
|
||||
- Name: e.g. `name:Web`, `name:Anime` or `name:Better anime`
|
||||
|
||||
- Previous workspace: `previous`, or `previous_per_monitor`
|
||||
- Previous workspace: `previous`
|
||||
|
||||
- First available empty workspace: `empty`, suffix with `m` to only search on monitor. and/or `n` to make it the *next* available empty workspace. e.g. `emptynm`
|
||||
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ case, remove it completely.
|
|||
|
||||
**_Useful Optimizations_**:
|
||||
|
||||
- `decoration:blur:enabled = false` and `decoration:drop_shadow = false` to disable
|
||||
- `decoration:blur = false` and `decoration:drop_shadow = false` to disable
|
||||
fancy but battery hungry effects.
|
||||
|
||||
- `misc:vfr = true`, since it'll lower the amount of sent frames when nothing is
|
||||
|
|
|
|||
|
|
@ -112,8 +112,7 @@ A lot of apps will use Wayland by default. Chromium (and other browsers based on
|
|||
it or electron) don't. You need to pass
|
||||
`--enable-features=UseOzonePlatform --ozone-platform=wayland` to them or use
|
||||
`.conf` files where possible. Chromium-based browsers also should have a toggle
|
||||
in `chrome://flags`. Search for _"ozone"_ and select Wayland. If you are on NixOS
|
||||
you can also set the environment variable `NIXOS_OZONE_WL=1` in your configuration.
|
||||
in `chrome://flags`. Search for _"ozone"_ and select Wayland.
|
||||
|
||||
For most electron apps, you should put the above in
|
||||
`~/.config/electron-flags.conf`. VSCode is known to not work with that though.
|
||||
|
|
|
|||
|
|
@ -1,53 +0,0 @@
|
|||
---
|
||||
title: Contributing and Debugging
|
||||
---
|
||||
|
||||
Everything needed to build and debug Hyprland is included inside the provided
|
||||
`devShell`.
|
||||
|
||||
To use it in the cloned repo, simply run `nix develop`.
|
||||
|
||||
## Build in debug mode
|
||||
|
||||
A debug build is already provided through
|
||||
`hyprland.packages.${pkgs.stdenv.hostPlatform.system}.hyprland-debug`.
|
||||
|
||||
## Bisecting an issue
|
||||
|
||||
Follow the
|
||||
[Bisecting an issue](https://wiki.hyprland.org/Crashes-and-Bugs/#bisecting-an-issue)
|
||||
guide. To build, run `nix build '.?submodules=1'`.
|
||||
|
||||
To view logs, pass the `--print-build-logs` (`-L`) flag.
|
||||
|
||||
To keep a failed build directory, pass the `--keep-failed` flag.
|
||||
|
||||
## Building the Wayland stack with ASan
|
||||
|
||||
Run `nix develop` first, then follow the
|
||||
[Building with ASan](https://wiki.hyprland.org/Crashes-and-Bugs/#bisecting-an-issue)
|
||||
guide.
|
||||
|
||||
## Manual building
|
||||
|
||||
Nix works differently than other build systems, so it has its own abstractions
|
||||
over popular build systems such as Meson, CMake and Ninja.
|
||||
|
||||
In order to manually build Hyprland, you can run the following commands, while
|
||||
in the `nix develop` shell.
|
||||
|
||||
For CMake:
|
||||
|
||||
```bash
|
||||
$ cmakeConfigurePhase # to run the CMake configure phase
|
||||
$ ninjaBuildPhase # to run the Ninja build phase
|
||||
$ ninjaInstallPhase # to run the Ninja install phase
|
||||
```
|
||||
|
||||
For Meson:
|
||||
|
||||
```bash
|
||||
$ mesonConfigurePhase # to run the Meson configure phase
|
||||
$ ninjaBuildPhase # to run the Ninja build phase
|
||||
$ mesonInstallPhase # to run the Meson install phase
|
||||
```
|
||||
|
|
@ -8,11 +8,9 @@ For a list of available options, check the
|
|||
{{< callout >}}
|
||||
|
||||
- _(Required) NixOS Module_: enables critical components needed to run Hyprland
|
||||
properly. Without this, you may have issues with XDG Portals, or missing
|
||||
session files in your Display Manager.
|
||||
- _(Optional) Home Manager module_: lets you declaratively configure Hyprland
|
||||
|
||||
{{< /callout >}}
|
||||
properly
|
||||
- _(Optional) Home-manager module_: lets you declaratively configure Hyprland
|
||||
{{< /callout >}}
|
||||
|
||||
## Installation
|
||||
|
||||
|
|
@ -20,6 +18,9 @@ For a list of available options, check the
|
|||
|
||||
{{< tab "Home Manager" >}}
|
||||
|
||||
Home Manager has options for Hyprland without needing to import the Flake
|
||||
module.
|
||||
|
||||
```nix
|
||||
{
|
||||
wayland.windowManager.hyprland.enable = true;
|
||||
|
|
@ -65,9 +66,7 @@ Don't forget to replace `user@hostname` with your username and hostname!
|
|||
|
||||
modules = [
|
||||
hyprland.homeManagerModules.default
|
||||
{
|
||||
wayland.windowManager.hyprland.enable = true;
|
||||
}
|
||||
{wayland.windowManager.hyprland.enable = true;}
|
||||
# ...
|
||||
];
|
||||
};
|
||||
|
|
@ -108,7 +107,7 @@ in {
|
|||
wayland.windowManager.hyprland = {
|
||||
enable = true;
|
||||
|
||||
package = hyprland-flake.packages.${pkgs.stdenv.hostPlatform.system}.hyprland;
|
||||
package = hyprland-flake.packages.${pkgs.system}.hyprland;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
|
@ -120,11 +119,11 @@ in {
|
|||
## Usage
|
||||
|
||||
Once the module is enabled, you can use it to declaratively configure Hyprland.
|
||||
Here is an example config:
|
||||
Here is an example config, made to work with either the upstream Home Manager
|
||||
module, or the flake-based Home Manager module.
|
||||
|
||||
```nix
|
||||
# home.nix
|
||||
|
||||
{
|
||||
wayland.windowManager.hyprland.settings = {
|
||||
"$mod" = "SUPER";
|
||||
|
|
@ -155,20 +154,16 @@ Here is an example config:
|
|||
Hyprland plugins can be added through the `plugins` option:
|
||||
|
||||
```nix
|
||||
{
|
||||
wayland.windowManager.hyprland.plugins = [
|
||||
inputs.hyprland-plugins.packages.${pkgs.stdenv.hostPlatform.system}.hyprbars
|
||||
"/absolute/path/to/plugin.so"
|
||||
];
|
||||
}
|
||||
wayland.windowManager.hyprland.plugins = [
|
||||
inputs.hyprland-plugins.packages.${pkgs.system}.hyprbars
|
||||
"/absolute/path/to/plugin.so"
|
||||
];
|
||||
```
|
||||
|
||||
For examples on how to build Hyprland plugins using Nix, see the
|
||||
[Nix/Plugins](../Plugins) page.
|
||||
[official plugins](https://github.com/hyprwm/hyprland-plugins).
|
||||
|
||||
## FAQ
|
||||
|
||||
### Fixing problems with themes
|
||||
## Fixing problems with themes
|
||||
|
||||
If your themes for mouse cursors, icons or windows don't load correctly, try
|
||||
setting them with `home.pointerCursor` and `gtk.theme`, which enable a bunch of
|
||||
|
|
@ -177,37 +172,34 @@ compatibility options that should make the themes load in all situations.
|
|||
Example configuration:
|
||||
|
||||
```nix
|
||||
{
|
||||
home.pointerCursor = {
|
||||
gtk.enable = true;
|
||||
# x11.enable = true;
|
||||
package = pkgs.bibata-cursors;
|
||||
name = "Bibata-Modern-Classic";
|
||||
size = 16;
|
||||
home.pointerCursor = {
|
||||
gtk.enable = true;
|
||||
# x11.enable = true;
|
||||
package = pkgs.bibata-cursors;
|
||||
name = "Bibata-Modern-Classic";
|
||||
size = 16;
|
||||
};
|
||||
|
||||
gtk = {
|
||||
enable = true;
|
||||
theme = {
|
||||
package = pkgs.flat-remix-gtk;
|
||||
name = "Flat-Remix-GTK-Grey-Darkest";
|
||||
};
|
||||
|
||||
gtk = {
|
||||
enable = true;
|
||||
|
||||
theme = {
|
||||
package = pkgs.flat-remix-gtk;
|
||||
name = "Flat-Remix-GTK-Grey-Darkest";
|
||||
};
|
||||
|
||||
iconTheme = {
|
||||
package = pkgs.gnome.adwaita-icon-theme;
|
||||
name = "Adwaita";
|
||||
};
|
||||
|
||||
font = {
|
||||
name = "Sans";
|
||||
size = 11;
|
||||
};
|
||||
iconTheme = {
|
||||
package = pkgs.gnome.adwaita-icon-theme;
|
||||
name = "Adwaita";
|
||||
};
|
||||
}
|
||||
|
||||
font = {
|
||||
name = "Sans";
|
||||
size = 11;
|
||||
};
|
||||
};
|
||||
```
|
||||
|
||||
### Programs don't work in systemd services, but do on the terminal
|
||||
## Programs don't work in systemd services, but do on the terminal
|
||||
|
||||
This problem is related to systemd not importing the environment by default. It
|
||||
will not have knowledge of `PATH`, so it cannot run the commands in the
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ title: Hyprland on NixOS
|
|||
---
|
||||
|
||||
The NixOS module enables critical components needed to run Hyprland properly,
|
||||
such as polkit,
|
||||
such as: polkit,
|
||||
[xdg-desktop-portal-hyprland](https://github.com/hyprwm/xdg-desktop-portal-hyprland),
|
||||
graphics drivers, fonts, dconf, xwayland, and adding a proper Desktop Entry to
|
||||
your Display Manager.
|
||||
|
|
@ -14,9 +14,8 @@ Make sure to check out the options of the
|
|||
{{< callout >}}
|
||||
|
||||
- _(Required) NixOS Module_: enables critical components needed to run Hyprland
|
||||
properly. Without this, you may have issues with XDG Portals, or missing
|
||||
session files in your Display Manager.
|
||||
- _(Optional) Home Manager Module_: lets you declaratively configure Hyprland
|
||||
properly
|
||||
- _(Optional) Home-manager module_: lets you declaratively configure Hyprland
|
||||
|
||||
{{< /callout >}}
|
||||
|
||||
|
|
@ -27,12 +26,12 @@ Make sure to check out the options of the
|
|||
```nix
|
||||
# configuration.nix
|
||||
|
||||
{
|
||||
{pkgs, ...}: {
|
||||
programs.hyprland.enable = true;
|
||||
}
|
||||
```
|
||||
|
||||
This will use the Hyprland version included in the Nixpkgs release you're using.
|
||||
This will use the Hyprland version that Nixpkgs has.
|
||||
|
||||
{{< /tab >}}
|
||||
|
||||
|
|
@ -70,7 +69,7 @@ this:
|
|||
{inputs, pkgs, ...}: {
|
||||
programs.hyprland = {
|
||||
enable = true;
|
||||
package = inputs.hyprland.packages.${pkgs.stdenv.hostPlatform.system}.hyprland;
|
||||
package = inputs.hyprland.packages.${pkgs.system}.hyprland;
|
||||
};
|
||||
}
|
||||
```
|
||||
|
|
@ -78,7 +77,7 @@ this:
|
|||
Don't forget to change the `HOSTNAME` to your actual hostname!
|
||||
|
||||
If you start experiencing lag and FPS drops in games or programs like Blender on
|
||||
**stable** NixOS when using the Hyprland flake, it is most likely a `mesa`
|
||||
**stable** NixOS when using the Hyprland flake, it most likely is a `mesa`
|
||||
version mismatch between your system and Hyprland.
|
||||
|
||||
You can fix this issue by using `mesa` from Hyprland's `nixpkgs` input:
|
||||
|
|
@ -127,7 +126,7 @@ have to compile Hyprland yourself.
|
|||
in {
|
||||
programs.hyprland = {
|
||||
enable = true;
|
||||
package = hyprland.packages.${pkgs.stdenv.hostPlatform.system}.hyprland;
|
||||
package = hyprland.packages.${pkgs.system}.hyprland;
|
||||
};
|
||||
}
|
||||
```
|
||||
|
|
|
|||
|
|
@ -6,8 +6,7 @@ If you use Nix on distros other than NixOS, you can still use Hyprland.
|
|||
|
||||
The best option would be through [Home Manager](../Hyprland-on-Home-Manager).
|
||||
|
||||
However, if Home Manager is not for you, Hyprland can be installed as a normal
|
||||
package.
|
||||
However, if Home Manager is not for you, you can use it as a normal package.
|
||||
|
||||
First, [enable flakes](https://nixos.wiki/wiki/Flakes#Enable_flakes). Once you
|
||||
have flakes working, install Hyprland through `nix profile`:
|
||||
|
|
|
|||
|
|
@ -2,8 +2,8 @@
|
|||
title: Options & Overrides
|
||||
---
|
||||
|
||||
You can override the package through the `.override` or `.overrideAttrs`
|
||||
mechanisms. This is easily achievable on [NixOS](../Hyprland-on-NixOS) or
|
||||
You can override the package through `.override` or `.overrideAttrs`. This is
|
||||
easily achievable on [NixOS](../Hyprland-on-NixOS) or
|
||||
[Home Manager](../Hyprland-on-Home-Manager).
|
||||
|
||||
## Package options
|
||||
|
|
@ -14,7 +14,7 @@ be changed by setting the appropriate option to `true`/`false`.
|
|||
### Package
|
||||
|
||||
```nix
|
||||
(pkgs.hyprland.override { # or inputs.hyprland.packages.${pkgs.stdenv.hostPlatform.system}.hyprland
|
||||
(pkgs.hyprland.override { # or inputs.hyprland.packages.${pkgs.system}.hyprland
|
||||
enableXWayland = true; # whether to enable XWayland
|
||||
legacyRenderer = false; # whether to use the legacy renderer (for old GPUs)
|
||||
withSystemd = true; # whether to build with systemd support
|
||||
|
|
@ -24,12 +24,10 @@ be changed by setting the appropriate option to `true`/`false`.
|
|||
### NixOS & HM modules
|
||||
|
||||
```nix
|
||||
{
|
||||
programs.hyprland = { # or wayland.windowManager.hyprland
|
||||
enable = true;
|
||||
xwayland.enable = true;
|
||||
};
|
||||
}
|
||||
programs.hyprland = { # or wayland.windowManager.hyprland
|
||||
enable = true;
|
||||
xwayland.enable = true;
|
||||
};
|
||||
```
|
||||
|
||||
## Options descriptions
|
||||
|
|
@ -39,6 +37,10 @@ be changed by setting the appropriate option to `true`/`false`.
|
|||
XWayland is enabled by default in the Nix package. You can disable it either in
|
||||
the package itself, or through the module options.
|
||||
|
||||
### XWayland HiDPI
|
||||
|
||||
See [XWayland](../../Configuring/XWayland).
|
||||
|
||||
## Using Nix repl
|
||||
|
||||
If you're using Nix (and not NixOS or Home Manager) and you want to override,
|
||||
|
|
|
|||
|
|
@ -1,121 +0,0 @@
|
|||
---
|
||||
title: Plugins
|
||||
---
|
||||
|
||||
Hyprland plugins are managed differently on Nix than on other distros. The most
|
||||
notable change is that `hyprpm` is unsupported, but we have our own way of
|
||||
building plugins.
|
||||
|
||||
## Using plugins from Nixpkgs
|
||||
|
||||
In Nixpkgs, there are Hyprland plugins packaged for the Hyprland version in
|
||||
Nixpkgs. You can use them like this:
|
||||
|
||||
```nix
|
||||
{pkgs, ...}: {
|
||||
wayland.windowManager.hyprland.plugins = [
|
||||
pkgs.hyprlandPlugins.<plugin>
|
||||
];
|
||||
}
|
||||
```
|
||||
|
||||
You can find which plugins are included using
|
||||
`nix search nixpkgs#hyprlandPlugins`.
|
||||
|
||||
## hyprland-plugins
|
||||
|
||||
Official plugins made/maintained by vaxry.
|
||||
|
||||
To use these plugins, it is recommended that you are already using the Hyprland
|
||||
flake, and **not** the Nixpkgs version.
|
||||
|
||||
First, add the flake to your flake inputs:
|
||||
|
||||
```nix
|
||||
{
|
||||
inputs = {
|
||||
hyprland.url = "git+https://github.com/hyprwm/Hyprland?submodules=1";
|
||||
|
||||
hyprland-plugins = {
|
||||
url = "github:hyprwm/hyprland-plugins";
|
||||
inputs.hyprland.follows = "hyprland";
|
||||
};
|
||||
|
||||
# ...
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The `inputs.hyprland.follows` line makes hyprland-plugins use the exact Hyprland
|
||||
revision you have locked. This means there aren't any version mismatches, as
|
||||
long as you update both inputs at once.
|
||||
|
||||
The next step is adding the plugins to Hyprland:
|
||||
|
||||
```nix
|
||||
{inputs, pkgs, ...}: {
|
||||
wayland.windowManager.hyprland = {
|
||||
enable = true;
|
||||
|
||||
plugins = [
|
||||
inputs.hyprland-plugins.packages.${pkgs.stdenv.hostPlatform.system}.<plugin>
|
||||
];
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
## Building plugins with Nix
|
||||
|
||||
The plugins inside Nixpkgs, as well as the ones in `hyprland-plugins`, are built
|
||||
using a general function, `mkHyprlandPlugin`. Any plugin can be made to work
|
||||
with it. The general usage is presented below, exemplified through hy3's
|
||||
derivation:
|
||||
|
||||
```nix
|
||||
{pkgs, ...}: {
|
||||
hy3 = pkgs.callPackage ({
|
||||
lib,
|
||||
fetchFromGitHub,
|
||||
cmake,
|
||||
hyprland,
|
||||
hyprlandPlugins,
|
||||
}:
|
||||
hyprlandPlugins.mkHyprlandPlugin pkgs.hyprland {
|
||||
pluginName = "hy3";
|
||||
version = "0.39.1";
|
||||
|
||||
src = fetchFromGitHub {
|
||||
owner = "outfoxxed";
|
||||
repo = "hy3";
|
||||
rev = "hl0.39.1";
|
||||
hash = "sha256-PqVld+oFziSt7VZTNBomPyboaMEAIkerPQFwNJL/Wjw=";
|
||||
};
|
||||
|
||||
# any nativeBuildInputs required for the plugin
|
||||
nativeBuildInputs = [cmake];
|
||||
|
||||
# set any buildInputs that are not already included in Hyprland
|
||||
# by default, Hyprland and its dependencies are included
|
||||
buildInputs = [];
|
||||
|
||||
meta = {
|
||||
homepage = "https://github.com/outfoxxed/hy3";
|
||||
description = "Hyprland plugin for an i3 / sway like manual tiling layout";
|
||||
license = lib.licenses.gpl3;
|
||||
platforms = lib.platforms.linux;
|
||||
maintainers = with lib.maintainers; [aacebedo];
|
||||
};
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
In a similar manner to `stdenv.mkDerivation`, `mkHyprlandPlugin` takes an
|
||||
attrset with mostly the same options as `mkDerivation`, as it is essentially a
|
||||
wrapper around it.
|
||||
|
||||
The exception is that it also takes a `hyprland` package before the attrset, in
|
||||
case you want to build with a different package than the one in Nixpkgs.
|
||||
|
||||
This is not always the best way to build for a different version, and it is
|
||||
recommended that you use an overlay to apply your desired Hyprland package in
|
||||
Nixpkgs instead.
|
||||
|
|
@ -8,22 +8,27 @@ To install Hyprland on NixOS, we provide a NixOS and a Home Manager module.
|
|||
{{< callout title=Note >}}
|
||||
|
||||
- _(Required) NixOS Module_: enables critical components needed to run Hyprland
|
||||
properly. Without this, you may have issues with XDG Portals, or missing
|
||||
session files in your Display Manager.
|
||||
- _(Optional) Home Manager Module_: lets you declaratively configure Hyprland
|
||||
properly
|
||||
- _(Optional) Home-manager module_: lets you declaratively configure Hyprland
|
||||
|
||||
{{< /callout >}}
|
||||
|
||||
## NixOS module
|
||||
|
||||
The module is now upstreamed into Nixpkgs, which means all you need in your
|
||||
configuration is:
|
||||
|
||||
```nix
|
||||
{
|
||||
{config, pkgs, ...}: {
|
||||
programs.hyprland.enable = true;
|
||||
# Optional, hint electron apps to use wayland:
|
||||
# environment.sessionVariables.NIXOS_OZONE_WL = "1";
|
||||
}
|
||||
```
|
||||
|
||||
Note that the command to run hyprland is `Hyprland` (with a capital `H`) and not
|
||||
`hyprland`.
|
||||
|
||||
For more options, see
|
||||
[module options](https://search.nixos.org/options?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=hyprland).
|
||||
|
||||
|
|
|
|||
|
|
@ -11,72 +11,88 @@ have had success with the instructions on this page.
|
|||
You can choose between the proprietary
|
||||
[Nvidia drivers](https://wiki.archlinux.org/title/NVIDIA) or the open source
|
||||
[Nouveau driver](https://wiki.archlinux.org/title/Nouveau). For the
|
||||
proprietary drivers, there are 3 varieties: the current closed source driver
|
||||
named 'nvidia' (or 'nvidia-dkms') which is
|
||||
proprietary drivers, there are 3 of them: the current closed source driver
|
||||
named 'nvidia' (or 'nvidia-dkms' to use with custom linux kernels) which is
|
||||
under active development; the legacy closed source drivers 'nvidia-3xxxx' for older cards
|
||||
which Nvidia no longer actively supports; and the 'nvidia-open' driver which is
|
||||
currently an alpha stage attempt to open source a part of their closed source
|
||||
driver for newer cards.
|
||||
|
||||
If the proprietary drivers support your graphics card, it's generally recommended
|
||||
to use them instead, as it has significantly improved performance
|
||||
and power management for newer GPUs.
|
||||
to use them instead, as it includes significantly improved gaming performance
|
||||
and power management for recent GPUs.
|
||||
|
||||
However, keep in mind that if the proprietary Nvidia drivers do not work
|
||||
properly on your computer, the Nouveau driver might work fine. This will
|
||||
likely be the case for
|
||||
most likely be the case for
|
||||
[older cards](https://wiki.archlinux.org/title/NVIDIA#Unsupported_drivers).
|
||||
|
||||
## How to get Hyprland to possibly run on Nvidia (Proprietary)
|
||||
|
||||
Install the correct headers package for your current kernel. For the example of
|
||||
the `linux-zen` kernel on Arch Linux, this package would be `linux-zen-headers`.
|
||||
|
||||
Install the required nvidia packages. For most cases, this would be `nvidia-dkms`
|
||||
(or `nvidia-open-dkms` for the open source ones),
|
||||
and `nvidia-utils`. If you'd like to game via Wine or even natively, it would be
|
||||
in your best interest to also install `lib32-nvidia-utils`.
|
||||
|
||||
{{< callout >}}
|
||||
|
||||
The `nvidia-open` drivers are still not up to feature parity with the proprietary drivers.
|
||||
One issue is with [suspend](https://github.com/NVIDIA/open-gpu-kernel-modules/issues/472) (e.g. closing the lid on your laptop).
|
||||
Even if your GPU is listed as supported by the `nvidia-open-dkms` driver, at this
|
||||
point in time, it is still not up to feature parity with the current closed source drivers.
|
||||
One issue with the open drivers is that it could cause problems with suspend in
|
||||
general, let that be closing the lid on your laptop or by manually triggering one.
|
||||
Overall, you'd be better off with `nvidia-dkms` right now, but Hyprland should work
|
||||
similarly between the two.
|
||||
|
||||
{{< /callout >}}
|
||||
|
||||
# Proprietary drivers setup
|
||||
Take care to also install `egl-wayland` (`libnvidia-egl-wayland1` and
|
||||
`libnvidia-egl-gbm1` on Ubuntu) if you are using the proprietary drivers.
|
||||
It provides the necessary compatibility layer, instead of falling back to
|
||||
zink/Vulkan.
|
||||
|
||||
You can choose between the `nvidia` or the `nvidia-dkms` package. There are pros and cons
|
||||
for each, but it is generally recommended to use the `dkms` package,
|
||||
as you won't have to rebuild the initramfs [manually](https://wiki.archlinux.org/title/NVIDIA#mkinitcpio) every time the kernel and drivers update, for example.
|
||||
If you're using a kernel that isn't `linux` or `linux-lts`, the `dkms` package is *required*.
|
||||
Next up, you need to enable modeset for nvidia, this can be done via editing
|
||||
the kernel paramaters for your bootloader.
|
||||
|
||||
## Installation
|
||||
If you use [systemd-boot](https://wiki.archlinux.org/title/systemd-boot)
|
||||
you can do this adding `nvidia_drm.modeset=1` to the end of
|
||||
`/boot/loader/entries/arch.conf`. If you use
|
||||
[grub](https://wiki.archlinux.org/title/GRUB) you can do this by adding
|
||||
`nvidia_drm.modeset=1` to the end of `GRUB_CMDLINE_LINUX_DEFAULT=` in
|
||||
`/etc/default/grub`, then running `sudo grub-mkconfig -o /boot/grub/grub.cfg`.
|
||||
|
||||
Install the following packages:
|
||||
For others check out
|
||||
[kernel parameters](https://wiki.archlinux.org/title/Kernel_parameters) and how
|
||||
to add `nvidia_drm.modeset=1` to your specific bootloader.
|
||||
|
||||
1. `nvidia` or `nvidia-dkms`: The driver itself. Optionally, the open source drivers
|
||||
from NVIDIA can be installed as `nvidia-open` or `nvidia-open-dkms`.
|
||||
2. `nvidia-utils`: The userspace graphics drivers. You need this for running Vulkan
|
||||
applications. If you'd like to use apps like Steam or Wine, install `lib32-nvidia-utils` as well.
|
||||
3. `egl-wayland` (`libnvidia-egl-wayland1` and `libnvidia-egl-gbm1` on Ubuntu): This is required
|
||||
in order to enable compatibility between the EGL API and the Wayland protocol.
|
||||
{{< callout >}}
|
||||
|
||||
## DRM kernel mode setting
|
||||
There has been a lot of debate on which of `nvidia_drm` or `nvidia-drm`
|
||||
is correct for this kernel parameter. It has been confirmed that either
|
||||
of these will work.
|
||||
|
||||
Since NVIDIA does not load kernel mode setting by default, enabling it is
|
||||
required to make Wayland compositors function properly. To enable it, the NVIDIA
|
||||
driver modules need to be added to the initramfs.
|
||||
{{< /callout >}}
|
||||
|
||||
Edit `/etc/mkinitcpio.conf`. In the `MODULES` array, add the following module names:
|
||||
in `/etc/mkinitcpio.conf` add `nvidia nvidia_modeset nvidia_uvm nvidia_drm` to
|
||||
your `MODULES`
|
||||
|
||||
```ini
|
||||
MODULES=(... nvidia nvidia_modeset nvidia_uvm nvidia_drm ...)
|
||||
For example, a clean `MODULES` line would now look like this:
|
||||
```sh
|
||||
MODULES=(nvidia nvidia_modeset nvidia_uvm nvidia_drm)
|
||||
```
|
||||
|
||||
Then, create and edit `/etc/modprobe.d/nvidia.conf`. Add this line to the file:
|
||||
Now, run `sudo mkinitcpio -P`. This will regenerate the initcpios for all kernels
|
||||
currently installed on the system. If you see any errors here about missing
|
||||
nvidia modules, it is highly probable that you forgot to install the correct
|
||||
headers package. Make sure you install the headers package for your kernel and
|
||||
run this command again.
|
||||
|
||||
```ini
|
||||
options nvidia_drm modeset=1 fbdev=1
|
||||
```
|
||||
More information is available here:
|
||||
[https://wiki.archlinux.org/title/NVIDIA#DRM_kernel_mode_setting](https://wiki.archlinux.org/title/NVIDIA#DRM_kernel_mode_setting)
|
||||
|
||||
Lastly, rebuild the initramfs with `sudo mkinitcpio -P`, and reboot.
|
||||
|
||||
More information is available [here](https://wiki.archlinux.org/title/NVIDIA#DRM_kernel_mode_setting).
|
||||
|
||||
## Environment variables
|
||||
|
||||
Add these variables to your Hyprland config:
|
||||
Export these variables in your hyprland config:
|
||||
|
||||
```sh
|
||||
env = LIBVA_DRIVER_NAME,nvidia
|
||||
|
|
@ -96,11 +112,8 @@ Do not set it in your configs. Use `cursor:no_hardware_cursors` instead.
|
|||
|
||||
{{< /callout >}}
|
||||
|
||||
## Finishing up
|
||||
|
||||
Install a few packages to get some apps to function natively with Wayland for the
|
||||
best compatibility and performance.
|
||||
See the [the Master Tutorial](https://wiki.hyprland.org/Getting-Started/Master-Tutorial/#force-apps-to-use-wayland).
|
||||
Lastly, you also need to install a few packages to get some apps
|
||||
to function natively with Wayland. Have a look at [the Master Tutorial](https://wiki.hyprland.org/Getting-Started/Master-Tutorial/#force-apps-to-use-wayland).
|
||||
|
||||
Reboot your computer.
|
||||
|
||||
|
|
@ -110,27 +123,35 @@ It _should_ work now.
|
|||
|
||||
## VA-API hardware video acceleration
|
||||
|
||||
Hardware video acceleration on Nvidia and Wayland is possible with the
|
||||
We can achieve VA-API acceleration on Nvidia and Wayland with the help of the
|
||||
[nvidia-vaapi-driver](https://github.com/elFarto/nvidia-vaapi-driver). This may
|
||||
solve specific issues in Electron apps.
|
||||
solve certain issues in Electron apps, and it will also allow for GPU decoding
|
||||
for videos on the web, with benefits including higher performance video playback
|
||||
and also higher power efficiency during video playback.
|
||||
|
||||
The install instructions are available in the README, however, a quick guide will
|
||||
Its install instructions are available in the README, however, a quick guide will
|
||||
be given here:
|
||||
|
||||
1. Install the package. On Arch, this is `libva-nvidia-driver` in the official
|
||||
- Install the package. On Arch, this is `libva-nvidia-driver` in the official
|
||||
repos.
|
||||
|
||||
2. Add this variable to your hyprland config:
|
||||
```sh
|
||||
env = NVD_BACKEND,direct
|
||||
```
|
||||
- export this variable in your hyprland config:
|
||||
```sh
|
||||
env = NVD_BACKEND,direct
|
||||
```
|
||||
see [here](https://github.com/elFarto/nvidia-vaapi-driver?tab=readme-ov-file#upstream-regressions)
|
||||
for more information on this environment variable.
|
||||
|
||||
See [here](https://github.com/elFarto/nvidia-vaapi-driver?tab=readme-ov-file#upstream-regressions)
|
||||
for more information on this environment variable.
|
||||
- Enable the services `nvidia-suspend.service`, `nvidia-hibernate.service` and
|
||||
`nvidia-resume.service`
|
||||
|
||||
You can check the README to get it working for Firefox.
|
||||
- Add `nvidia.NVreg_PreserveVideoMemoryAllocations=1` to your kernel parameters if
|
||||
you don't have it already. This will solve issues with corrupted desktop / videos
|
||||
after waking.
|
||||
|
||||
## Other issues
|
||||
- You can check the README to get it working for Firefox.
|
||||
|
||||
## Other issues to look out for
|
||||
|
||||
### Regarding environment variables
|
||||
|
||||
|
|
@ -142,17 +163,17 @@ working in Zoom, first try running them in Native Wayland (more details below).
|
|||
Otherwise, remove or comment the line
|
||||
`env = __GLX_VENDOR_LIBRARY_NAME,nvidia`.
|
||||
|
||||
### Multi-monitor with hybrid graphics
|
||||
### How to possibly get multi-monitor working with hybrid graphics
|
||||
|
||||
On a hybrid graphics device (a laptop with
|
||||
both an Intel and an Nvidia GPU), you will need to remove the `optimus-manager`
|
||||
package if installed (disabling the service does not work). You also need to
|
||||
change your BIOS settings from hybrid graphics to discrete graphics.
|
||||
|
||||
### Flickering in Electron / CEF apps
|
||||
### Fixing flickering in Electron / CEF apps
|
||||
|
||||
This flickering is likely caused by these apps running in XWayland.
|
||||
To fix the flickering, try running the apps in native Wayland instead.
|
||||
To fix the flickering, try running the apps with native Wayland instead.
|
||||
|
||||
For most Electron apps, you should be fine just adding this
|
||||
environment variable to your config:
|
||||
|
|
@ -161,7 +182,7 @@ environment variable to your config:
|
|||
env = ELECTRON_OZONE_PLATFORM_HINT,auto
|
||||
```
|
||||
|
||||
This has been confirmed to work on Vesktop, VSCodium, Obsidian and will probably
|
||||
This has been confirmed to work on Vesktop, VSCodium and Obsidian and will probably
|
||||
work on other Electron apps as well.
|
||||
|
||||
For other apps, including CEF apps, you will need to launch them with these flags:
|
||||
|
|
@ -191,31 +212,31 @@ you will lose hardware acceleration for whichever app is run with these flags.
|
|||
|
||||
{{< /callout >}}
|
||||
|
||||
For NixOS, you can set the `NIXOS_OZONE_WL` environment variable
|
||||
With NixOS, you can also try setting the `NIXOS_OZONE_WL` environment variable
|
||||
to `1`, which should automatically configure Electron / CEF apps to run with native
|
||||
Wayland for you.
|
||||
|
||||
While it is best to have as many things as possible running natively in
|
||||
Wayland, the flickering will likely be solved in the 555 series of Nvidia driver updates.
|
||||
Wayland, the root cause of the flickering will likely be solved
|
||||
in the 555 series of Nvidia driver updates.
|
||||
|
||||
### Flickering in XWayland games
|
||||
### Fixing flickering in XWayland games specifically
|
||||
|
||||
XWayland games may flicker or present frames out-of-order in a way which makes them unplayable.
|
||||
This is due to the lack of explicit synchronization in the driver.
|
||||
The symptoms of this widespread issue include XWayland games flickering in
|
||||
a way which makes them unplayable. Repeated frames, random presenting of
|
||||
black frames, and overall weirdness. This is a result of a multitude of
|
||||
issues which will be solved soon via Nvidia driver updates, but for now
|
||||
you have a few possible fixes:
|
||||
|
||||
There are a few fixes:
|
||||
- Install xorg-xwayland-git (AUR). This git package includes this [PR](https://gitlab.freedesktop.org/xorg/xserver/-/merge_requests/967)
|
||||
which implements the "Explicit Sync" protocol.
|
||||
This will fix it in some, if not all cases. However if it doesn't,
|
||||
try the next solution. Once the 555 series of drivers are released, this
|
||||
should completely fix the issue.
|
||||
|
||||
1. Install the latest versions of `xorg-xwayland` and `wayland-protocols`.
|
||||
Ensure `xorg-xwayland` is at least version 24.1 and `wayland-protocols` is at least version 1.34.
|
||||
Both versions include the explicit sync patches.
|
||||
|
||||
2. Install the older Nvidia drivers which do not exhibit this issue. The
|
||||
- Install older nvidia drivers which do not exhibit this problem. The
|
||||
last ones which would work will be the 535xx series of drivers. These
|
||||
can be installed on Arch via [these AUR packages](https://aur.archlinux.org/packages?O=0&K=535xx)
|
||||
|
||||
3. Install the 555 beta driver. This version contains official support for explicit sync, but is still in beta.
|
||||
These can be installed from the
|
||||
[AUR](https://aur.archlinux.org/packages?O=0&SeB=nd&K=nvidia+beta&outdated=off&SB=p&SO=d&PP=50&submit=Go).
|
||||
can be installed easily on Arch via [these AUR packages](https://aur.archlinux.org/packages?O=0&K=535xx)
|
||||
|
||||
More info about explicit sync is available
|
||||
[on this blog](https://planet.kde.org/xavers-blog-2024-04-05-explicit-sync/).
|
||||
|
|
@ -238,12 +259,12 @@ Reboot your computer and it should be working.
|
|||
|
||||
If it does not, try:
|
||||
|
||||
1. Lowering your monitor's refresh rate: This can stop the flickering
|
||||
altogether.
|
||||
2. Using the [Nouveau driver](https://wiki.archlinux.org/title/Nouveau) as
|
||||
mentioned above.
|
||||
- lowering your monitor's refresh rate, as this can stop the flickering
|
||||
altogether
|
||||
- using the [Nouveau driver](https://wiki.archlinux.org/title/Nouveau) as
|
||||
mentioned above
|
||||
|
||||
### Suspend/wakeup issues
|
||||
### Fixing suspend/wakeup issues
|
||||
|
||||
Enable the services `nvidia-suspend.service`, `nvidia-hibernate.service` and
|
||||
`nvidia-resume.service`, they will be started by systemd when needed.
|
||||
|
|
@ -272,8 +293,8 @@ hardware.nvidia.powerManagement.enable = true;
|
|||
hardware.nvidia.open = false;
|
||||
```
|
||||
|
||||
# Still having issues?
|
||||
## Still having issues?
|
||||
|
||||
If you're still having issues after following this guide, you can join the
|
||||
[Hyprland Discord](https://discord.gg/hQ9XvMUjjr) and ask for help in the
|
||||
`#hyprland-nvidia` channel.
|
||||
[Hyprland Discord](https://discord.gg/hypr) and ask for help in the
|
||||
`#hyprland-nvidia` channel. Hopefully someone will be able to help you out.
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ For the config you can check out [DistroTube's Configuring Emacs](https://gitlab
|
|||
|
||||
Anyrun is a Wayland-native krunner-like runner, made with customizability in
|
||||
mind. It is modular and extensible through plugins. It can be used as an app launcher with its Applications Plugin.
|
||||
[GitHub](https://github.com/anyrun-org/anyrun)
|
||||
[GitHub](https://github.com/Kirottu/anyrun)
|
||||
|
||||
## Walker
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue