mirror of
https://github.com/hyprwm/hyprpaper.git
synced 2024-11-16 22:25:59 +01:00
49 lines
1.6 KiB
Markdown
49 lines
1.6 KiB
Markdown
# hyprpaper
|
|
|
|
Hyprpaper is a blazing fast wallpaper utility for Hyprland with the ability to dynamically change wallpapers through sockets. It will work on all wlroots-based compositors, though.
|
|
|
|
# Installation
|
|
|
|
[AUR](https://aur.archlinux.org/packages/hyprpaper-git): `yay -S hyprpaper-git`
|
|
|
|
### Manual:
|
|
```
|
|
git clone https://github.com/hyprwm/hyprpaper
|
|
cd hyprpaper
|
|
make all
|
|
```
|
|
*the output binary will be in `./build/`, copy it to your PATH, e.g. `/usr/bin`*
|
|
|
|
# Usage
|
|
|
|
Hyprpaper is controlled by the config, like this:
|
|
|
|
*~/.config/hypr/hyprpaper.conf*
|
|
```
|
|
preload = /path/to/image.png
|
|
|
|
# .. more preloads
|
|
|
|
wallpaper = monitor,/path/to/image.png
|
|
|
|
# .. more monitors
|
|
```
|
|
|
|
Preload will tell Hyprland to load a particular image (supported formats: png, jpg, jpeg). Wallpaper will apply the wallpaper to the selected output (`monitor` is the monitor's name, easily can be retrieved with `hyprctl monitors`)
|
|
|
|
A Wallpaper ***cannot*** be applied without preloading. The config is ***not*** reloaded dynamically.
|
|
|
|
# IPC
|
|
You can use `hyprctl hyprpaper` (if on Hyprland) to issue a keyword, for example
|
|
```
|
|
hyprctl hyprpaper wallpaper DP-1,~/Pictures/myepicpng.png
|
|
```
|
|
|
|
## Unloading
|
|
If you use a lot of wallpapers, consider unloading those that you no longer need. This will mean you need to load them again if you wish to use them for a second time, but will free the memory used by the preloaded bitmap. (Usually 8 - 20MB, depending on the resolution)
|
|
|
|
You can issue a `hyprctl hyprpaper unload [PATH]` to do that.
|
|
|
|
<br/>
|
|
|
|
For other compositors, the socket works like socket1 of Hyprland, and is located in `/tmp/hypr/.hyprpaper.sock` (this path only when Hyprland is not running!)
|