Hypr-Ecosystem/hyprpaper: Fix wrong config option (file -> path), increase clarity (#1307)

* Fix wrong hyprpaper config option (file -> path)

Also increased clarity on the misc section

* Add table for wallpaper options

* Add single quote

* fix mistake
This commit is contained in:
Tuur Vanhoutte 2025-12-05 16:39:31 +01:00 committed by GitHub
parent 980a1b6902
commit 9d1479c84e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -40,23 +40,28 @@ required.
Wallpapers are set as anonymous special categories. Monitor can be left empty for a fallback.
| 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 |
| `fit_mode` | Determines how to display the image. Optional and defaults to `cover` | `contain`\|`cover`\|`tile`\|`fill` |
```ini
wallpaper {
monitor = DP-3
file = ~/myFile.jxl
path = ~/myFile.jxl
fit_mode = cover
}
wallpaper {
monitor = DP-2
file = ~/myFile2.jxl
path = ~/myFile2.jxl
fit_mode = cover
}
# ...
```
`fit_mode` is optional and defaults to cover.
### Run at Startup
@ -65,6 +70,8 @@ If you start Hyprland with [uwsm](../../Useful-Utilities/Systemd-start), you can
### Misc Options
These should be set outside of the `wallpaper{...}` sections.
| variable | description | type | default |
| --- | --- | --- | --- |
| `splash` | enable rendering of the hyprland splash over the wallpaper | bool | `false` |
@ -77,7 +84,7 @@ If you start Hyprland with [uwsm](../../Useful-Utilities/Systemd-start), you can
hyprpaper supports IPC via `hyprctl`. You can set wallpapers like so:
```sh
hyprctl hyprpaper wallpaper '[mon], [path], [fit_mode]
hyprctl hyprpaper wallpaper '[mon], [path], [fit_mode]'
```
`fit_mode` is optional, and `mon` can be empty for a fallback, just like in the config file.
`fit_mode` is optional, and `mon` can be empty for a fallback, just like in the config file.