Hypr-Ecosystem/hyprpaper: add doc for dynamic wallpapers and sourcing (#1336)

Update the documentation for the hyprpaper configuration, clarifying the 'path' variable and adding a new 'timeout' variable.
Include a new section on sourcing configuration files.
This commit is contained in:
Johann 2026-01-03 13:56:36 +01:00 committed by GitHub
parent 085e22452b
commit cd4d910d8c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -43,8 +43,9 @@ 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 the image file | path |
| `path` | Path to an image file or a directory containing image files (non recursively) | path |
| `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 |
```ini
wallpaper {
@ -79,6 +80,16 @@ These should be set outside of the `wallpaper{...}` sections.
| `splash_opacity` | how opaque the splash is | float | `0.8` |
| `ipc` | whether to enable IPC | bool | `true` |
### Sourcing
Use the `source` keyword to source another file. Globbing, tilde expansion and relative paths are supported.
```ini
source = ~/.config/hypr/hyprpaper.d/*.conf
```
Please note its LINEAR. Meaning lines above the `source =` will be parsed first, then lines inside `~/.config/hypr/hyprpaper.d/*.conf` files, then lines below.
## IPC
hyprpaper supports IPC via `hyprctl`. You can set wallpapers like so: