Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Default configuration

The annotated default-config.kdl the compositor ships, verbatim. Installed at /usr/share/atrium/default-config.kdl; copy it to ~/.config/atrium/config.kdl to start.

// This config is in the KDL format: https://kdl.dev
// "/-" comments out the following node.
// Atrium inherits most config options from niri upstream:
// https://niri-wm.github.io/niri/Configuration:-Introduction

// Input device configuration.
input {
    keyboard {
        xkb {
            // You can set rules, model, layout, variant and options.
            // For more information, see xkeyboard-config(7).

            // For example:
            // layout "us,ru"
            // options "grp:win_space_toggle,compose:ralt,ctrl:nocaps"
        }

        // Enable numlock on startup, omitting this setting disables it.
        numlock
    }

    // Next sections include libinput settings.
    // Omitting settings disables them, or leaves them at their default values.
    touchpad {
        tap
        natural-scroll
    }

    mouse {
    }

    trackpoint {
    }

    // Uncomment this to make the mouse warp to the center of newly focused windows.
    // warp-mouse-to-focus

    // Focus windows and outputs automatically when moving the mouse into them.
    // Setting max-scroll-amount="0%" makes it work only on windows already fully on screen.
    // focus-follows-mouse max-scroll-amount="0%"
}

// You can configure outputs by their name, which you can find
// by running `atrium msg outputs` while inside an atrium instance.
// The built-in laptop monitor is usually called "eDP-1".
// Remember to uncomment the node by removing "/-"!
/-output "eDP-1" {
    // Uncomment this line to disable this output.
    // off

    // Resolution and, optionally, refresh rate of the output.
    // Run `atrium msg outputs` to list all outputs and their modes.
    mode "1920x1080@120.030"

    // You can use integer or fractional scale, for example use 1.5 for 150% scale.
    scale 2

    // Transform allows to rotate the output counter-clockwise, valid values are:
    // normal, 90, 180, 270, flipped, flipped-90, flipped-180 and flipped-270.
    transform "normal"

    // Position of the output in the global coordinate space.
    // This affects directional monitor actions like "focus-monitor-left", and cursor movement.
    position x=1280 y=0
}

// Settings that influence how windows are positioned and sized.
layout {
    // Default tiling algorithm for new workspaces.
    // Options: "master-stack", "monocle", "centered-master", "grid", "fibonacci"
    // default-algorithm "master-stack"

    // Set gaps around windows in logical pixels.
    gaps 8

    // When to center a window when changing focus, options are:
    // - "never", default behavior, focusing an off-screen window will keep at the left
    //   or right edge of the screen.
    // - "always", the focused window will always be centered.
    // - "on-overflow", focusing a window will center it if it doesn't fit
    //   together with the previously focused window.
    center-focused-window "never"

    // You can customize the widths that the "switch-preset-window-width" action
    // toggles between (not bound by default).
    preset-window-widths {
        proportion 0.33333
        proportion 0.5
        proportion 0.66667
    }

    // You can change the default width of the new windows.
    default-window-width { proportion 0.5; }
    // If you leave the brackets empty, the windows themselves will decide their initial width.
    // default-window-width {}

    // You can change how the focus ring looks.
    focus-ring {
        // How many logical pixels the ring extends out from the windows.
        width 4

        // Color of the ring on the active monitor.
        active-color "#7fc8ff"

        // Color of the ring on inactive monitors.
        inactive-color "#505050"
    }

    // You can also add a border. It's similar to the focus ring, but always visible.
    border {
        // The settings are the same as for the focus ring.
        // If you enable the border, you probably want to disable the focus ring.
        off

        width 4
        active-color "#ffc87f"
        inactive-color "#505050"

        // Color of the border around windows that request your attention.
        urgent-color "#9b0000"
    }

    // You can enable drop shadows for windows.
    shadow {
        // Uncomment the next line to enable shadows.
        // on

        softness 30
        spread 5
        offset x=0 y=5
        color "#0007"
    }
}

// Workspaces (10 fixed, spectrwm-style).
// Named workspaces can set display properties and layout overrides:
//   workspace "media" {
//       label "Media"
//       icon "~/.local/share/icons/Sardi/scalable/apps/multimedia.svg"
//       show-label true
//       show-icon true
//
//       open-on-output "DP-1"
//       layout {
//           default-algorithm "monocle"
//           gaps 0
//       }
//   }
//
// label:      Display text for bars/IPC (defaults to workspace name).
// icon:       Path to an SVG icon file.
// show-label: Whether to expose the label via IPC (default: true if label/name set).
// show-icon:  Whether to expose the icon via IPC (default: true if icon set).

