Version: 1.5

Compositor Setup

██████╗ ███╗   ███╗███████╗
██╔══██╗████╗ ████║██╔════╝
██║  ██║██╔████╔██║███████╗
██║  ██║██║╚██╔╝██║╚════██║
██████╔╝██║ ╚═╝ ██║███████║
╚═════╝ ╚═╝     ╚═╝╚══════╝

DankMaterialShell works with any Wayland compositor, but we provide optimized configurations for niri, Hyprland, Sway, MangoWC, labwc, and Miracle WM. These configs include DMS-specific keybindings, proper layer shell rules, and recommended settings.

niri Configuration

niri uses the KDL configuration format. DankMaterialShell integrates seamlessly with niri's scrollable tiling layout.

Key Configuration Sections

DMS will automatically apply key binds, gaps, window radius, and colors if you include the following files in your niri config. You can customize gaps, border radius, and window radius in Settings → Compositor.

// Add to the end of ~/.config/niri/config.kdl
include "dms/colors.kdl"
include "dms/layout.kdl"
include "dms/alttab.kdl"
include "dms/binds.kdl"

tip

Be sure that all files exist before including them in the niri configuration.

mkdir -p ~/.config/niri/dms
touch ~/.config/niri/dms/{colors,layout,alttab,binds}.kdl

For manual configuration recommendations, continue below.

Layout

The niri layout should have a transparent background, in order to integrate wallpapers onto the overview.

layout {
    // You can tailor the gaps to fit dms spacing.
    gaps 5
    background-color "transparent"
}

Layer Rules

Tell niri to place the wallpaper on the overview.

layer-rule {
    match namespace="^quickshell$"
    place-within-backdrop true
}

If "Blur Layer" is enabled, you can place the blurred wallpaper on the overview.

layer-rule {
    match namespace="dms:blurwallpaper"
    place-within-backdrop true
}

For more about layer rules see layer rules.

Startup

For systemd autostart setup, see the Installation guide. If you prefer not to use systemd, add DMS directly to your niri config:

spawn-at-startup "dms" "run"

// Optional: Clipboard history
spawn-at-startup "bash" "-c" "wl-paste --watch cliphist store &"

Environment Variables

environment {
  XDG_CURRENT_DESKTOP "niri"
  QT_QPA_PLATFORM "wayland"
  ELECTRON_OZONE_PLATFORM_HINT "auto"
  QT_QPA_PLATFORMTHEME "gtk3"
  QT_QPA_PLATFORMTHEME_QT6 "gtk3"
}

DMS Keybindings

For the full list of available IPC commands see IPC

binds {
    // Application Launchers
    Mod+Space hotkey-overlay-title="Application Launcher" {
        spawn "dms" "ipc" "call" "spotlight" "toggle";
    }
    Mod+V hotkey-overlay-title="Clipboard Manager" {
        spawn "dms" "ipc" "call" "clipboard" "toggle";
    }
    Mod+M hotkey-overlay-title="Task Manager" {
        spawn "dms" "ipc" "call" "processlist" "focusOrToggle";
    }
    Mod+Comma hotkey-overlay-title="Settings" {
        spawn "dms" "ipc" "call" "settings" "focusOrToggle";
    }
    Mod+N hotkey-overlay-title="Notification Center" {
        spawn "dms" "ipc" "call" "notifications" "toggle";
    }
    Mod+Y hotkey-overlay-title="Browse Wallpapers" {
        spawn "dms" "ipc" "call" "dankdash" "wallpaper";
    }

    // Security
    Mod+Alt+L hotkey-overlay-title="Lock Screen" {
        spawn "dms" "ipc" "call" "lock" "lock";
    }

    // Audio Controls
    XF86AudioRaiseVolume allow-when-locked=true {
        spawn "dms" "ipc" "call" "audio" "increment" "3";
    }
    XF86AudioLowerVolume allow-when-locked=true {
        spawn "dms" "ipc" "call" "audio" "decrement" "3";
    }
    XF86AudioMute allow-when-locked=true {
        spawn "dms" "ipc" "call" "audio" "mute";
    }

    // Brightness Controls
    XF86MonBrightnessUp allow-when-locked=true {
       spawn "dms" "ipc" "call" "brightness" "increment" "5" "";
    }
    XF86MonBrightnessDown allow-when-locked=true {
       spawn "dms" "ipc" "call" "brightness" "decrement" "5" "";
    }
}

Window Rules

Recommended window rules, tailor to your preferences:

window-rule {
    match app-id=r#"^org\.gnome\."#
    draw-border-with-background false
    geometry-corner-radius 12
    clip-to-geometry true
}

