diff --git a/README.md b/README.md index cc6a1d1c..10361ac6 100644 --- a/README.md +++ b/README.md @@ -1,859 +1,156 @@ # DankMaterialShell (dms) -
+
+ + DankMaterialShell Logo + + ### A modern Wayland desktop shell for the scrolling compositor era + + Built with [Quickshell](https://quickshell.org/) and [Go](https://go.dev/) + +[![Documentation](https://img.shields.io/badge/docs-danklinux.com-9ccbfb?style=for-the-badge&labelColor=101418)](https://danklinux.com/docs) [![GitHub stars](https://img.shields.io/github/stars/AvengeMedia/DankMaterialShell?style=for-the-badge&labelColor=101418&color=ffd700)](https://github.com/AvengeMedia/DankMaterialShell/stargazers) [![GitHub License](https://img.shields.io/github/license/AvengeMedia/DankMaterialShell?style=for-the-badge&labelColor=101418&color=b9c8da)](https://github.com/AvengeMedia/DankMaterialShell/blob/master/LICENSE) [![GitHub release](https://img.shields.io/github/v/release/AvengeMedia/DankMaterialShell?style=for-the-badge&labelColor=101418&color=9ccbfb)](https://github.com/AvengeMedia/DankMaterialShell/releases) -[![GitHub last commit](https://img.shields.io/github/last-commit/AvengeMedia/DankMaterialShell?style=for-the-badge&labelColor=101418&color=9ccbfb)](https://github.com/AvengeMedia/DankMaterialShell/commits/master) [![AUR version](https://img.shields.io/aur/version/dms-shell-bin?style=for-the-badge&labelColor=101418&color=9ccbfb)](https://aur.archlinux.org/packages/dms-shell-bin) [![AUR version (git)](https://img.shields.io/aur/version/dms-shell-git?style=for-the-badge&labelColor=101418&color=9ccbfb&label=AUR%20(git))](https://aur.archlinux.org/packages/dms-shell-git) [![Ko-Fi donate](https://img.shields.io/badge/donate-kofi?style=for-the-badge&logo=ko-fi&logoColor=ffffff&label=ko-fi&labelColor=101418&color=f16061&link=https%3A%2F%2Fko-fi.com%2Favengemediallc)](https://ko-fi.com/avengemediallc)
-A modern Wayland desktop shell built with [Quickshell](https://quickshell.org/) and [Go](https://go.dev/). Optimized for the [niri](https://github.com/YaLTeR/niri), [Hyprland](https://hyprland.org/), [sway](https://swaywm.org/), and [dwl/mangowc](https://github.com/DreamMaoMao/mangowc) compositors. +DankMaterialShell is a complete desktop shell for Wayland compositors. It replaces waybar, swaylock, swayidle, mako, fuzzel, polkit, and everything else you'd normally stitch together to make a desktop - all in one cohesive package with a gorgeous interface. -Features notifications, app launcher, wallpaper customization, and fully customizable with [plugins](https://github.com/AvengeMedia/dms-plugin-registry). +--- -## Screenshots +## See it in Action
-
https://github.com/user-attachments/assets/1200a739-7770-4601-8b85-695ca527819a -
-
View More Screenshots - -
+
More Screenshots
-### Desktop Overview +Desktop -DankMaterialShell Desktop +Dashboard -### Dashboard +Launcher -DankDash - -### Application Launcher - -Spotlight Launcher - -### Control Center - -Control Center - -### System Monitor - -System Monitor - -### Widget Customization - -Widget Customization - -### Lock Screen - -Lock Screen - -### Dynamic Theming - -Auto Theme - -### Notification Center - -Notification Center - -### Dock - -Dock +Control Center
-## Quick start (Arch, Fedora, Debian, Ubuntu, openSUSE) +--- + +## Quick Install ```bash curl -fsSL https://install.danklinux.com | sh ``` -*Installs dms & dependencies* -*Or skip to [Installation](https://github.com/AvengeMedia/DankMaterialShell?tab=readme-ov-file#installation)* +That's it. One command installs dms and all dependencies on Arch, Fedora, Debian, Ubuntu, and openSUSE. -
Features +**[Full installation guide →](https://danklinux.com/docs/dankmaterialshell/installation)** -**Core Widgets:** -- **TopBar**: fully customizable bar where widgets can be added, removed, and re-arranged. - - **App Launcher** with fuzzy search, categories, and auto-sorting by most used apps. - - **Workspace Switcher** Configurable workspace switcher. - - **Focused Window** Displays the currently focused window app name and title. - - **Running Apps** A view of all running apps, sorted by monitor, workspace, then position on workspace. - - **Media Player** Short form media player with equalizer, song title, and controls. - - **Clock** Clock and date widget - - **Weather** Weather widget with customizable location - - **System Tray** System tray applets with context menus. - - **Process Monitor** CPU, RAM, and GPU usage percentages, temperatures. (requires [dgop](https://github.com/AvengeMedia/dgop)) - - **Power/Battery** Power/Battery widget for battery metrics and power profile changing. - - **Notifications** Notification bell with a notification center popup - - **Control Center** High-level view of network, bluetooth, and audio status - - **Privacy Indicator** Attempts to reveal if a microphone or screen recording session is active, relying on Pipewire data sources - - **Idle Inhibitor** Creates a systemd idle inhibitor to prevent sleep/locking from occuring. -- **Spotlight Launcher** A central search/launcher - apps, files, emojis, running apps, calculator, command running - and basically anything since it can be enriched with plugins. -- **Central Command** A combined music, weather, calendar, and events PopUp. -- **Process List** A process list, with system metrics and information. More detailed modal available via IPC. -- **Notification Center** A center for notifications that has support for grouping. -- **Dock** A dock with pinned apps support, recent apps support, and currently running application support. -- **Control Center** A full control center with user profile information, network, bluetooth, audio input/output, display controls, and night mode automation. -- **Lock Screen** Using quickshell's WlSessionLock with embedded virtual keyboard for Niri (Niri doesn't support placing virtual keyboard above lockscreen natively: [issue](https://github.com/YaLTeR/niri/issues/2201)) -- **Notepad** A simple text notepad/scratchpad with auto-save to session data and file export/import functionality. +--- -
+## What You Get -## Highlights +**Dynamic Theming** +Wallpaper-based color schemes that automatically theme GTK, Qt, terminals, and more with [matugen](https://github.com/InioX/matugen). -- Auto-theming GTK, QT, Terminal apps, and more with [matugen](https://github.com/InioX/matugen) + optional theme generation from wallpaper. -- 20+ widgets that can be added and re-arranged on the bar. -- Process list, temperature monitoring, and resource monitoring with [dgop](https://github.com/AvengeMedia/dgop) -- Notification service with support for grouping and richtext -- App launcher + Spotlighht launcher with fuzzy search -- Control center with mpris player, weather, and calendar integration. -- Clipboard history view with image previews. -- A dock for running apps + pinned apps -- Configure bluetooth, wifi, and audio input+output devices. -- A lock screen -- Idle monitoring - configure auto lock, screen off, suspend, and hibernate with different knobs for battery + AC power. -- A greeter -- A comprehensive plugin system for endless customization possibilities. +**System Monitoring** +Real-time CPU, RAM, GPU metrics and temps with [dgop](https://github.com/AvengeMedia/dgop). Full process list with search and management. -**TL;DR** *dms replaces your waybar, swaylock, swayidle, hypridle, hyprlock, fuzzels, walker, mako, and basically everything you use to stitch a desktop together* +**Powerful Launcher** +Spotlight-style search for apps, files, emojis, running windows, calculator, commands - extensible with plugins. -## Installation +**Control Center** +Network, Bluetooth, audio devices, display settings, night mode - all in one clean interface. -### Compositor Setup +**Smart Notifications** +Notification center with grouping, rich text support, and keyboard navigation. -DankMaterialShell particularly aims at supporting the **niri**, **Hyprland**, **sway**, and **dwl/MangoWC** compositors, but it does support more wayland compositors with a diminished feature set (no monitor off, workspace switcher, overview integration, etc.): +**Media Integration** +MPRIS player controls, calendar sync, weather widgets, clipboard history with image previews. -**Niri**: -```bash -# Arch Linux -sudo pacman -S niri +**Complete Session Management** +Lock screen, idle detection, auto-lock/suspend with separate AC/battery settings, greeter support. -# Fedora -sudo dnf copr enable yalter/niri && sudo dnf install niri -``` +**Plugin System** +Endless customization with the [plugin registry](https://plugins.danklinux.com). -For detailed niri installation instructions, see the [niri Getting Started guide](https://yalter.github.io/niri/Getting-Started.html). +**TL;DR** - One shell replaces waybar, swaylock, swayidle, mako, fuzzel, polkit and everything else you normally piece together to create a linux desktop. -**Hyprland**: -```bash -# Arch Linux -sudo pacman -S hyprland +--- -# Or from AUR for latest -paru -S hyprland-git +## Supported Compositors -# Fedora -sudo dnf install hyprland +DankMaterialShell works best with **[niri](https://github.com/YaLTeR/niri)**, **[Hyprland](https://hyprland.org/)**, **[sway](https://swaywm.org/)**, and **[dwl/MangoWC](https://github.com/DreamMaoMao/mangowc)** - with full workspace switching, overview integration, and monitor management. -# Or use Copr for latest builds -sudo dnf copr enable solopasha/hyprland && sudo dnf install hyprland -``` +Other Wayland compositors work too, just with a reduced feature set. -For detailed Hyprland installation instructions, see the [Hyprland wiki](https://wiki.hypr.land/Getting-Started/Installation/). +**[Compositor configuration guide →](https://danklinux.com/docs/dankmaterialshell/compositors)** -**sway/dwl (MangoWC)**: +--- -TODO - not documented. +## Keybinds & IPC -### Dank Shell Installation +Control everything from the command line or keybinds: -*feel free to contribute steps for other distributions* - -#### Arch Linux - via AUR - -```bash -# Stable release -paru -S dms-shell-bin -# Latest -git -paru -S dms-shell-git -``` - -#### Fedora - via COPR - -```bash -# Stable release -sudo dnf copr enable avengemedia/dms && sudo dnf install dms -# Latest -git -sudo dnf copr enable avengemedia/dms-git && sudo dnf install dms -``` - -#### NixOS - via flake - -```bash -nix profile install github:AvengeMedia/DankMaterialShell -``` - -#### NixOS - via home-manager - -To install using home-manager, you need to add this repo into your flake inputs: - -``` nix -dgop = { - url = "github:AvengeMedia/dgop"; - inputs.nixpkgs.follows = "nixpkgs"; -}; -dms-cli = { - url = "github:AvengeMedia/danklinux"; - inputs.nixpkgs.follows = "nixpkgs"; -}; -dankMaterialShell = { - url = "github:AvengeMedia/DankMaterialShell"; - inputs.nixpkgs.follows = "nixpkgs"; - inputs.dgop.follows = "dgop"; - inputs.dms-cli.follows = "dms-cli"; -}; -``` - -Then somewhere in your home-manager config, add this to the imports: - -``` nix -imports = [ - inputs.dankMaterialShell.homeModules.dankMaterialShell.default -]; -``` - -If you use Niri, the `niri` homeModule provides additional options for Niri integration, such as key bindings and spawn: - -``` nix -imports = [ - inputs.dankMaterialShell.homeModules.dankMaterialShell.default - inputs.dankMaterialShell.homeModules.dankMaterialShell.niri -]; -``` - -> [!IMPORTANT] -> To use the `niri` homeModule, you must have `sobidoo/niri-flake` in your inputs: - -``` nix -niri = { - url = "github:sodiboo/niri-flake"; - inputs.nixpkgs.follows = "nixpkgs"; -}; -``` - -And import it in home-manager: - -``` nix -imports = [ - inputs.niri.homeModules.niri -]; -``` - -Now you can enable it with: - -``` nix -programs.dankMaterialShell.enable = true; -``` - -There are a lot of possible configurations that you can enable/disable in the flake, check [nix/default.nix](nix/default.nix) and [nix/niri.nix](nix/niri.nix) to see them all. - -#### Other Distributions - via manual installation - -#### 1. Install Quickshell (Varies by Distribution) -```bash -# Arch -paru -S quickshell-git -# Fedora -sudo dnf copr enable avengemedia/danklinux && sudo dnf install quickshell-git -# ! TODO - document other distros -``` - -#### 2. Install the shell - -#### 2.1. Clone latest QML - -```bash -mkdir ~/.config/quickshell && git clone https://github.com/AvengeMedia/DankMaterialShell.git ~/.config/quickshell/dms -``` - -**FOR Stable Version, Checkout the latest tag** - -```bash -cd ~/.config/quickshell/dms -# You'll have to re-run this, to update to the latest version. -git checkout $(git describe --tags --abbrev=0) -``` - -#### 2.2. Install latest dms CLI - -```bash -sudo sh -c "curl -L https://github.com/AvengeMedia/danklinux/releases/latest/download/dms-$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/').gz | gunzip | tee /usr/local/bin/dms > /dev/null && chmod +x /usr/local/bin/dms" -``` -**Note:** this is the latest *stable* dms CLI. If you are using QML/master (not pinned to a tag), then you may periodically be missing features, etc. - -If preferred, you can build the dms-cli yourself (requires GO 1.24+) - -```bash -git clone https://github.com/AvengeMedia/danklinux.git && cd danklinux -make && sudo make install -``` - -#### 3. Optional Features (system monitoring, clipboard history, brightness controls, etc.) - -#### 3.1 Core optional dependencies -```bash -# Arch Linux -sudo pacman -S cava wl-clipboard cliphist brightnessctl qt6-multimedia accountsservice -paru -S matugen-bin dgop - -# Fedora -sudo dnf install cava wl-clipboard brightnessctl qt6-qtmultimedia accountsservice -sudo dnf copr enable avengemedia/danklinux && sudo dnf install cliphist ghostty hyprpicker matugen -``` -Note: by enabling and installing the avengemedia/dms copr above, these core dependencies will automatically be available for use. - -*Other distros will just need to find sources for the above packages* - -#### 3.2 - dgop manual installation - -`dgop` is available via AUR and a nix flake, other distributions can install it manually. - -```bash -sudo sh -c "curl -L https://github.com/AvengeMedia/dgop/releases/latest/download/dgop-linux-$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/').gz | gunzip | tee /usr/local/bin/dgop > /dev/null && chmod +x /usr/local/bin/dgop" -``` - -**Optional Requirement Overview** - -- `dgop`: Ability to have system resource widgets, process list modal, and temperature monitoring. -- `matugen`: Wallpaper-based dynamic theming -- `brightnessctl`: Backlight and LED brightness control -- `wl-clipboard`: Required for copying various elements to clipboard. -- `cava`: Audio visualizer -- `cliphist`: Clipboard history -- `qt6-multimedia`: System sound support -- `accountsservice`: Ability to sync - -## Compositor Configuration - -A lot of options are subject to personal preference, but the below sets a good starting point for most features. - -### Systemd Autostart - -**Alternative to compositor-specific autostart**: If you installed DMS from the Fedora Copr repository, you can use systemd to manage DMS autostart instead of adding `dms run` to your compositor config. - -**Benefits:** -- Works across all Wayland compositors (niri, Hyprland, sway, dwl, etc.) -- Centralized control via systemctl -- Automatic restart on failure -- Integrated logging via journalctl - -**Enable autostart:** -```bash -systemctl --user enable dms.service -``` - -**Manual control:** -```bash -# Start DMS now -systemctl --user start dms.service - -# Check status -systemctl --user status dms.service - -# View logs -journalctl --user -u dms.service -f - -# Restart DMS -systemctl --user restart dms.service - -# Disable autostart -systemctl --user disable dms.service -``` - -**Note:** If using systemd autostart, remove `dms run` / `spawn "dms" "run"` from your compositor's configuration to avoid running DMS twice. - -### niri Integration - -Add to your niri config - -```kdl -// Required for clipboard history integration -spawn-at-startup "bash" "-c" "wl-paste --watch cliphist store &" - -// Recommended (must install polkit-mate before hand) for elevation prompts -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 "dms" "run" - -// 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 -config-notification { - disable-failed -} - -// Dank keybinds -// 1. These should not be in conflict with any pre-existing keybindings -// 2. You need to merge them with your existing config if you want to use these -// 3. You can change the keys to whatever you want, if you prefer something different -// 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 "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" "toggle"; - } - Mod+N hotkey-overlay-title="Notification Center" { - spawn "dms" "ipc" "call" "notifications" "toggle"; - } - Mod+Comma hotkey-overlay-title="Settings" { - spawn "dms" "ipc" "call" "settings" "toggle"; - } - Mod+P hotkey-overlay-title="Notepad" { - spawn "dms" "ipc" "call" "notepad" "toggle"; - } - Super+Alt+L hotkey-overlay-title="Lock Screen" { - spawn "dms" "ipc" "call" "lock" "lock"; - } - Mod+X hotkey-overlay-title="Power Menu" { - spawn "dms" "ipc" "call" "powermenu" "toggle"; - } - Mod+C hotkey-overlay-title="Control Center" { - spawn "dms" "ipc" "call" "control-center" "toggle"; - } - Mod+Y hotkey-overlay-title="Browse Wallpapers" { - spawn "dms" "ipc" "call" "dankdash" "wallpaper"; - } - 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"; - } - XF86AudioMicMute allow-when-locked=true { - spawn "dms" "ipc" "call" "audio" "micmute"; - } - XF86MonBrightnessUp allow-when-locked=true { - spawn "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 "dms" "ipc" "call" "brightness" "decrement" "5" ""; - } - // Night mode toggle - Mod+Shift+N allow-when-locked=true { - spawn "dms" "ipc" "call" "night" "toggle"; - } -} - -// You probably want this too -debug { - honor-xdg-activation-with-invalid-serial -} -``` - -#### niri - place wallpaper on overview (blurred or non-blurred) - -Place the wallpaper on backdrop using a layer-rule for a contiguous surface. - -```kdl -layer-rule { - match namespace="quickshell" - place-within-backdrop true -} -``` - -If using "Blur Layer" option, you may want the blurred layer to appear on overview only, that can be done with some layer rules: - -```kdl -layer-rule { - match namespace="dms:blurwallpaper" - place-within-backdrop true -} -``` - -#### niri theming - -If using a niri build newer than [3933903](https://github.com/YaLTeR/niri/commit/39339032cee3453faa54c361a38db6d83756f750), you can synchronize colors and gaps with the shell settings by adding the following to your niri config. - -```bash -# For colors -echo -e 'include "dms/colors.kdl"' >> ~/.config/niri/config.kdl -# For gaps, border widths, certain window rules -echo -e 'include "dms/layout.kdl"' >> ~/.config/niri/config.kdl -``` - -### Hyprland Integration - -Add to your Hyprland config (`~/.config/hypr/hyprland.conf`): - -```bash -# Required for clipboard history integration -exec-once = bash -c "wl-paste --watch cliphist store &" - -# Recommended (must install polkit-mate beforehand) for elevation prompts -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 = dms run - -# Dank keybinds -# 1. These should not be in conflict with any pre-existing keybindings -# 2. You need to merge them with your existing config if you want to use these -# 3. You can change the keys to whatever you want, if you prefer something different -# 4. For the increment/decrement ones you can change the steps to whatever you like too - -# Application and system controls -bind = SUPER, Space, exec, dms ipc call spotlight toggle -bind = SUPER, V, exec, dms ipc call clipboard toggle -bind = SUPER, M, exec, dms ipc call processlist toggle -bind = SUPER, N, exec, dms ipc call notifications toggle -bind = SUPER, comma, exec, dms ipc call settings toggle -bind = SUPER, P, exec, dms ipc call notepad toggle -bind = SUPERALT, L, exec, dms ipc call lock lock -bind = SUPER, X, exec, dms ipc call powermenu toggle -bind = SUPER, Y, exec, dms ipc call dankdash wallpaper -bind = SUPER, C, exec, dms ipc call control-center toggle -bind = SUPER, TAB, exec, dms ipc call hypr toggleOverview - -# Audio controls (function keys) -bindl = , XF86AudioRaiseVolume, exec, dms ipc call audio increment 3 -bindl = , XF86AudioLowerVolume, exec, dms ipc call audio decrement 3 -bindl = , XF86AudioMute, exec, dms ipc call audio mute -bindl = , XF86AudioMicMute, exec, dms ipc call audio micmute - -# Brightness controls (function keys) -bindl = , XF86MonBrightnessUp, exec, 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, dms ipc call brightness decrement 5 "" - -# Night mode toggle -bind = SUPERSHIFT, N, exec, dms ipc call night toggle -``` - -## Greeter - -You can install a matching [greetd](https://github.com/kennylevinsen/greetd) greeter, that will give you a greeter that matches the lock screen. - -It's as simple as running `dms greeter install` in most cases, but more information is in the [Greetd module](Modules/Greetd/README.md) - -## IPC Commands - -Control everything from the command line, or via keybinds. For comprehensive documentation of all available IPC commands, see [docs/IPC.md](docs/IPC.md). - -### Audio control -```bash -dms ipc call audio setvolume 50 -dms ipc call audio mute -``` -### Launch applications ```bash dms ipc call spotlight toggle -dms ipc call notepad toggle -dms ipc call processlist toggle -dms ipc call powermenu toggle -``` -### System control -``` +dms ipc call audio setvolume 50 dms ipc call wallpaper set /path/to/image.jpg dms ipc call theme toggle -dms ipc call night toggle -dms ipc call lock lock -``` -### Media control -``` -dms ipc call mpris playPause -dms ipc call mpris next ``` +**[Full keybind and IPC documentation →](https://danklinux.com/docs/dankmaterialshell/keybinds-ipc)** + +--- + ## Theming -dms will spawn a matugen process on theme changes to generate color palettes for installed and supported apps. If you do not want these files generated, you can set the env variable `DMS_DISABLE_MATUGEN=1` to disable it entirely. +DankMaterialShell automatically generates color schemes from your wallpaper and applies them to GTK, Qt, terminals, and more. -### Custom Themes +**Application theming:** [GTK, Qt, Firefox, terminals →](https://danklinux.com/docs/dankmaterialshell/application-themes) -DankMaterialShell supports custom color themes! You can create your own Material Design 3 color schemes or use pre-made themes like Cyberpunk Electric, Hotline Miami, and Miami Vice. +**Custom themes:** [Create your own color schemes →](https://danklinux.com/docs/dankmaterialshell/custom-themes) -For detailed instructions on creating and using custom themes, see [docs/CUSTOM_THEMES.md](docs/CUSTOM_THEMES.md). - -### System App Integration - -There's two toggles in the appearance section of settings, for GTK and QT apps. - -These settings will override some local GTK and QT configuration files, you can still integrate auto-theming if you do not wish DankShell to mess with your QTCT/GTK files. - -No matter what when matugen is enabled the files will be created on wallpaper changes: - -- ~/.config/gtk-3.0/dank-colors.css -- ~/.config/gtk-4.0/dank-colors.css -- ~/.config/qt6ct/colors/matugen.conf -- ~/.config/qt5ct/colors/matugen.conf - -If you do not like our theme path, you can integrate this with other GTK themes, matugen themes, etc. - -#### GTK Apps - -1. Install adw-gtk3 - -```bash -# Arch -sudo pacman -S adw-gtk-theme -# Fedora -sudo dnf install adw-gtk3-theme -``` - -In dms settings, navigate to Theme & Colors, and "apply GTK themes" - -This will create symlinks from `~/.config/gtk-3.0/4.0/dank-colors.css` to `~/.config/gtk-3.0/4.0/gtk.css` which enables theming. - -#### QT: basic gtk3 based theme (Option 1) - -If you mostly use gtk apps, you'll probably be happy to just set the QT platform theme to gtk3. - -```kdl -environment { - // Add to existing environment block - QT_QPA_PLATFORMTHEME "gtk3" - QT_QPA_PLATFORMTHEME_QT6 "gtk3" -} -``` - -#### QT: better theming (Option 2) - -1. Install qt6ct-kde - -```bash -# Arch -paru -S qt6ct-kde -``` - -*I'm not sure what it is on other distros, but you can manually install via instructions provides on [qt6ct-kde github](https://www.opencode.net/trialuser/qt6ct) - -2. **Configure Environment in niri** - -```kdl - // Add to existing environment block - QT_QPA_PLATFORMTHEME "qt6ct" - QT_QPA_PLATFORMTHEME_QT6 "qt6ct" -``` - -You'll have to restart your session for themes to take effect. - -Nevigate to dms settings -> themes & colors -> and click "Apply QT Themes" - -#### Firefox - -There are two theme paths for Firefox, using with [pywalfox](https://github.com/Frewacom/pywalfox) or [material fox](https://github.com/edelvarden/material-fox-updated) - -**(Option 1) - pywalfox** - -1. **Install [pywalfox](https://github.com/Frewacom/pywalfox)** on system. -- Available in AUR via `paru -S python-pywalfox` - -2. **Install [pywalfox extension](https://addons.mozilla.org/firefox/addon/pywalfox/)** in firefox. - -3. **Restart dms and create symlink** to generate palette and then enable dank colors. -- Run `ln -sf ~/.cache/wal/dank-pywalfox.json ~/.cache/wal/colors.json` - - -**(Option 2) - Chrome-like theme with dynamic colors** - -Firefox does use the GTK3 theme, but it doesn't look that good on the stock theme IMO. A separate matugen css is generated for the [material fox](https://github.com/edelvarden/material-fox-updated) theme, you can configure that theme with dynamic colors by following the steps below. - -1. **In firefox, navigate to `about:config`** -- set `toolkit.legacyuserprofilecustomizations.stylesheets` to `true` -- set `svg.context-properties.content.enabled` to `true` -- Create a new property called `userChrome.theme-material` and type `boolean` - - set to `true` - -
Expand for firefox screenshots -image -image -image -
- -2. **Install material fox theme** -```bash -# Find Firefox profile directory -export PROFILE_DIR=$(find ~/.mozilla/firefox -maxdepth 1 -type d -name "*.default-release" | head -n 1) - -# Download, extract to profile dir, and cleanup -curl -L -o "$PROFILE_DIR/chrome.zip" https://github.com/edelvarden/material-fox-updated/releases/download/v2.0.0/chrome.zip -unzip -o "$PROFILE_DIR/chrome.zip" -d "$PROFILE_DIR" -rm "$PROFILE_DIR/chrome.zip" -``` - -3. **Configure dynamic colors for material fox theme** -```bash -export PROFILE_DIR=$(find ~/.mozilla/firefox -maxdepth 1 -type d -name "*.default-release" | head -n 1) -rm -f "$PROFILE_DIR/chrome/theme-material-blue.css" -ln -sf ~/.config/DankMaterialShell/firefox.css "$PROFILE_DIR/chrome/theme-material-blue.css" -``` - -### Terminal Integration - -The matugen integration will automatically generate new colors for certain apps only if they are installed. - -You can enable the dynamic color schemes in supported terminal apps by modifying their configurations: - -**Ghostty**: - -```bash -echo "config-file = ./config-dankcolors" >> ~/.config/ghostty/config -``` - -If you want to disable excessive config reloaded popup sin ghostty, you may wish to also add this: - -```bash -# These are the default danklinux options, if you still want config reloaded and copied to clipboard popups you can skip it. -echo "app-notifications = no-clipboard-copy,no-config-reload" >> ~/.config/ghostty/config -``` - -**kitty**: - -```bash -echo "include dank-theme.conf" >> ~/.config/kitty/kitty.conf -``` +--- ## Plugins -[Plugin registry](https://github.com/AvengeMedia/dms-plugin-registry) - collection of available dms plugins. +Extend dms with the plugin system. Browse community plugins at [plugins.danklinux.com](https://plugins.danklinux.com). -dms features a plugin system - meaning you can create your own widgets and load other user widgets. +**[Plugin development guide →](https://danklinux.com/docs/dankmaterialshell/plugins-overview)** -More comprehensive details available in the [PLUGINS](PLUGINS/README.md) - and examples [Emoji Plugin](PLUGINS/ExampleEmojiPlugin) and [Wallpaper Change Hook](PLUGINS/WallpaperWatcherDaemon) are available for reference. +--- -Install an example plugin by: +## Documentation -```bash -mkdir ~/.config/DankMaterialShell/plugins -cp -R ./PLUGINS/ExampleEmojiPlugin ~/.config/DankMaterialShell/plugins -``` +**Website:** [danklinux.com](https://danklinux.com) -**Only install plugins from TRUSTED sources.** Plugins execute QML and javascript at runtime, plugins from third parties should be reviewed before enabling them in dms. +**Docs:** [danklinux.com/docs](https://danklinux.com/docs) -### NixOS - via home-manager +**Support:** [Ko-fi](https://ko-fi.com/avengemediallc) -Add the following to your home-manager config to install a plugin: - -```nix -programs.dankMaterialShell.plugins = { - ExampleEmojiPlugin.src = "${inputs.dankMaterialShell}/PLUGINS/ExampleEmojiPlugin"; -}; -``` - -### Calendar Setup - -Sync your caldev compatible calendar (Google, Office365, etc.) for dashboard integration: - -
Configuration Steps - -**Install dependencies:** - -#### Arch -```bash -sudo pacman -S vdirsyncer khal python-aiohttp-oauthlib -``` - -#### Fedora -```bash -sudo dnf install python3-vdirsyncer khal python3-aiohttp-oauthlib -``` - -**Configure vdirsyncer** (`~/.vdirsyncer/config`): - -```ini -[general] -status_path = "~/.calendars/status" - -[pair personal_sync] -a = "personal" -b = "personallocal" -collections = ["from a", "from b"] -conflict_resolution = "a wins" -metadata = ["color"] - -[storage personal] -type = "google_calendar" -token_file = "~/.vdirsyncer/google_calendar_token" -client_id = "your_client_id" -client_secret = "your_client_secret" - -[storage personallocal] -type = "filesystem" -path = "~/.calendars/Personal" -fileext = ".ics" -``` - -**Setup sync:** - -```bash -vdirsyncer sync -khal configure -``` - -#### Auto-sync every 5 minutes -```bash -crontab -e -# Add: */5 * * * * /usr/bin/vdirsyncer sync -``` - -
- -## Configuration - -All settings are configurable in -``` -~/.config/DankMaterialShell/settings.json`, or more intuitively the built-in settings modal. -``` - -**Key configuration areas:** - -- Widget positioning and behavior -- Theme and color preferences -- Time format, weather units and location -- Light/Dark modes -- Wallpaper and Profile picture -- Dock enable/disable and various tunes. - -## Troubleshooting - -**Common issues:** - -- **No dynamic theming:** Install matugen and enable in settings -- **Qt apps not themed:** Configure qt5ct/qt6ct and set QT_QPA_PLATFORMTHEME -- **Calendar not syncing:** Check vdirsyncer credentials and network connectivity - -**Getting help:** - -- Check the [issues](https://github.com/AvengeMedia/DankMaterialShell/issues) for known problems -- Re-run the shell with `dms kill && dms run` to capture logs. -- Join the niri community for compositor-specific questions +--- ## Contributing -DankMaterialShell welcomes contributions! Whether it's bug fixes, new widgets, theme improvements, or documentation updates - all help is appreciated. +Contributions welcome! Bug fixes, new widgets, theme improvements, or docs - it all helps. -**Areas that need attention:** +Check the [issues](https://github.com/AvengeMedia/DankMaterialShell/issues) or join the community. -- More widget options and customization -- Additional compositor compatibility -- Performance optimizations -- Documentation and examples +--- ## Credits diff --git a/assets/danklogo2.svg b/assets/danklogo2.svg new file mode 100644 index 00000000..1ee6d513 --- /dev/null +++ b/assets/danklogo2.svg @@ -0,0 +1,113 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +