hyprpaper/README.md

50 lines
1.6 KiB
Markdown
Raw Normal View History

2022-07-01 20:16:45 +02:00
# hyprpaper
2022-07-01 23:13:43 +02:00
2022-07-02 19:12:51 +02:00
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.
2022-07-01 23:13:43 +02:00
# Installation
2022-07-17 14:22:22 +02:00
[AUR](https://aur.archlinux.org/packages/hyprpaper-git): `yay -S hyprpaper-git`
2022-07-12 08:14:18 +02:00
### Manual:
2022-07-01 23:13:43 +02:00
```
git clone https://github.com/hyprwm/hyprpaper
2022-07-05 13:11:47 +02:00
cd hyprpaper
2022-07-01 23:13:43 +02:00
make all
```
2022-07-04 19:23:03 +02:00
*the output binary will be in `./build/`, copy it to your PATH, e.g. `/usr/bin`*
2022-07-01 23:13:43 +02:00
# 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
```
2022-07-04 19:23:03 +02:00
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`)
2022-07-01 23:13:43 +02:00
A Wallpaper ***cannot*** be applied without preloading. The config is ***not*** reloaded dynamically.
2022-07-02 19:12:34 +02:00
# IPC
2022-07-02 19:13:21 +02:00
You can use `hyprctl hyprpaper` (if on Hyprland) to issue a keyword, for example
2022-07-02 19:12:34 +02:00
```
hyprctl hyprpaper wallpaper DP-1,~/Pictures/myepicpng.png
```
2022-07-17 14:20:00 +02:00
## 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/>
2022-07-04 19:23:03 +02:00
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!)