NotAShelf/chroma
2
1
Fork 0
Code Issues 5 Pull requests Projects Releases Packages Wiki Activity Actions

docs: mention protocol requirement

Browse source 
Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: I8c6fe27090a24df7a7ba5efce4bf1b786a6a6964
This commit is contained in:
raf 2026-04-21 17:01:33 +03:00
commit 5258a0b492
Signed by: NotAShelf
GPG key ID: 29D95B64378DB4BF
1 changed files with 11 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -111,6 +111,12 @@ default_image = ~/.config/chroma/default.jpg
output.DP-1 = ~/Pictures/monitor1.jpg
output.DP-2 = ~/Pictures/monitor2.png
output.HDMI-A-1 = ~/Pictures/hdmi_wallpaper.jpg
# You can also match outputs by description using the desc: prefix
# This is useful when output names change between reboots
# Format: output.desc:DESCRIPTION_PREFIX = /path/to/image.jpg
output.desc:Samsung = ~/Pictures/samsung_wallpaper.jpg
output.desc:LG Ultra = ~/Pictures/lg_wallpaper.jpg
```
### Finding Output Names
@ -183,10 +189,13 @@ Chroma works with any Wayland compositor that supports:
- `wl_compositor` interface
- `wl_output` interface
- `zwlr_layer_shell_v1` (wlr-layer-shell-unstable-v1) interface
- EGL window surface creation
Tested only on Hyprland, but should work fine with any compositor that meets the
above criteria. Which is basically all of them I think?
The wlr-layer-shell protocol is required for creating wallpaper surfaces on the
background layer. Tested only on Hyprland, but should work fine with any
wlroots-based compositor or any compositor that implements the wlr-layer-shell
protocol.
## Contributing