From 5258a0b492c3c1c298ea19f120d4b539d97162d9 Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Tue, 21 Apr 2026 17:01:33 +0300 Subject: [PATCH] docs: mention protocol requirement Signed-off-by: NotAShelf Change-Id: I8c6fe27090a24df7a7ba5efce4bf1b786a6a6964 --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7018606..e899265 100644 --- a/README.md +++ b/README.md @@ -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