Skip to content

hyprpaper: document wallpaper#paths #1431

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
y0usaf wants to merge 1 commit into
base: main
Choose a base branch
from
Open

hyprpaper: document wallpaper#paths #1431

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions content/Hypr Ecosystem/hyprpaper.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,12 @@ Wallpapers are set as anonymous special categories. Monitor can be left empty fo
| variable | description | value |
| --- | --- | --- |
| `monitor` | Monitor to display this wallpaper on. If empty, will use this wallpaper as a fallback | monitor ID |
| `path` | Path to an image file or a directory containing image files | path |
| `path` | Path to an image file or a directory containing image files. Mutually exclusive with `paths` | path |
| `paths` | Comma-separated list of image files and/or directories. Picks one wallpaper for the current run. Mutually exclusive with `path` | string |
| `fit_mode` | Determines how to display the image. Optional and defaults to `cover` | `contain`\|`cover`\|`tile`\|`fill` |
| `timeout` | Timeout between each wallpaper change (in seconds, if `path` is a directory). Optional and defaults to 30 seconds | int |
| `order` | Determines the order to display images when a directory is passed to the `path` option. Optional, currently only supported value is `random` | `random` |
| `recursive` | Whether to scan subdirectories recursively when `path` is a directory. Optional and defaults to `false` | bool |
| `timeout` | Timeout between each wallpaper change (in seconds, if `path` is a directory). Optional and defaults to 30 seconds. Does not apply to `paths`, which always selects a single wallpaper for the current run | int |
| `order` | Determines the order to display images. For `path`, supported values are `random` and `random-shuffle`. For `paths`, supported values are `default` and `random`; `random` randomizes the startup choice | `path`: `random`\|`random-shuffle`; `paths`: `default`\|`random` |
| `recursive` | Whether to scan subdirectories recursively when `path` points to a directory or `paths` contains directories. Optional and defaults to `false` | bool |

```ini
wallpaper {
Expand All @@ -62,6 +63,13 @@ wallpaper {
fit_mode = cover
}

wallpaper {
monitor = DP-1
paths = ~/wallpapers/favs, ~/wallpapers/one.jxl, ~/wallpapers/two.jxl
fit_mode = cover
order = random
}

wallpaper {
monitor =
path = ~/fallback.jxl
Expand Down