roguauto 1.0.2

A lightweight power menu for Wayland compositors supporting wlr-layer-shell.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

# Roguauto (ログアウト)

[![Version](https://img.shields.io/crates/v/roguauto)](
https://crates.io/crates/roguauto)
[![Downloads](https://img.shields.io/crates/d/roguauto)](
https://crates.io/crates/roguauto)
[![License](https://img.shields.io/crates/l/roguauto)](
https://github.com/ac5307/roguauto#license)

<!-- DO NOT EDIT THIS FILE DIRECTLY, EDIT lib.rs AND THEN RUN `make rdme` to update the
     content between "cargo-rdme start" and "cargo-rdme end". -->
<!-- cargo-rdme start -->

**Roguauto** is a lightweight and configurable power-menu daemon for Wayland, written in Rust.

The application runs as a persistent per-user daemon and displays a native
[`wlr-layer-shell`](https://wayland.app/protocols/wlr-layer-shell-unstable-v1)
overlay when requested through its local ipc interface.

## App features

- Lock, suspend, hibernate, reboot, shut down, and log out.
- Native Wayland rendering without GTK or inheritance from the system theme.
- A fully application-controlled visual style.
- TOML configuration with filesystem-based hot reloading.
- Keyboard and pointer navigation.
- A persistent system D-Bus connection to systemd-logind.
- A simple Unix-domain-socket daemon interface.

## Compatibility

The compositor must support the `wlr-layer-shell` protocol.

The application was developed and tested primarily on [Niri](https://github.com/niri-wm/niri).
Other compositors implementing `wlr-layer-shell`, including
Hyprland, Sway, Labwc, KWin, etc, are expected to work.

GNOME Shell does not currently expose `wlr-layer-shell`, so it's not supported.

Power operations additionally require **Linux**, a working system D-Bus,
and systemd-logind. Some actions may require authorization through
PolicyKit.

## Usage

The daemon is started with:

```text
# A path to a config file can be optionally given.
rogu daemon [-c <file> | --config <file>]
```

In a second terminal window while the daemon is still running:

```text
rogu show
rogu hide
rogu toggle
rogu quit
```

However, normally, you would want to start the daemon as part of your
compositor's startup or autostart processes. And then, bind a keyboard
shortcut to `rogu toggle` and/or the remaining commands.

## Configuration

The app will try looking for a config file in 3 locations:
- the path given when starting the daemon,
- `$XDG_CONFIG_HOME/roguauto/config.toml`,
- `$HOME/.config/roguauto/config.toml`.

Below is an example of what could go inside a configuration file:

```toml
[window]
background = "#192264"
height = 160
padding = 18
corner_radius = 25.0

[item]
background = "#a1a4a9"
selected_background = "#a0d0f0"
width = 196
gap = 8
corner_radius = 10.5

[text]
color = "#2d303a"
selected_color = "#f1f4f9"
font_family = "JetBrains Mono"      # use fonts that are installed on your machine.
font_size = 20
font_weight = 300
line_height = 25.0

[icon]
size = 49
label_gap = 21.0

[behavior]
close_after_action = true           # default value is already true.
```

The app itself has built-in defaults. Omitting any of the fields shown above
will use the default value for that particular field. Hence, if a config file
is not found, the defaults would all be used.

## Architecture

The main thread runs a Calloop event loop responsible for:

- Wayland and Smithay Client Toolkit events,
- keyboard and pointer input,
- shared-memory buffer management,
- rendering,
- configuration reload notifications.

A Tokio runtime handles asynchronous work such as:

- systemd-logind calls through [`zbus`](https://docs.rs/zbus/latest/zbus/),
- daemon IPC,
- other background I/O.

Results from asynchronous tasks are returned to the main thread
through a Calloop channel. Wayland objects remain confined to the
Calloop thread.

## Rendering

The menu is rendered using shared-memory buffers with [`Tiny Skia`](https://docs.rs/tiny_skia/latest/tiny_skia/).
Text shaping and glyph rasterization are performed using
[`Cosmic Text`](https://docs.rs/cosmic_text/latest/cosmic_text/), while embedded SVG assets provide scalable action icons.

The renderer does not use GTK and therefore does not inherit the
user's GTK theme. Colors, dimensions, typography, spacing, and corner
radii are controlled by the application's configuration.

<!-- cargo-rdme end -->

## Contributing

Contributions are welcome from everyone. Please see the [CONTRIBUTING](CONTRIBUTING.md)
guide for more details on how to get involved.

## License

This project is licensed under the GNU General Public License v3.0 or later.
See the [LICENSE](LICENSE) file for details.