hotkey-overlay {
    // Show keybind help at startup. Press F1 to show again.
    // Uncomment to not show it at startup:
    // skip-at-startup
}

// Alt+Tab is plain focus cycling (the right model for tiling, where every
// window is already visible). The recent-windows MRU switcher is dormant,
// kept for a possible future floating layout; Alt+Grave / Alt+Shift+Grave
// still cycle recent windows of the same app.
// recent-windows {
//     off
// }

// Which input events wake monitors after power-off-monitors.
// Absent = all events wake (default). Empty block = nothing wakes.
// monitor-wake {
//     key-press
//     mouse-click
// }

// Uncomment this line to ask the clients to omit their client-side decorations if possible.
// After enabling or disabling this, you need to restart the apps for this to take effect.
// prefer-no-csd

// You can change the path where screenshots are saved.
// {name} expands to the capture subject: the window's app id, the output name,
// or "desktop" for all-outputs captures. The rest is strftime.
screenshot-path "~/Pictures/Screenshots/{name} %Y-%m-%d %H-%M-%S.png"

// Uncomment to pipe every screenshot into an annotation tool instead of saving it
// directly. The tool receives the PNG on stdin and owns saving/copying from there.
// screenshot-annotator "satty" "--filename" "-"

// What a client-requested minimize does (the iconify keybind always iconifies).
// An iconified window stays on its workspace but leaves the layout until restored.
//   "ignore"                 drop the request; the window stays put (default)
//   "iconify"                honor it natively
//   "send-to-workspace" 5    move the window to workspace 5 instead
// Also available per window rule: iconify-action "iconify"
// iconify-action "ignore"

// Animation settings.
animations {
    // Uncomment to turn off all animations.
    // off

    // Slow down all animations by this factor. Values below 1 speed them up instead.
    // slowdown 3.0
}

// Window rules let you adjust behavior for individual windows.

// Work around WezTerm's initial configure bug.
window-rule {
    match app-id=r#"^org\.wezfurlong\.wezterm$"#
    default-window-width {}
}

// Open the Firefox picture-in-picture player as floating by default.
window-rule {
    match app-id=r#"firefox$"# title="^Picture-in-Picture$"
    open-floating true
}

// Float the atrium-portal screen share picker.
window-rule {
    match app-id="atrium-portal"
    open-floating true
}

