Hyprnix

This project is intended to work with the latest Hyprland version, thus using nixpkgs unstable is the recommended approach.

A wrapper for Home Manager's Hyprland module, greatly inspired by this Hyprnix project.

Quickstart

See the full docs here

Installation

Add the flake as an input.

# flake.nix
{
  inputs = {
    hyprnix = {
      url = "github:Nyramu/hyprnix";
      inputs.nixpkgs.follows = "nixpkgs"; # Recommended
    };
  };
}

Configuration

We try our best to make hyprnix options match wayland.windowManager.hyprland ones. If you have your flake's inputs passed down to your Home Manager configuration, you can use the module in imports somewhere. The following is just an example of what you could do.

# home.nix
{ inputs, ... }:

{
  imports = [
    inputs.hyprnix.homeModules.default
  ];

  hyprnix = {
    enable = true;
    systemd.enable = true;
    xwayland.enable = true;
    settings = {
      workspaces = [
        {
          id = 1;
          rules = {
            default = true;
            persistent = true;
          };
        }
        {
          id = 2;
          rules.persistent = true;
        }
      ];

      keybinds = {
        bind = {
          "SUPER, RETURN" = "exec, kitty";
          "SUPER, E" = "exit";
        };
        bindl = {
          # more keybinds
        };
      };

      windowrules = [
        {
          # You can remove name, making it an anonymous windowrule2
          name = "floating-mpv";
          match.class = "mpv";
          float = true;
          center = true;
          size = [
            1280
            720
          ];
        } 
      ];

      gesture = {
        gestures = [
          {
            fingers = 3;
            direction = "pinch";
            action = "fullscreen";
          }
          {
            fingers = 3;
            direction = "horizontal";
            action = "workspace";
          }
        ];
      };
      
      monitors = [
        {
          output = "HDMI-A-1";
          mode = "1920x1080@100";
          position = "auto";
        }
        {
          output = "DP-1";
          mode = "1920x1080@100";
          position = "auto";
        }
      ];
      
      # etc...
    };
    extraConfig = ''
      # Extra configuration lines to append to the bottom of
      # `~/.config/hypr/hyprland.conf`
    '';
  };
}

Why should I use this Hyprnix?

While it mostly works, the other Hyprnix is, unfortunately, rarely updated. This makes it prone to rebuild errors and warnings, mainly because some options get deprecated, or some dependencies get replaced/renamed. We want to preserve its advantages while also trying to enhance its structure, without breaking compatibility with Hyprland's Home Manager module. Here are some reasons to use it:

Easy to install and configure
Enhanced syntax for keybinds, windowrules, gestures and other options
Entirely based on Home Manager's wayland.windowManager.hyprland options, to ensure compatibility
Config errors make the rebuild crash, in line with NixOS logic
Frequent updates (until it will cover every option)

Contributing

You can help this project by making a pull request or reporting an issue. If you want to try generating local documentation, you can do it by using cachix use hyprnix command.

Hyprnix Documentation