nixos/xfce: Add Wayland session

Using labwc as compositor.
NixOS · Nov 2, 2024 · 84c1720 · 84c1720
1 parent bb904fb
commit 84c1720
Showing 1 changed file with 34 additions and 0 deletions.
diff --git a/nixos/modules/services/x11/desktop-managers/xfce.nix b/nixos/modules/services/x11/desktop-managers/xfce.nix
@@ -69,6 +69,22 @@ in
         default = true;
         description = "Enable the XFCE screensaver.";
       };
+
+      enableWaylandSession = mkEnableOption "the experimental Xfce Wayland session";
+
+      waylandSessionCompositor = mkOption {
+        type = lib.types.str;
+        default = "";
+        example = "wayfire";
+        description = ''
+          Command line to run a Wayland compositor, defaults to `labwc --startup`
+          if not specified. Note that `xfce4-session` will be passed to it as an
+          argument, see `startxfce4 --help` for details.
+
+          Some compositors do not have an option equivalent to labwc's `--startup`
+          and you might have to add xfce4-session somewhere in their configurations.
+        '';
+      };
     };
 
     environment.xfce.excludePackages = mkOption {
@@ -134,6 +150,8 @@ in
     programs.gnupg.agent.pinentryPackage = mkDefault pkgs.pinentry-gtk2;
     programs.xfconf.enable = true;
     programs.thunar.enable = true;
+    programs.labwc.enable = mkDefault (cfg.enableWaylandSession && (
+      cfg.waylandSessionCompositor == "" || lib.substring 0 5 cfg.waylandSessionCompositor == "labwc"));
 
     environment.pathsToLink = [
       "/share/xfce4"
@@ -153,6 +171,22 @@ in
       '';
     }];
 
+    # Copied from https://gitlab.xfce.org/xfce/xfce4-session/-/blob/xfce4-session-4.19.2/xfce-wayland.desktop.in
+    # to maintain consistent l10n state with X11 session file and to support the waylandSessionCompositor option.
+    services.displayManager.sessionPackages = optionals cfg.enableWaylandSession [
+      ((pkgs.writeTextDir "share/wayland-sessions/xfce-wayland.desktop" ''
+        [Desktop Entry]
+        Version=1.0
+        Name=Xfce Session (Wayland)
+        Comment=Use this session to run Xfce as your desktop environment
+        Exec=startxfce4 --wayland ${cfg.waylandSessionCompositor}
+        Icon=
+        Type=Application
+        DesktopNames=XFCE
+        Keywords=xfce;wayland;desktop;environment;session;
+      '').overrideAttrs (_: { passthru.providedSessions = [ "xfce-wayland" ]; }))
+    ];
+
     services.xserver.updateDbusEnvironment = true;
     programs.gdk-pixbuf.modulePackages = [ pkgs.librsvg ];