Theming

mdgreet features a powerful theming engine based on Material Design 3. It can generate full color palettes dynamically or use predefined themes.

All theme settings go under the [appearance.theme] block.

Mode

Themes can run in either light or dark mode.

[appearance.theme]
mode = "dark" # or "light"

Theme Types

The name property defines how the theme is generated.

1. Built-in Themes

Use standard, predefined color schemes. Available options are "default" and "slint".

[appearance.theme]
name = "default"

2. Auto (Material You)

Generates a theme dynamically by extracting the dominant colors from your current background image. This provides a deeply integrated, personalized look.

[appearance.theme]
name = "auto"

[appearance.background]
path = "/path/to/my/wallpaper.jpg"

3. Seed Color

If you want a specific brand color without relying on a wallpaper, use the "seed" theme and provide a HEX color.

[appearance.theme]
name = "seed"
seed_color = "#1e66f5"

4. Custom JSON

For total control over every Material Design color token, you can provide a custom JSON file.

[appearance.theme]
name = "custom"
path = "/etc/greetd/my-mdgreet-theme.json"

Note

The JSON file must follow the structure expected by mdgreet’s internal MaterialScheme struct.

Tip

Generating a Custom Theme: You can easily generate a compatible JSON file using the official Material Theme Builder. Simply design your theme there and export it as JSON.

Note: mdgreet fully supports the standard light and dark color schemes exported by the tool. High-contrast themes are not currently supported by the underlying library and will be safely ignored if present in the JSON file.