1
0
mirror of https://github.com/AvengeMedia/DankMaterialShell.git synced 2026-06-24 03:55:23 -04:00
hecate cantus 1a39b7f66c shader-based scrolling wallpaper mode (#1802)
* feat: parallax-scroll wallpaper

Add a `Scrolling` wallpaper fill mode that translates the wallpaper crop
with the active workspace — like Android home-screen parallax, but along
niri's vertical workspace axis.

The image is scaled to cover the screen on its non-scroll axis, and the
active workspace index drives a fractional offset into the cropped
overflow along the scroll axis. Scroll position is spring-animated
CPU-side and handed to a minimal single-texture shader as a UV offset.
Per-monitor scroll position is published into SessionData so the lock
screen renders the same crop as the active workspace, keeping visual
continuity across lock/unlock.

Two implementation details worth calling out for review:

- QSG_USE_SIMPLE_ANIMATION_DRIVER=1 is exported to the spawned quickshell
  process. The default animation driver advances in fixed ~16ms steps,
  capping the scroll at 60Hz and desyncing it from compositor motion on
  high-refresh displays; the simple driver advances by real elapsed time,
  restoring native-refresh pacing. Removing it visibly regresses to 60Hz.

- The wallpaper survives wl_output rebind cycles (e.g. OLED image-cleaning
  on DPMS soft-off), which otherwise leave a stuck or void background.
  Recovery re-anchors the scroll target on output-lifecycle signals,
  rebuilds the ShaderEffect against the current render context, and
  re-attaches the wallpaper-layer surface on unlock for parallax-active
  monitors — guarded against lock state so the shader gets reliable frame
  hints.

* simplify bindings and gate lock screen shader in a loader

---------

Co-authored-by: bbedward <bbedward@gmail.com>
2026-06-24 00:14:42 -04:00
2026-06-04 10:15:44 -04:00
2026-06-14 23:35:22 -04:00
2026-06-10 17:01:03 -04:00
2025-11-12 20:34:58 -05:00

DankMaterialShell

DankMaterialShell

A modern desktop shell for Wayland

Built with Quickshell and Go

Documentation GitHub stars GitHub License GitHub release Arch version AUR version (git) Ko-Fi donate

DankMaterialShell is a complete desktop shell for niri, Hyprland, MangoWC, Sway, labwc, Scroll, Miracle WM, and other Wayland compositors. It replaces waybar, swaylock, swayidle, mako, fuzzel, polkit, and everything else you'd normally stitch together to make a desktop.

Repository Structure

This is a monorepo containing both the shell interface and the core backend services:

DankMaterialShell/
├── quickshell/         # QML-based shell interface
│   ├── Modules/        # UI components (panels, widgets, overlays)
│   ├── Services/       # System integration (audio, network, bluetooth)
│   ├── Widgets/        # Reusable UI controls
│   └── Common/         # Shared resources and themes
├── core/               # Go backend and CLI
│   ├── cmd/            # dms CLI and dankinstall binaries
│   ├── internal/       # System integration, IPC, distro support
│   └── pkg/            # Shared packages
├── distro/             # Distribution packaging
│   ├── fedora/         # Fedora RPM specs
│   ├── debian/         # Debian packaging
│   └── nix/            # NixOS/home-manager modules
└── flake.nix           # Nix flake for declarative installation

See it in Action

More Screenshots
Desktop Dashboard Launcher Control Center

Installation

curl -fsSL https://install.danklinux.com | sh

One command installs DMS and all dependencies on Arch, Fedora, Debian, Ubuntu, openSUSE, or Gentoo.

Manual installation guide

Features

Dynamic Theming Wallpaper-based color schemes that automatically theme GTK, Qt, terminals, editors (vscode, vscodium), and more using matugen and dank16.

System Monitoring Real-time CPU, RAM, GPU metrics and temperatures with dgop. Process list with search and management.

Powerful Launcher Spotlight-style search for applications, files (dsearch), emojis, running windows, calculator, and commands. Extensible with plugins.

Control Center Unified interface for network, Bluetooth, audio devices, display settings, and night mode.

Smart Notifications Notification center with grouping, rich text support, and keyboard navigation.

Media Integration MPRIS player controls, calendar sync, weather widgets, and clipboard history with image previews.

Session Management Lock screen, idle detection, auto-lock/suspend with separate AC/battery settings, and greeter support.

Plugin System Extend functionality with the plugin registry.

Supported Compositors

Works best with niri, Hyprland, Sway, MangoWC, labwc, Scroll, and Miracle WM with full workspace switching, overview integration, and monitor management. Other Wayland compositors work with reduced features.

Compositor configuration guide

Command Line Interface

Control the shell from the command line or keybinds:

dms run              # Start the shell
dms ipc call spotlight toggle
dms ipc call audio setvolume 50
dms ipc call wallpaper set /path/to/image.jpg
dms brightness list  # List available displays
dms plugins search   # Browse plugin registry

Full CLI and IPC documentation

Documentation

Development

See component-specific documentation:

  • quickshell/ - QML shell development, widgets, and modules
  • core/ - Go backend, CLI tools, and system integration
  • distro/ - Distribution packaging (Fedora, Debian, NixOS)

Building from Source

Core + Dankinstall:

cd core
make              # Build dms CLI
make dankinstall  # Build installer

Shell:

quickshell -p quickshell/

NixOS:

{
  inputs.dms.url = "github:AvengeMedia/DankMaterialShell";

  # Use in home-manager or NixOS configuration
  imports = [ inputs.dms.homeModules.dank-material-shell ];
}

Contributing

Contributions welcome. Bug fixes, widgets, features, documentation, and plugins all help.

  1. Fork the repository
  2. Make your changes
  3. Test thoroughly
  4. Open a pull request

For documentation contributions, see DankLinux-Docs.

Credits

Star History

Star History Chart

License

MIT License - See LICENSE for details.

Languages
QML 64%
Go 28.3%
CSS 2.8%
JavaScript 1.9%
Shell 1.3%
Other 1.7%