hyprland-wiki/pages/Nix/Options & Overrides.md

61 lines
1.5 KiB
Markdown
Raw Permalink Normal View History

2023-08-26 18:31:56 +02:00
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).
2022-12-18 14:20:19 +01:00
## Package options
These are the default options that the Hyprland package is built with. These
can be changed by setting the appropriate option to `true`/`false`.
### Package
```nix
(pkgs.hyprland.override { # or inputs.hyprland.packages.${pkgs.system}.hyprland
2022-12-18 14:20:19 +01:00
enableXWayland = true;
2023-08-26 18:31:56 +02:00
enableNvidiaPatches = false;
2022-12-18 14:20:19 +01:00
})
```
### NixOS & HM modules
```nix
programs.hyprland = { # or wayland.windowManager.hyprland
enable = true;
2023-08-26 18:31:56 +02:00
xwayland.enable = true;
enableNvidiaPatches = false;
2022-12-28 16:31:43 +01:00
};
2022-12-18 14:20:19 +01:00
```
## Options descriptions
### XWayland
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
2023-08-01 23:02:05 +02:00
See [XWayland](../../Configuring/XWayland).
2022-12-18 14:20:19 +01:00
### Nvidia Patches
Nvidia is notorious for not working by default with wlroots. That's why we
patch wlroots.
2023-08-26 18:31:56 +02:00
In the NixOS and Home Manager modules, you can enable the
Nvidia patches using `programs.hyprland.enableNvidiaPatches` and
`wayland.windowManager.hyprland.enableNvidiaPatches`, respectively.
2023-06-13 13:14:21 +02:00
2022-12-18 14:20:19 +01:00
## Using Nix repl
If you're using Nix (and not NixOS or Home Manager) and you want to override,
you can do it like this
2023-08-26 18:31:56 +02:00
```nix
2022-12-18 14:20:19 +01:00
$ nix repl
nix-repl> :lf "github:hyprwm/Hyprland"
2023-08-26 18:31:56 +02:00
nix-repl> :bl outputs.packages.x86_64-linux.hyprland.override {enableNvidiaPatches = true;} # option = value
2022-12-18 14:20:19 +01:00
```
Then you can run Hyprland from the built path.