window-rule {
    match app-id=r#"^org\.wezfurlong\.wezterm$"#
    match app-id="Alacritty"
    match app-id="zen"
    match app-id="com.mitchellh.ghostty"
    match app-id="kitty"
    draw-border-with-background false
}

window-rule {
    match is-active=false
    opacity 0.9
}

window-rule {
    geometry-corner-radius 12
    clip-to-geometry true
}

// Open DMS windows as floating by default
window-rule {
    match app-id=r#"org.quickshell$"#
    open-floating true
}

Hyprland Configuration

Hyprland uses a simple config file format at ~/.config/hypr/hyprland.conf.

Key Configuration Sections

DMS will automatically apply gaps, window radius, and colors if you include the following files in your Hyprland config. You can customize gaps, border radius, and window radius in Settings → Compositor.

# Add to the end of ~/.config/hypr/hyprland.conf
source = ~/.config/hypr/dms/colors.conf
source = ~/.config/hypr/dms/layout.conf
source = ~/.config/hypr/dms/outputs.conf

tip

Be sure that all files exist before including them in the Hyprland configuration.

mkdir -p ~/.config/hypr/dms
touch ~/.config/hypr/dms/{colors,layout,outputs}.conf

For manual configuration recommendations, continue below.

Startup

For systemd autostart setup (recommended if you have multiple desktop environments), see the Installation guide. If you prefer not to use systemd, add DMS directly to your Hyprland config:

exec-once = dms run

# Optional: Clipboard history
exec-once = bash -c "wl-paste --watch cliphist store &"

Miscellaneous

Disables the hyprland backdrop/logo

misc {
    disable_hyprland_logo = true
    disable_splash_rendering = true
}

Environment Variables

env = QT_QPA_PLATFORM,wayland
env = ELECTRON_OZONE_PLATFORM_HINT,auto
env = QT_QPA_PLATFORMTHEME,gtk3
env = QT_QPA_PLATFORMTHEME_QT6,gtk3

Layer Rules

layerrule = noanim, ^(dms)$

For more about layer rules see layer rules.

General Layout

general {
    gaps_in = 5
    gaps_out = 5
    border_size = 0

    col.active_border = rgba(707070ff)
    col.inactive_border = rgba(d0d0d0ff)

    layout = dwindle
}

Decoration

decoration {
    rounding = 12

    active_opacity = 1.0
    inactive_opacity = 0.9

    shadow {
        enabled = true
        range = 30
        render_power = 5
        offset = 0 5
        color = rgba(00000070)
    }
}

DMS Keybindings

For the full list of available IPC commands see IPC

$mod = SUPER

# Application Launchers
bind = $mod, space, exec, dms ipc call spotlight toggle
bind = $mod, V, exec, dms ipc call clipboard toggle
bind = $mod, M, exec, dms ipc call processlist focusOrToggle
bind = $mod, comma, exec, dms ipc call settings focusOrToggle
bind = $mod, N, exec, dms ipc call notifications toggle
bind = $mod, Y, exec, dms ipc call dankdash wallpaper
bind = $mod, TAB, exec, dms ipc call hypr toggleOverview

# Security
bind = $mod ALT, L, exec, dms ipc call lock lock

# Audio Controls
bindel = , XF86AudioRaiseVolume, exec, dms ipc call audio increment 3
bindel = , XF86AudioLowerVolume, exec, dms ipc call audio decrement 3
bindl = , XF86AudioMute, exec, dms ipc call audio mute

# Brightness Controls
bindel = , XF86MonBrightnessUp, exec, dms ipc call brightness increment 5
bindel = , XF86MonBrightnessDown, exec, dms ipc call brightness decrement 5

Window Rules

# Opacity for inactive windows
windowrulev2 = opacity 0.9 0.9, floating:0, focus:0

# GNOME apps
windowrulev2 = rounding 12, class:^(org\.gnome\.)
windowrulev2 = noborder, class:^(org\.gnome\.)

# Terminal apps - no borders
windowrulev2 = noborder, class:^(org\.wezfurlong\.wezterm)$
windowrulev2 = noborder, class:^(Alacritty)$
windowrulev2 = noborder, class:^(zen)$
windowrulev2 = noborder, class:^(com\.mitchellh\.ghostty)$
windowrulev2 = noborder, class:^(kitty)$

# Floating windows
windowrulev2 = float, class:^(gnome-calculator)$
windowrulev2 = float, class:^(blueman-manager)$
windowrulev2 = float, class:^(org\.gnome\.Nautilus)$