binds {
    // Keys consist of modifiers separated by + signs, followed by an XKB key name.
    // "Mod" is Super on a TTY, Alt when running nested in winit.

    // Help — shows keybind overlay. Press any key to dismiss.
    F1 { show-hotkey-overlay; }

    //
    // === Session ===
    //
    Mod+Shift+E { quit; }
    Ctrl+Alt+Delete { quit; }
    Mod+Shift+R { spawn "atrium" "msg" "action" "load-config-file"; }
    Mod+Escape allow-inhibiting=false { toggle-keyboard-shortcuts-inhibit; }

    //
    // === Applications ===
    //
    // Set your preferred terminal, launcher, and browser here.
    Mod+Return { spawn "alacritty"; }
    Mod+R { spawn "fuzzel"; }

    //
    // === Window management ===
    //
    Mod+Q repeat=false { close-window; }
    Mod+Shift+Q repeat=false { kill-window; }

    // Focus
    Alt+Tab       { focus-next-window; }
    Shift+Alt+Tab { focus-prev-window; }
    Mod+Tab       { focus-master; }
    Mod+U         { focus-urgent; }

    // Swap
    Mod+Slash     { swap-with-master; }
    Mod+Shift+J   { swap-next-window; }
    Mod+Shift+K   { swap-prev-window; }

    // Layout algorithm cycling
    Mod+BracketRight { cycle-layout; }
    Mod+BracketLeft  { reset-layout; }
    Mod+Backslash    { flip-layout; }

    // Master area tuning
    Mod+L     { grow-master-ratio; }
    Mod+H     { shrink-master-ratio; }
    Mod+Comma  { inc-master-count; }
    Mod+Period { dec-master-count; }
    Mod+Shift+Comma  { inc-stack-count; }
    Mod+Shift+Period { dec-stack-count; }

    // Floating / fullscreen / maximize
    Mod+F       { toggle-window-floating; }
    Mod+Shift+F { fullscreen-window; }
    Mod+M       { toggle-maximize; }
    Mod+I       { iconify-window; }
    Mod+Shift+I { uniconify-window; }

    //
    // === Workspaces ===
    //
    Mod+1 { focus-workspace 1; }
    Mod+2 { focus-workspace 2; }
    Mod+3 { focus-workspace 3; }
    Mod+4 { focus-workspace 4; }
    Mod+5 { focus-workspace 5; }
    Mod+6 { focus-workspace 6; }
    Mod+7 { focus-workspace 7; }
    Mod+8 { focus-workspace 8; }
    Mod+9 { focus-workspace 9; }
    Mod+0 { focus-workspace 10; }

    // Send window to workspace (stay on current workspace)
    Mod+Shift+1 { move-window-to-workspace 1; }
    Mod+Shift+2 { move-window-to-workspace 2; }
    Mod+Shift+3 { move-window-to-workspace 3; }
    Mod+Shift+4 { move-window-to-workspace 4; }
    Mod+Shift+5 { move-window-to-workspace 5; }
    Mod+Shift+6 { move-window-to-workspace 6; }
    Mod+Shift+7 { move-window-to-workspace 7; }
    Mod+Shift+8 { move-window-to-workspace 8; }
    Mod+Shift+9 { move-window-to-workspace 9; }
    Mod+Shift+0 { move-window-to-workspace 10; }

    // Send window to workspace and follow it
    Mod+Ctrl+1 { move-window-to-workspace 1 focus=true; }
    Mod+Ctrl+2 { move-window-to-workspace 2 focus=true; }
    Mod+Ctrl+3 { move-window-to-workspace 3 focus=true; }
    Mod+Ctrl+4 { move-window-to-workspace 4 focus=true; }
    Mod+Ctrl+5 { move-window-to-workspace 5 focus=true; }
    Mod+Ctrl+6 { move-window-to-workspace 6 focus=true; }
    Mod+Ctrl+7 { move-window-to-workspace 7 focus=true; }
    Mod+Ctrl+8 { move-window-to-workspace 8 focus=true; }
    Mod+Ctrl+9 { move-window-to-workspace 9 focus=true; }
    Mod+Ctrl+0 { move-window-to-workspace 10 focus=true; }

    // Cycle workspaces (occupied only)
    Mod+Right { ws-next; }
    Mod+Left  { ws-prev; }

    // Cycle workspaces (all, including empty)
    Mod+Up   { ws-next-all; }
    Mod+Down { ws-prev-all; }

    // Send window to next/prev workspace
    Mod+Shift+Right { ws-next-move; }
    Mod+Shift+Left  { ws-prev-move; }

    //
    // === Monitors ===
    //
    Mod+N { focus-monitor-next; }
    Mod+Shift+N { move-window-to-monitor-next; }

    // Scroll wheel workspace switching
    Mod+WheelScrollDown cooldown-ms=150 { ws-next-all; }
    Mod+WheelScrollUp   cooldown-ms=150 { ws-prev-all; }

    //
    // === Media keys ===
    //
    XF86AudioRaiseVolume allow-when-locked=true { spawn-sh "wpctl set-volume -l 1.5 @DEFAULT_AUDIO_SINK@ 5%+"; }
    XF86AudioLowerVolume allow-when-locked=true { spawn-sh "wpctl set-volume @DEFAULT_AUDIO_SINK@ 5%-"; }
    XF86AudioMute        allow-when-locked=true { spawn-sh "wpctl set-mute @DEFAULT_AUDIO_SINK@ toggle"; }
    XF86AudioMicMute     allow-when-locked=true { spawn-sh "wpctl set-mute @DEFAULT_AUDIO_SOURCE@ toggle"; }

    XF86MonBrightnessUp   allow-when-locked=true { spawn "brightnessctl" "set" "+10%"; }
    XF86MonBrightnessDown allow-when-locked=true { spawn "brightnessctl" "set" "10%-"; }

    //
    // === Screenshots ===
    //
    Print { screenshot; }
    Shift+Print { screenshot-screen; }
    Alt+Print { screenshot-all; }
    Ctrl+Print { screenshot-window; }

    //
    // === Monitor power ===
    //
    Mod+Shift+X { power-off-monitors; }
    Mod+Ctrl+X  { power-on-monitors; }
}