Salastil/DankMaterialShell
1
0
Fork 0
mirror of https://github.com/AvengeMedia/DankMaterialShell.git synced 2025-12-05 21:15:38 -05:00
Code Packages Releases Activity

Simplify ReadMe & Docs IPC commands

Browse Source
This commit is contained in:
purian23
2025-08-22 23:02:46 -04:00
parent 0eff022adc
commit 07fa4a4484
2 changed files with 69 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files

74
README.md
View File

@@ -174,7 +174,7 @@ paru -S dankmaterialshell-git
mkdir -p ~/.config/quickshell
```
```bash
git clone https://github.com/AvengeMedia/DankMaterialShell.git ~/.config/quickshell/DankMaterialShell
git clone https://github.com/AvengeMedia/DankMaterialShell.git ~/.config/quickshell/DMS
```
```bash
qs -c DankMaterialShell
@@ -267,7 +267,7 @@ spawn-at-startup "/usr/lib/mate-polkit/polkit-mate-authentication-agent-1"
// This may be a different path on different distributions, the above is for the arch linux mate-polkit package
// Starts DankShell
spawn-at-startup "qs" "-c" "DankMaterialShell"
spawn-at-startup "qs" "-c" "DMS"
// If using niri newer than 271534e115e5915231c99df287bbfe396185924d (~aug 17 2025)
// you can add this to disable built in config load errors since dank shell provides this
@@ -282,41 +282,41 @@ config-notification {
// 4. For the increment/decrement ones you can change the steps to whatever you like too
binds {
Mod+Space hotkey-overlay-title="Application Launcher" {
spawn "qs" "-c" "DankMaterialShell" "ipc" "call" "spotlight" "toggle";
spawn "qs" "-c" "DMS" "ipc" "call" "spotlight" "toggle";
}
Mod+V hotkey-overlay-title="Clipboard Manager" {
spawn "qs" "-c" "DankMaterialShell" "ipc" "call" "clipboard" "toggle";
spawn "qs" "-c" "DMS" "ipc" "call" "clipboard" "toggle";
}
Mod+M hotkey-overlay-title="Task Manager" {
spawn "qs" "-c" "DankMaterialShell" "ipc" "call" "processlist" "toggle";
spawn "qs" "-c" "DMS" "ipc" "call" "processlist" "toggle";
}
Mod+N hotkey-overlay-title="Notification Center" {
spawn "qs" "-c" "DankMaterialShell" "ipc" "call" "notifications" "toggle";
spawn "qs" "-c" "DMS" "ipc" "call" "notifications" "toggle";
}
Mod+Comma hotkey-overlay-title="Settings" {
spawn "qs" "-c" "DankMaterialShell" "ipc" "call" "settings" "toggle";
spawn "qs" "-c" "DMS" "ipc" "call" "settings" "toggle";
}
Super+Alt+L hotkey-overlay-title="Lock Screen" {
spawn "qs" "-c" "DankMaterialShell" "ipc" "call" "lock" "lock";
spawn "qs" "-c" "DMS" "ipc" "call" "lock" "lock";
}
XF86AudioRaiseVolume allow-when-locked=true {
spawn "qs" "-c" "DankMaterialShell" "ipc" "call" "audio" "increment" "3";
spawn "qs" "-c" "DMS" "ipc" "call" "audio" "increment" "3";
}
XF86AudioLowerVolume allow-when-locked=true {
spawn "qs" "-c" "DankMaterialShell" "ipc" "call" "audio" "decrement" "3";
spawn "qs" "-c" "DMS" "ipc" "call" "audio" "decrement" "3";
}
XF86AudioMute allow-when-locked=true {
spawn "qs" "-c" "DankMaterialShell" "ipc" "call" "audio" "mute";
spawn "qs" "-c" "DMS" "ipc" "call" "audio" "mute";
}
XF86AudioMicMute allow-when-locked=true {
spawn "qs" "-c" "DankMaterialShell" "ipc" "call" "audio" "micmute";
spawn "qs" "-c" "DMS" "ipc" "call" "audio" "micmute";
}
XF86MonBrightnessUp allow-when-locked=true {
spawn "qs" "-c" "DankMaterialShell" "ipc" "call" "brightness" "increment" "5" "";
spawn "qs" "-c" "DMS" "ipc" "call" "brightness" "increment" "5" "";
}
// You can override the default device for e.g. keyboards by adding the device name to the last param
XF86MonBrightnessDown allow-when-locked=true {
spawn "qs" "-c" "DankMaterialShell" "ipc" "call" "brightness" "decrement" "5" "";
spawn "qs" "-c" "DMS" "ipc" "call" "brightness" "decrement" "5" "";
}
}
```
@@ -334,7 +334,7 @@ exec-once = /usr/lib/mate-polkit/polkit-mate-authentication-agent-1
# This may be a different path on different distributions, the above is for the arch linux mate-polkit package
# Starts DankShell
exec-once = qs -c DankMaterialShell
exec-once = qs -c DMS
# Dank keybinds
# 1. These should not be in conflict with any pre-existing keybindings
@@ -343,23 +343,23 @@ exec-once = qs -c DankMaterialShell
# 4. For the increment/decrement ones you can change the steps to whatever you like too
# Application and system controls
bind = SUPER, Space, exec, qs -c DankMaterialShell ipc call spotlight toggle
bind = SUPER, V, exec, qs -c DankMaterialShell ipc call clipboard toggle
bind = SUPER, M, exec, qs -c DankMaterialShell ipc call processlist toggle
bind = SUPER, N, exec, qs -c DankMaterialShell ipc call notifications toggle
bind = SUPER, comma, exec, qs -c DankMaterialShell ipc call settings toggle
bind = SUPERALT, L, exec, qs -c DankMaterialShell ipc call lock lock
bind = SUPER, Space, exec, qs -c DMS ipc call spotlight toggle
bind = SUPER, V, exec, qs -c DMS ipc call clipboard toggle
bind = SUPER, M, exec, qs -c DMS ipc call processlist toggle
bind = SUPER, N, exec, qs -c DMS ipc call notifications toggle
bind = SUPER, comma, exec, qs -c DMS ipc call settings toggle
bind = SUPERALT, L, exec, qs -c DMS ipc call lock lock
# Audio controls (function keys)
bindl = , XF86AudioRaiseVolume, exec, qs -c DankMaterialShell ipc call audio increment 3
bindl = , XF86AudioLowerVolume, exec, qs -c DankMaterialShell ipc call audio decrement 3
bindl = , XF86AudioMute, exec, qs -c DankMaterialShell ipc call audio mute
bindl = , XF86AudioMicMute, exec, qs -c DankMaterialShell ipc call audio micmute
bindl = , XF86AudioRaiseVolume, exec, qs -c DMS ipc call audio increment 3
bindl = , XF86AudioLowerVolume, exec, qs -c DMS ipc call audio decrement 3
bindl = , XF86AudioMute, exec, qs -c DMS ipc call audio mute
bindl = , XF86AudioMicMute, exec, qs -c DMS ipc call audio micmute
# Brightness controls (function keys)
bindl = , XF86MonBrightnessUp, exec, qs -c DankMaterialShell ipc call brightness increment 5 ""
bindl = , XF86MonBrightnessUp, exec, qs -c DMS ipc call brightness increment 5 ""
# You can override the default device for e.g. keyboards by adding the device name to the last param
bindl = , XF86MonBrightnessDown, exec, qs -c DankMaterialShell ipc call brightness decrement 5 ""
bindl = , XF86MonBrightnessDown, exec, qs -c DMS ipc call brightness decrement 5 ""
```
### IPC Commands
@@ -369,24 +369,24 @@ Control everything from the command line, or via keybinds. For comprehensive doc
# Audio control
```bash
qs -c DankMaterialShell ipc call audio setvolume 50
qs -c DankMaterialShell ipc call audio mute
qs -c DMS ipc call audio setvolume 50
qs -c DMS ipc call audio mute
```
# Launch applications
```bash
qs -c DankMaterialShell ipc call spotlight toggle
qs -c DankMaterialShell ipc call processlist toggle
qs -c DMS ipc call spotlight toggle
qs -c DMS ipc call processlist toggle
```
# System control
```
qs -c DankMaterialShell ipc call wallpaper set /path/to/image.jpg
qs -c DankMaterialShell ipc call theme toggle
qs -c DankMaterialShell ipc call lock lock
qs -c DMS ipc call wallpaper set /path/to/image.jpg
qs -c DMS ipc call theme toggle
qs -c DMS ipc call lock lock
```
# Media control
```
qs -c DankMaterialShell ipc call mpris playPause
qs -c DankMaterialShell ipc call mpris next
qs -c DMS ipc call mpris playPause
qs -c DMS ipc call mpris next
```
## Theming
@@ -563,7 +563,7 @@ All settings are configurable in
**Getting help:**
- Check the [issues](https://github.com/AvengeMedia/DankMaterialShell/issues) for known problems
- Share logs from `qs -c DankMaterialShell` for debugging
- Share logs from `qs -c DMS` for debugging
- Join the niri community for compositor-specific questions
## Contributing

64
docs/IPC.md
View File

@@ -3,7 +3,7 @@
DankMaterialShell provides comprehensive IPC (Inter-Process Communication) functionality that allows external control of the shell through command-line commands. All IPC commands follow the format:
```bash
qs -c DankMaterialShell ipc call <target> <function> [parameters...]
qs -c DMS ipc call <target> <function> [parameters...]
```
## Target: `audio`
@@ -44,9 +44,9 @@ Audio system control and information.
### Examples
```bash
qs -c DankMaterialShell ipc call audio setvolume 50
qs -c DankMaterialShell ipc call audio increment 10
qs -c DankMaterialShell ipc call audio mute
qs -c DMS ipc call audio setvolume 50
qs -c DMS ipc call audio increment 10
qs -c DMS ipc call audio mute
```
## Target: `brightness`
@@ -86,9 +86,9 @@ Display brightness control for internal and external displays.
### Examples
```bash
qs -c DankMaterialShell ipc call brightness set 80
qs -c DankMaterialShell ipc call brightness increment 10 ""
qs -c DankMaterialShell ipc call brightness decrement 5 "intel_backlight"
qs -c DMS ipc call brightness set 80
qs -c DMS ipc call brightness increment 10 ""
qs -c DMS ipc call brightness decrement 5 "intel_backlight"
```
## Target: `night`
@@ -121,8 +121,8 @@ Night mode (gamma/color temperature) control.
### Examples
```bash
qs -c DankMaterialShell ipc call night toggle
qs -c DankMaterialShell ipc call night temperature 4000
qs -c DMS ipc call night toggle
qs -c DMS ipc call night temperature 4000
```
## Target: `mpris`
@@ -161,8 +161,8 @@ Media player control via MPRIS interface.
### Examples
```bash
qs -c DankMaterialShell ipc call mpris playPause
qs -c DankMaterialShell ipc call mpris next
qs -c DMS ipc call mpris playPause
qs -c DMS ipc call mpris next
```
## Target: `lock`
@@ -185,8 +185,8 @@ Screen lock control and status.
### Examples
```bash
qs -c DankMaterialShell ipc call lock lock
qs -c DankMaterialShell ipc call lock isLocked
qs -c DMS ipc call lock lock
qs -c DMS ipc call lock isLocked
```
## Target: `inhibit`
@@ -209,8 +209,8 @@ Idle inhibitor control to prevent automatic sleep/lock.
### Examples
```bash
qs -c DankMaterialShell ipc call inhibit toggle
qs -c DankMaterialShell ipc call inhibit enable
qs -c DMS ipc call inhibit toggle
qs -c DMS ipc call inhibit enable
```
## Target: `wallpaper`
@@ -230,8 +230,8 @@ Wallpaper management and retrieval.
### Examples
```bash
qs -c DankMaterialShell ipc call wallpaper get
qs -c DankMaterialShell ipc call wallpaper set /path/to/image.jpg
qs -c DMS ipc call wallpaper get
qs -c DMS ipc call wallpaper set /path/to/image.jpg
```
## Target: `theme`
@@ -254,8 +254,8 @@ Theme mode control (light/dark mode switching).
### Examples
```bash
qs -c DankMaterialShell ipc call theme toggle
qs -c DankMaterialShell ipc call theme dark
qs -c DMS ipc call theme toggle
qs -c DMS ipc call theme dark
```
## Modal Controls
@@ -305,19 +305,19 @@ System process list and performance modal control.
### Modal Examples
```bash
# Open application launcher
qs -c DankMaterialShell ipc call spotlight toggle
qs -c DMS ipc call spotlight toggle
# Show clipboard history
qs -c DankMaterialShell ipc call clipboard open
qs -c DMS ipc call clipboard open
# Toggle notification center
qs -c DankMaterialShell ipc call notifications toggle
qs -c DMS ipc call notifications toggle
# Show settings
qs -c DankMaterialShell ipc call settings open
qs -c DMS ipc call settings open
# Show system monitor
qs -c DankMaterialShell ipc call processlist toggle
qs -c DMS ipc call processlist toggle
```
## Common Usage Patterns
@@ -328,10 +328,10 @@ These IPC commands are designed to be used with window manager keybindings. Exam
```kdl
binds {
Mod+Space { spawn "qs" "-c" "DankMaterialShell" "ipc" "call" "spotlight" "toggle"; }
Mod+V { spawn "qs" "-c" "DankMaterialShell" "ipc" "call" "clipboard" "toggle"; }
XF86AudioRaiseVolume { spawn "qs" "-c" "DankMaterialShell" "ipc" "call" "audio" "increment" "3"; }
XF86MonBrightnessUp { spawn "qs" "-c" "DankMaterialShell" "ipc" "call" "brightness" "increment" "5" ""; }
Mod+Space { spawn "qs" "-c" "DMS" "ipc" "call" "spotlight" "toggle"; }
Mod+V { spawn "qs" "-c" "DMS" "ipc" "call" "clipboard" "toggle"; }
XF86AudioRaiseVolume { spawn "qs" "-c" "DMS" "ipc" "call" "audio" "increment" "3"; }
XF86MonBrightnessUp { spawn "qs" "-c" "DMS" "ipc" "call" "brightness" "increment" "5" ""; }
}
```
@@ -344,9 +344,9 @@ IPC commands can be used in scripts for automation:
# Toggle night mode based on time of day
hour=$(date +%H)
if [ $hour -ge 20 ] || [ $hour -le 6 ]; then
qs -c DankMaterialShell ipc call night enable
qs -c DMS ipc call night enable
else
qs -c DankMaterialShell ipc call night disable
qs -c DMS ipc call night disable
fi
```
@@ -356,9 +356,9 @@ Many commands provide status information useful for scripts:
```bash
# Check if screen is locked before performing action
if qs -c DankMaterialShell ipc call lock isLocked | grep -q "false"; then
if qs -c DMS ipc call lock isLocked | grep -q "false"; then
# Perform action only if unlocked
qs -c DankMaterialShell ipc call notifications open
qs -c DMS ipc call notifications open
fi
```