Skip to content

Commit e43f8ec

Browse files
Document desktop compatibility
1 parent 67a494b commit e43f8ec

1 file changed

Lines changed: 26 additions & 3 deletions

File tree

README.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,30 @@ It can:
66

77
- turn the TV on at boot and wake
88
- turn the TV off at shutdown and before system sleep
9-
- blank and restore the panel on desktop idle and activity, including gamepad activity on GNOME
9+
- blank and restore the panel on supported desktop idle backends
10+
- keep the panel awake from gamepad activity on GNOME
1011
- adjust OLED pixel brightness with a small desktop dialog or CLI command
1112

12-
LG Buddy supports GNOME and `swayidle`-based sessions. Official release bundles include a prebuilt `lg-buddy` binary, so normal installation does not require a Rust toolchain.
13+
GNOME is not required. Official release bundles include a prebuilt `lg-buddy`
14+
binary, so normal installation does not require a Rust toolchain.
1315

1416
If you build `lg-buddy` from source instead of using a release bundle, `cargo`
1517
now also needs a working C toolchain because the vendored `libdbus` runtime is
1618
compiled as part of the build.
1719

20+
## Desktop Compatibility
21+
22+
| Functionality | GNOME | Non-GNOME Wayland with `swayidle` | Other Linux sessions | Notes |
23+
| --- | --- | --- | --- | --- |
24+
| Turn TV on at boot and wake |||| Desktop-independent Linux lifecycle integration |
25+
| Turn TV off at shutdown and before system sleep |||| Desktop-independent Linux lifecycle integration |
26+
| Blank and restore on desktop idle/activity |||| `screen_backend=auto` prefers GNOME, then falls back to `swayidle` when installed |
27+
| Keep the panel awake from gamepad activity |||| Implemented in the GNOME monitor runtime |
28+
| OLED brightness CLI |||| Desktop-independent runtime command |
29+
| OLED brightness desktop dialog |||| Requires `zenity` |
30+
| Settings CLI |||| Desktop-independent runtime command |
31+
| Manual and background update checks |||| Desktop notifications depend on the session notification service and desktop notification support |
32+
1833
## Before You Install
1934

2035
Install prerequisites:
@@ -25,7 +40,8 @@ Install prerequisites:
2540

2641
Backend-specific:
2742

28-
- `swayidle` for the `swayidle` backend
43+
- GNOME backend: compatible GNOME Shell session
44+
- Non-GNOME Wayland backend: `swayidle`
2945

3046
The GNOME backend requires a compatible GNOME session with:
3147

@@ -46,16 +62,22 @@ Typical package installs:
4662
**Debian/Ubuntu/Pop!_OS**
4763
```bash
4864
sudo apt install python3-venv python3-pip zenity
65+
# Optional for non-GNOME Wayland sessions:
66+
sudo apt install swayidle
4967
```
5068

5169
**Fedora**
5270
```bash
5371
sudo dnf install python3 python3-pip python3-virtualenv zenity
72+
# Optional for non-GNOME Wayland sessions:
73+
sudo dnf install swayidle
5474
```
5575

5676
**Arch**
5777
```bash
5878
sudo pacman -S python python-pip python-virtualenv zenity
79+
# Optional for non-GNOME Wayland sessions:
80+
sudo pacman -S swayidle
5981
```
6082

6183
For source builds, also install a C toolchain:
@@ -87,6 +109,7 @@ LG Buddy is mostly automatic after installation.
87109

88110
- To inspect settings, run `lg-buddy settings list`
89111
- To change supported settings, use `lg-buddy settings set <key> <value>`
112+
- To see the active desktop idle backend, run `lg-buddy detect-backend`
90113
- To inspect TV brightness, run `lg-buddy brightness get`
91114
- To set TV brightness directly, run `lg-buddy brightness set <0-100>`
92115
- To inspect the installed runtime version, run `lg-buddy --version`

0 commit comments

Comments
 (0)