A small utility to inhibit idle on wayland for mpris clients
Update README.md
+24
+24
README.md
+24
README.md
···
3
3
Uses the [idle-inhibit-unstable-v1](https://wayland.app/protocols/idle-inhibit-unstable-v1) Wayland protocol in order
4
4
to inhibit the idle behavior of the compositor when a media player is playing.
5
5
6
+
## Usage
7
+
8
+
1. Add the flake to your flake inputs (other packaging formats just uh build it yourself idk)
9
+
2. Add the package to your environment.systemPackages
10
+
3. Call the command, once you know which options you like best (see below), you can add it to your compositor's config.
11
+
12
+
Ex for Hyprland:
13
+
14
+
```
15
+
exec-once = "wayland-mpris-idle-inhibit"
16
+
```
17
+
18
+
Now whenever a player is playing media the program will inhibit the compositor's idle (e.g. hypridle), and will resume idle when the player is stopped or paused.
19
+
20
+
### Note for KDE Connect
21
+
22
+
You probably still want your PC to fall asleep if your phone is playing media, so you can add these two options to the command call to make it ignore kdeconnect when scanning for active players:
23
+
24
+
```
25
+
--ignore=kdeconnect --ignore=playerctld
26
+
```
27
+
28
+
The `playerctld` part is because for some reason playing media through kdeconnect registers *two* players, one with the right name and one with playerctld.
29
+
6
30
## Options
7
31
8
32
- `--poll-interval <interval>`: The interval in seconds at which the program will poll MPRIS for player information, default is `10`