linux-wallpaperengine: add examples and clarify options usage

This commit is contained in:
ckgxrg 2026-01-17 10:35:49 +00:00 committed by Austin Horstman
parent 8fd20c8d48
commit 05fd3babab

View file

@ -21,6 +21,7 @@ in
type = types.nullOr types.path;
default = null;
description = "Path to the assets directory.";
example = "~/.local/share/Steam/steamapps/common/wallpaper_engine/assets";
};
clamping = mkOption {
@ -42,17 +43,23 @@ in
monitor = mkOption {
type = types.str;
description = "Which monitor to display the wallpaper.";
example = "HDMI-A-1";
};
wallpaperId = mkOption {
type = types.str;
description = "Wallpaper ID to be used.";
description = "Wallpaper to be used. Can either be a Steam Workshop ID or the path to the background folder.";
example = "3527223773";
};
extraOptions = mkOption {
type = types.listOf types.str;
default = [ ];
description = "Extra arguments to pass to the linux-wallpaperengine command for this wallpaper.";
example = [
"--scaling fill"
"--fps 12"
];
};
scaling = mkOption {