mpvpaper: add module (#6926)

Provides a module for configuring mpvpaper a video wallpaper program for wlroots based wayland compositors. It provides options for setting the 'pauselist' and 'stoplist'.

modules/modules.nix

@@ -184,6 +184,7 @@ let
       ./programs/mise.nix
       ./programs/mods.nix
       ./programs/mpv.nix
+      ./programs/mpvpaper.nix
       ./programs/mr.nix
       ./programs/msmtp.nix
       ./programs/mu.nix

modules/programs/mpvpaper.nix

@@ -0,0 +1,61 @@
+{
+  lib,
+  pkgs,
+  config,
+  ...
+}:
+let
+  inherit (lib)
+    types
+    mkIf
+    mkEnableOption
+    mkPackageOption
+    mkOption
+    ;
+
+  cfg = config.programs.mpvpaper;
+in
+{
+  meta.maintainers = with lib.hm.maintainers; [ aguirre-matteo ];
+
+  options.programs.mpvpaper = {
+    enable = mkEnableOption "mpvpaper";
+    package = mkPackageOption pkgs "mpvpaper" { nullable = true; };
+    pauseList = mkOption {
+      type = types.lines;
+      default = "";
+      example = ''
+        firefox
+        steam
+        obs
+      '';
+      description = ''
+        List of program names that will cause mpvpaper to pause.
+        Programs must be separed by spaces or newlines.
+      '';
+    };
+    stopList = mkOption {
+      type = types.lines;
+      default = "";
+      example = ''
+        firefox
+        steam
+        obs
+      '';
+      description = ''
+        List of program names that will cause mpvpaper to stop.
+        Programs must be separed by spaces or newlines.
+      '';
+    };
+  };
+
+  config = mkIf cfg.enable {
+    assertions = [
+      (lib.hm.assertions.assertPlatform "programs.mpvpaper" pkgs lib.platforms.linux)
+    ];
+
+    home.packages = mkIf (cfg.package != null) [ cfg.package ];
+    xdg.configFile."mpvpaper/pauselist".text = mkIf (cfg.pauseList != "") cfg.pauseList;
+    xdg.configFile."mpvpaper/stoplist".text = mkIf (cfg.stopList != "") cfg.stopList;
+  };
+}

tests/default.nix

@@ -379,6 +379,7 @@ import nmtSrc {
       ./modules/programs/kickoff
       ./modules/programs/looking-glass-client
       ./modules/programs/mangohud
+      ./modules/programs/mpvpaper
       ./modules/programs/ncmpcpp-linux
       ./modules/programs/nh
       ./modules/programs/onedrive

tests/modules/programs/mpvpaper/default.nix

@@ -0,0 +1 @@
+{ mpvpaper-example-config = ./example-config.nix; }

tests/modules/programs/mpvpaper/example-config.nix

@@ -0,0 +1,24 @@
+{
+  programs.mpvpaper = {
+    enable = true;
+    pauseList = ''
+      firefox
+      librewolf
+      steam
+    '';
+    stopList = ''
+      obs
+      virt-manager
+      gimp
+    '';
+  };
+
+  nmt.script = ''
+    assertFileExists home-files/.config/mpvpaper/pauselist
+    assertFileExists home-files/.config/mpvpaper/stoplist
+    assertFileContent home-files/.config/mpvpaper/pauselist \
+    ${./pauselist}
+    assertFileContent home-files/.config/mpvpaper/stoplist \
+    ${./stoplist}
+  '';
+}

tests/modules/programs/mpvpaper/pauselist

@@ -0,0 +1,3 @@
+firefox
+librewolf
+steam

tests/modules/programs/mpvpaper/stoplist

@@ -0,0 +1,3 @@
+obs
+virt-manager
+gimp