# Open DMS windows as floating by default
windowrulev2 = float, class:^(org.quickshell)$

MangoWC Configuration

MangoWC is a dynamic tiling Wayland compositor based on dwl (wlroots). Configuration lives at ~/.config/mango/config.conf.

Key Configuration Sections

DMS will automatically apply gaps, window radius, and colors if you include the following files in your MangoWC config. You can customize gaps, border radius, and window radius in Settings → Compositor.

# Add to the end of ~/.config/mango/config.conf
source=~/.config/mango/dms/colors.conf
source=~/.config/mango/dms/layout.conf
source=~/.config/mango/dms/outputs.conf

tip

Be sure that all files exist before including them in the MangoWC configuration.

mkdir -p ~/.config/mango/dms
touch ~/.config/mango/dms/{colors,layout,outputs}.conf

For manual configuration recommendations, continue below.

Startup

For systemd autostart setup (recommended if you have multiple desktop environments), see the Installation guide. If you prefer not to use systemd, add DMS directly to your MangoWC config:

exec-once=dms run

# Optional: Clipboard history
exec-once=wl-paste --type text --watch cliphist store

Environment Variables

env=QT_QPA_PLATFORM,wayland
env=ELECTRON_OZONE_PLATFORM_HINT,auto
env=QT_QPA_PLATFORMTHEME,gtk3

Appearance

Recommended appearance settings for DMS integration:

# Window appearance
border_radius=12
borderpx=0
focused_opacity=1.0
unfocused_opacity=0.9

# Gaps
gappih=5
gappiv=5
gappoh=5
gappov=5

# Shadows (optional)
shadows=1
shadow_only_floating=1
shadows_size=10
shadows_blur=15

Layer Rules

# Disable animation on DMS layers
layerrule=noanim:1,layer_name:^dms

For more about layer rules see layer rules.

DMS Keybindings

For the full list of available IPC commands see IPC.

# Application Launchers
bind=SUPER,space,spawn,dms ipc call spotlight toggle
bind=SUPER,v,spawn,dms ipc call clipboard toggle
bind=SUPER,m,spawn,dms ipc call processlist focusOrToggle
bind=SUPER,comma,spawn,dms ipc call settings focusOrToggle
bind=SUPER,n,spawn,dms ipc call notifications toggle
bind=SUPER,y,spawn,dms ipc call dankdash wallpaper

# Security
bind=SUPER+ALT,l,spawn,dms ipc call lock lock

# Audio Controls
bind=NONE,XF86AudioRaiseVolume,spawn,dms ipc call audio increment 3
bind=NONE,XF86AudioLowerVolume,spawn,dms ipc call audio decrement 3
bind=NONE,XF86AudioMute,spawn,dms ipc call audio mute

# Brightness Controls
bind=NONE,XF86MonBrightnessUp,spawn,dms ipc call brightness increment 5
bind=NONE,XF86MonBrightnessDown,spawn,dms ipc call brightness decrement 5

Window Rules

# GNOME apps
windowrule=isnoborder:1,appid:^org\.gnome\.

# Terminal apps - no borders
windowrule=isnoborder:1,appid:^org\.wezfurlong\.wezterm$
windowrule=isnoborder:1,appid:^Alacritty$
windowrule=isnoborder:1,appid:^com\.mitchellh\.ghostty$
windowrule=isnoborder:1,appid:^kitty$

# Float DMS windows
windowrule=isfloating:1,appid:^org\.quickshell$

Sway Configuration

Sway is an i3-compatible Wayland compositor. DankMaterialShell integrates with Sway's tiling layout.

Key Configuration Sections

Coming Soon

Detailed Sway configuration sections are coming soon. Sway configuration will include:

Startup commands
Environment variables
DMS keybindings
Layer rules
Window rules

For now, refer to the Example for Sway in the "Other Compositors" section below for basic setup.

Startup

For systemd autostart setup (recommended if you have multiple desktop environments), see the Installation guide. Otherwise, add DMS directly to your Sway config:

exec dms run

# Optional: Clipboard history
exec wl-paste --watch cliphist store

DMS Keybindings

For the full list of available IPC commands see IPC. Basic Sway keybinding examples are available in the Example for Sway section below.

labwc Configuration

labwc is a wlroots-based window-stacking compositor for Wayland, inspired by Openbox.

Key Configuration Sections

Coming Soon

Detailed labwc configuration sections are coming soon. labwc configuration will include:

Startup commands
Environment variables
DMS keybindings
Layer rules
Window rules

