hypridle/README.md

37 lines
919 B
Markdown
Raw Permalink Normal View History

2024-02-17 18:49:23 +01:00
# hypridle
Hyprland's idle daemon
2024-02-17 20:33:44 +01:00
2024-02-17 20:35:40 +01:00
## Configuration
2024-02-17 20:33:44 +01:00
Configuration is done via `~/.config/hypr/hypridle.conf` in the standard
hyprland syntax.
```ini
listener {
timeout = 500 # in seconds
on-timeout = notify-send "You are idle!" # command to run when timeout has passed
on-resume = notify-send "Welcome back!" # command to run when activity is detected after timeout has fired.
}
```
2024-02-17 20:36:52 +01:00
You can add as many listeners as you please. Omitting `on-timeout` or `on-resume` (or leaving them empty)
will make those events ignored.
2024-02-17 20:35:40 +01:00
## Dependencies
2024-02-17 20:33:44 +01:00
- wayland
- wayland-protocols
2024-02-17 20:35:25 +01:00
- hyprlang >= 0.4.0
2024-02-17 20:35:40 +01:00
## Building & Installation
2024-02-17 20:35:25 +01:00
Building:
```sh
cmake --no-warn-unused-cli -DCMAKE_BUILD_TYPE:STRING=Release -S . -B ./build
cmake --build ./build --config Release --target hypridle -j`nproc 2>/dev/null || getconf NPROCESSORS_CONF`
```
Installation:
```sh
sudo cmake --install build
```