Dank (dms) Greeter

A greeter for greetd that follows the aesthetics of the dms lock screen.

Features

Multi user: Login with any system user
dms sync: Sync settings with dms for consistent styling between shell and greeter
niri or Hyprland: Use either niri or Hyprland for the greeter's compositor.
Custom PAM: Supports custom PAM configuration in /etc/pam.d/dankshell
Session Memory: Remembers last selected session and user

Installation

The easiest thing is to run dms greeter install or dms for interactive installation.

Manual installation:

Install greetd (in most distro's standard repositories)
Copy assets/dms-niri.kdl or assets/dms-hypr.conf to /etc/greetd

niri if you want to run the greeter under niri, hypr if you want to run the greeter under Hyprland

Copy assets/greet-niri.sh or assets/greet-hyprland.sh to /etc/greetd/start-dms.sh
Edit /etc/greetd/dms-niri.kdl or /etc/greetd/dms-hypr.conf and replace _DMS_PATH_ with the absolute path to dms, e.g. /home/joecool/.config/quickshell/dms
Edit or create /etc/greetd/config.toml

[terminal]
# The VT to run the greeter on. Can be "next", "current" or a number
# designating the VT.
vt = 1

# The default session, also known as the greeter.
[default_session]

# `agreety` is the bundled agetty/login-lookalike. You can replace `/bin/sh`
# with whatever you want started, such as `sway`.

# The user to run the command as. The privileges this user must have depends
# on the greeter. A graphical greeter may for example require the user to be
# in the `video` group.
user = "greeter"

command = "/etc/greetd/start-dms.sh"%

Enable the greeter with sudo systemctl enable greetd

Usage

To run dms in greeter mode you just need to set DMS_RUN_GREETER=1 in the environment.

DMS_RUN_GREETER=1 qs -p /path/to/dms

Configuration

Compositor

You can configure compositor specific settings such as outputs/displays the same as you would in niri or Hyprland.

Simply edit /etc/greetd/dms-niri.kdl or /etc/greetd/dms-hypr.conf to change compositor settings for the greeter

Personalization

Wallpapers and themes and weather and clock formats and things are a TODO on the documentation, but it's configured exactly the same as dms.

You can synchronize those configurations with a specific user if you want greeter settings to always mirror the shell.

# For core settings (theme, clock formats, etc)
sudo ln -sf ~/.config/DankMaterialShell/settings.json /etc/greetd/.dms/settings.json
# For state (mainly you would configure wallpaper in this file)
sudo ln -sf ~/.local/state/DankMaterialShell/session.json /etc/greetd/.dms/session.json
# For wallpaper based theming
sudo ln -sf ~/.cache/quickshell/dankshell/dms-colors.json /etc/greetd/.dms/dms-colors.json

You can override the configuration path with the DMS_GREET_CFG_DIR environment variable, the default is /etc/greetd/.dms

It should be writable by the greeter user.

3.0 KiB Raw Permalink Blame History