For now, refer to the labwc documentation for basic setup.

DMS Keybindings

For the full list of available IPC commands see IPC. labwc keybinding configuration coming soon.

Miracle WM Configuration

Miracle WM is a tiling Wayland compositor built on Mir.

Key Configuration Sections

Coming Soon

Detailed Miracle WM configuration sections are coming soon. Miracle WM configuration will include:

Startup commands
Environment variables
DMS keybindings
Window rules

Startup

For systemd autostart setup (recommended if you have multiple desktop environments), see the Installation guide. Otherwise, add DMS directly to your Miracle WM config.

DMS Keybindings

For the full list of available IPC commands see IPC. Miracle WM keybinding configuration coming soon.

Other Compositors

DankMaterialShell works with any Wayland compositor that supports:

Layer shell protocol (for panels and overlays)
Session lock protocol (for lock screen)
ext-workspace-v1 protocol (for workspace management)
wlr-output-management-unstable-v1 protocol (for interface scaling + output management)

Note: Some compositor-specific features will be unavailable, such as workspace switching.

Basic Integration

For other compositors, you need to:

Auto-start DMS:
```
dms run
```
Configure keybindings using the IPC commands from the Keybinds & IPC guide
Set environment variables in ~/.config/environment.d/90-dms.conf (for systemd users) or your compositor config:
```
QT_QPA_PLATFORM=wayland
```
You can also use systemctl --user edit dms and add Environment=QT_QPA_PLATFORM=wayland under [Service]. This only affects DMS and apps it launches, whereas 90-dms.conf applies to all user sessions.

Example for Sway

Add to ~/.config/sway/config:

# DMS Keybindings
bindsym $mod+space exec dms ipc call spotlight toggle
bindsym $mod+v exec dms ipc call clipboard toggle
bindsym $mod+m exec dms ipc call processlist focusOrToggle
bindsym $mod+comma exec dms ipc call settings focusOrToggle

# Audio controls
bindsym XF86AudioRaiseVolume exec dms ipc call audio increment 3
bindsym XF86AudioLowerVolume exec dms ipc call audio decrement 3
bindsym XF86AudioMute exec dms ipc call audio mute

# Brightness controls
bindsym XF86MonBrightnessUp exec dms ipc call brightness increment 5
bindsym XF86MonBrightnessDown exec dms ipc call brightness decrement 5

Troubleshooting

DMS doesn't start automatically

Check your compositor's logs to ensure the exec-once or equivalent startup command is running. You can also manually start DMS with dms run to see any error messages.

Keybindings don't work

Verify that:

DMS is running (pgrep -f "dms run")
Your keybinding syntax matches your compositor's format

Next Steps

Customize your shell appearance in Themes
Explore all available IPC commands in Keybinds & IPC
Add functionality with Plugins

niri Configuration​

Key Configuration Sections​

Layout​

Layer Rules​

Startup​

Environment Variables​

DMS Keybindings​

Window Rules​

Hyprland Configuration​

Key Configuration Sections​

Startup​

Miscellaneous​

Environment Variables​

Layer Rules​

General Layout​

Decoration​

DMS Keybindings​

Window Rules​

MangoWC Configuration​

Key Configuration Sections​

Startup​

Environment Variables​

Appearance​

Layer Rules​

DMS Keybindings​

Window Rules​

Sway Configuration​

Key Configuration Sections​

Startup​

DMS Keybindings​

labwc Configuration​

Key Configuration Sections​

DMS Keybindings​

Miracle WM Configuration​

Key Configuration Sections​

Startup​

DMS Keybindings​

Other Compositors​

Basic Integration​

Example for Sway​

Troubleshooting​

DMS doesn't start automatically​

Keybindings don't work​

Next Steps​

niri Configuration

Key Configuration Sections

Layout

Layer Rules

Startup

Environment Variables

DMS Keybindings

Window Rules

Hyprland Configuration

Key Configuration Sections

Startup

Miscellaneous

Environment Variables

Layer Rules

General Layout

Decoration

DMS Keybindings

Window Rules

MangoWC Configuration

Key Configuration Sections

Startup

Environment Variables

Appearance

Layer Rules

DMS Keybindings

Window Rules

Sway Configuration

Key Configuration Sections

Startup

DMS Keybindings

labwc Configuration

Key Configuration Sections

DMS Keybindings

Miracle WM Configuration

Key Configuration Sections

Startup

DMS Keybindings

Other Compositors

Basic Integration

Example for Sway

Troubleshooting

DMS doesn't start automatically

Keybindings don't work

Next Steps