hyprland-wiki/pages/Hypr Ecosystem/hyprpaper.md

50 lines
1.6 KiB
Markdown
Raw Normal View History

2024-02-19 17:52:58 +01:00
hyprpaper is a fast, IPC-controlled wallpaper utility for hyprland.
2024-02-19 18:09:40 +01:00
{{< toc >}}
2024-02-19 17:52:58 +01:00
## Configuration
The config file is located at `~/.config/hypr/hyprpaper.conf`. It is not required.
2024-02-19 17:52:58 +01:00
Configuration is done via `preload`s, which _load_ an image into memory.
Then, you use `wallpaper` keywords to apply the preloaded image to your
monitor(s):
```ini
preload = /home/me/amongus.png
wallpaper = DP-1,/home/me/amongus.png
```
For wallpaper keywords:
- all paths have to be absolute (or start with `~`)
- leaving the first parameter (monitor) empty will act as a wildcard
- adding `contain:` before the path (e.g. `contain:/home/me/amongus.png`) will adjust the fitting algorithm to contain.
2024-02-27 23:25:09 +01:00
You can also `unload` preloaded images to free up memory. `unload all` and `unload unused` are a thing too.
2024-02-19 17:52:58 +01:00
### Misc options
| variable | description | type | default |
| -- | -- | -- | -- |
| splash | enable rendering of the hyprland splash over the wallpaper | bool | false |
| splash_offset | how far (in % of height) up should the splash be displayed | float | 2.0 |
| ipc | whether to enable IPC | bool | true |
## IPC
hyprpaper supports IPC via `hyprctl`. Every dispatcher mentioned in [Configuration](#Configuration)
can be called with `hyprctl hyprpaper <dispatcher> <arg(s)>`.
Additionally, you can get some info about the current state of hyprpaper with `listloaded` and `listactive`.
Examples:
```sh
hyprctl hyprpaper preload "~/Pictures/myepicpng.png"
hyprctl hyprpaper wallpaper "DP-1,~/Pictures/myepicpng.png"
```
```sh
hyprctl hyprpaper listloaded
```
Please note all paths have to be absolute (or start with `~`).