Skip to content

feat(media-volume): add media and volume keybinds with configurable volume steps #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
GhostEagle68 wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat(media-volume): add media and volume keybinds with configurable volume steps #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
438a9b7
docs(config): add media and volume keybind examples with configurable…
GhostEagle68 Aug 24, 2026
cfe3403
docs(keybinds): note that media keys can be remapped to any chord
GhostEagle68 Aug 24, 2026
89e8789
docs(keybinds): note wpctl and playerctl requirements for media keys
GhostEagle68 Aug 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/user/keybinds.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,9 +313,9 @@ and widgets via `noctalia msg`. Typical bindings:
## Example: media and brightness keys

```toml
# Volume (via Noctalia OSD)
"XF86AudioRaiseVolume" = "spawn:noctalia msg volume-up 2%"
"XF86AudioLowerVolume" = "spawn:noctalia msg volume-down 2%"
# Volume — change 5% to your preferred step size (1%, 3%, 10%, etc.)
"XF86AudioRaiseVolume" = "spawn:wpctl set-volume @DEFAULT_AUDIO_SINK@ 5%+"
"XF86AudioLowerVolume" = "spawn:wpctl set-volume @DEFAULT_AUDIO_SINK@ 5%-"
"Mod+XF86AudioMute" = "spawn:wpctl set-mute @DEFAULT_AUDIO_SINK@ toggle"

# Media playback (playerctl)
Expand All @@ -331,3 +331,5 @@ and widgets via `noctalia msg`. Typical bindings:
XF86 keys accept the same `Mod`, `Ctrl`, `Alt`, `Shift`, and `Super`
combinations as other keys. Modifier chords also work when the XF86 key is
reported by a separate laptop hotkey device.

Volume control requires `wpctl` (from WirePlumber/PipeWire) while media playback requires `playerctl`. Don't have dedicated media keys? Change `XF86XXX` to `Mod+V`, `Ctrl+Alt+Up`, or any other binding.
10 changes: 10 additions & 0 deletions examples/config.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,16 @@ follows_mouse = false
# "Mod+C" = "window-center"
# "Mod+Shift+T" = "workspace-set-layout:toggle"

# Media and volume (see docs/user/keybinds.md#example-media-and-brightness-keys)
# Change the number to set your preferred volume step (e.g. 1%, 2%, 5%, 10%).
# Requires: wpctl (PipeWire/WirePlumber), playerctl (media playback).
# "XF86AudioRaiseVolume" = "spawn:wpctl set-volume @DEFAULT_AUDIO_SINK@ 5%+"
# "XF86AudioLowerVolume" = "spawn:wpctl set-volume @DEFAULT_AUDIO_SINK@ 5%-"
# "Mod+XF86AudioMute" = "spawn:wpctl set-mute @DEFAULT_AUDIO_SINK@ toggle"
# "XF86AudioPlay" = "spawn:playerctl play-pause"
# "XF86AudioNext" = "spawn:playerctl next"
# "XF86AudioPrev" = "spawn:playerctl prev"

# Window and layer rules (see docs/user/rules.md) ---------------------------

# [[window_rule]]
Expand Down