From c9235befcca9e6b6c51be8e96e873afe96043e87 Mon Sep 17 00:00:00 2001 From: Maxim Baz Date: Sat, 26 Oct 2024 17:04:30 +0200 Subject: [PATCH] Update README --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 526f0d4..b3ca4cd 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,16 @@ A tool for Wayland compositors to automatically adjust screen brightness based o ## Supported screen capture protocols -With default config, `wluma` will automatically detect which protocols are supported, and pick the most appropriate one. See "configuration" section below for how to force a specific protocol. +With default config, `wluma` will automatically detect which protocols are supported, and pick the most appropriate one. See "configuration" section below for more information and how to force a specific protocol. -The list of available protocols: +The list of supported protocols: +- `ext-image-capture-source-v1` - the newest protocol that potentially is (or will be) supported by any modern Wayland desktop environment. + - At the time of writing, it's not supported by any compositor yet. - `wlr-screencopy-unstable-v1` - supported by any `wlroots`-based compositors (e.g. `sway`), as well as Hyprland. - requires `linux-dmabuf-v1` protocol to be supported as well. - `wlr-export-dmabuf-unstable-v1` - supported by any `wlroots`-based compositors (e.g. `sway`). -Subscribe for [#121](https://github.com/maximbaz/wluma/issues/121) to see when the new `ext-image-capture-source-v1` protocol will land, which will potentially support any modern Wayland compositor once they implement the support as well. - ## Idea The app will automatically brighten the screen when you are looking at a dark window (such as a fullscreen terminal) and darken the screen when you are looking at a bright window (such as web browser). The algorithm takes into consideration the amount of ambient light around you, so the same window can be brighter during the day than during the night. @@ -79,10 +79,12 @@ Each output is identified by compositor using model, manufacturer and serial num The `name` field in the output config will be matched as a substring, so you are free to put simply `eDP-1`, or a serial number (if you have two identical external screens). It is your responsibility to make sure that the values you use match **uniquely** to one output only. -The `capturer` field will determine how screen contents will be captured. Currently supported values are `wayland` (works only on Wayland compositors that support protocols listed in the top) and `none` (ignores screen contents and predicts brightness only based on ALS). The value `wayland` will automatically choose the most appropriate protocol, but if you want to force a specific one, you can use `wlr-screencopy-unstable-v1` or `wlr-export-dmabuf-unstable-v1` as the value. - _Tip:_ run `wluma` with `RUST_LOG=debug` to see how your outputs are being identified, so that you can choose an appropriate `name` configuration value. +The `capturer` field will determine how screen contents will be captured. Currently supported values are `wayland` (works only on Wayland compositors that support protocols listed in the top) and `none` (ignores screen contents and predicts brightness only based on ALS). The value `wayland` will automatically choose the most appropriate protocol, but if you want to force a specific one, you can use `ext-image-capture-source-v1`, `wlr-screencopy-unstable-v1` or `wlr-export-dmabuf-unstable-v1` as the value. + +_Tip:_ run `wluma` with `RUST_LOG=debug` and `capturer="wayland"` to see which protocols are supported by your Wayland compositor, and which one `wluma` chooses to use. + ## Run To run the app, simply launch `wluma` or use the provided systemd user service.