Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
X
ximper-shell-osd
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Registry
Registry
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Ximper Linux
ximper-shell-osd
Commits
c4762b2b
Verified
Commit
c4762b2b
authored
Mar 28, 2026
by
Kirill Unitsaev
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
add README
parent
3e899e72
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
69 additions
and
0 deletions
+69
-0
README.md
README.md
+69
-0
No files found.
README.md
0 → 100644
View file @
c4762b2b
# ximper-shell-osd
On-screen display daemon.
A component of the Ximper Shell.
Displays volume and brightness OSD overlays on Wayland. Built with Vala, GTK4, libadwaita, gtk4-layer-shell.
## Build
```
sh
meson setup _build
ninja
-C
_build
./_build/src/ximper-shell-osd
```
### Build options
| Option | Default | Description |
| ------------- | ------- | ---------------------------------------- |
|
`pulse-audio`
|
`true`
| Monitor PulseAudio volume changes |
|
`ddc`
|
`true`
| Monitor DDC/CI brightness via libddcutil |
```
sh
meson setup _build
-Dddc
=
false
```
## Config
`~/.config/ximper-shell/osd/config.json`
```
json
{
"timeout_ms"
:
1500
,
"margin_bottom"
:
80
,
"width"
:
300
,
"monitor_volume"
:
true
,
"monitor_brightness"
:
true
,
"monitor_ddc"
:
true
,
"ddc_poll_interval_sec"
:
5
}
```
| Key | Type | Default | Description |
| ----------------------- | ---- | ------- | --------------------------------- |
|
`timeout_ms`
| int |
`1500`
| OSD display duration in ms |
|
`margin_bottom`
| int |
`80`
| Bottom margin in pixels |
|
`width`
| int |
`300`
| OSD window width in pixels |
|
`monitor_volume`
| bool |
`true`
| Monitor PulseAudio volume changes |
|
`monitor_brightness`
| bool |
`true`
| Monitor sysfs backlight changes |
|
`monitor_ddc`
| bool |
`true`
| Monitor DDC/CI brightness changes |
|
`ddc_poll_interval_sec`
| int |
`5`
| DDC polling interval in seconds |
All fields are optional — defaults are used when config is absent.
## D-Bus
`ru.ximperlinux.shell.OSD`
at
`/ru/ximperlinux/shell/OSD`
:
-
`ShowVolumeOsd(double percent, bool muted)`
-
`ShowBrightnessOsd(double percent)`
## CSS
Default style is installed to
`/etc/xdg/ximper-shell/osd/style.css`
.
User override:
`~/.config/ximper-shell/osd/style.css`
.
## License
GPL-3.0
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment