matugen 0.9.0

Description

Matugen is a cross-platform tool that generates a colorscheme either from an image or a color, and exports it to a file from a template. It can also set the wallpaper if one was provided.

About Material Design 3

Material Design 3 offers a new color system that allows for more flexible and dynamic use of color. The new system includes a wider range of colors, as well as a range of tints and shades that can be used to create subtle variations in color.

Other projects

• Mitsugen - For gnome-shell, based on the old and deprecated python version of Matugen

Supported platforms

• Windows
• Linux
• MacOS
• NetBSD

Warning Matugen only supports setting the wallpaper and restarting apps on Linux and NetBSD for now.

Roadmap

• Add GTK4 UI
• Add a light/dark option for each template
• Support more color formats for generating colorscheme
  • Rgba
  • Rgb
  • Hsl
• Suport changing the wallpaper on different platforms
  • MacOS
  • Windows
• Support changing the wallpaper on X11
  • Feh
  • Nitrogen

Note Want a feature that is not listed above? Simply open an issue.

Installation

Cargo

cargo install matugen

NixOS

Add matugen to your flake inputs:

inputs = {
  matugen = {
    url = "github:/InioX/Matugen";
  };
  # ...
};

Then you can add it to your packages:

let
  system = "x86_64-linux";
in {
  environment.systemPackages = with pkgs; [    
    # ...
    inputs.matugen.packages.${system}.default
  ];
}

NetBSD

pkgin install matugen

or, if you prefer to build it from source

cd /usr/pkgsrc/graphics/matugen
make install

Usage

Note For some reason the output of the colors is a bit weird in the gifs, here is how the output actually looks:

Help

matugen -h
matugen --help

Verbose mode

matugen -v <other-arguments>

Generate from an image

# Dark mode
matugen image /path/to/wallpaper/
# Light mode
matugen image /path/to/wallpaper/ -l
# AMOLED/"pure dark" mode
matugen image /path/to/wallpaper/ -a

Example:

matugen image ~/wall/snow.png -l

Generate from a color

# Dark mode
matugen color hsl <hsl color> -l
# Light mode
matugen color hex <hex color> -l
# AMOLED/"pure dark" mode
matugen color rgb <rgb color> -a

Example:

matugen color hex "#ffbf9b"
matugen color rgb "rgb(63, 106, 171)" -l
matugen color hsl "hsl(216.34, 45.75%, 45.88%)" -a

Creating templates

The basic syntax for using colors is prefix + {color} (The default prefix is @, so the usage would be @{color}).

Keywords

@define-color primary @{primary}; /* Result: #ffb783 */
@define-color primary @{primary.hex}; /* Result: #ffb783 */
@define-color primary @{primary.rgb}; /* Result: rgb(255, 183, 131) */
@define-color primary @{primary.rgba}; /* Result: rgba(255, 183, 131, 255) */
@define-color primary @{primary.strip}; /* Result: ffb783 */

You can also get the image (if it was provided) by using:

@import url("@{image}"); /* Result: /home/ini/Downloads/wallpaper.jpg */

Note If no image was provided, Matugen will just skip over the image keyword

Example of all the color keywords:

/*colors.css*/
@define-color primary @{primary.rgb};
@define-color onPrimary @{on_primary.rgb};
@define-color primaryContainer @{primary_container.strip};
@define-color onPrimaryContainer @{on_primary_container};
@define-color secondary @{secondary};
@define-color onSecondary @{on_secondary.strip};
@define-color secondaryContainer @{secondary_container.rgba};
@define-color onSecondaryContainer @{on_secondary_container};
@define-color tertiary @{tertiary};
@define-color onTertiary @{on_tertiary};
@define-color tertiaryContainer @{tertiary_container};
@define-color onTertiaryContainer @{on_tertiary_container.strip};
@define-color error @{error};
@define-color onError @{on_error.rgba};
@define-color errorContainer @{error_container.rgba};
@define-color onErrorContainer @{on_error_container};
@define-color background @{background};
@define-color onBackground @{on_background.strip};
@define-color surface @{surface};
@define-color onSurface @{on_surface};
@define-color surfaceVariant @{surface_variant};
@define-color onSurfaceVariant @{on_surface_variant};
@define-color outline @{outline.rgba};
@define-color shadow @{shadow};
@define-color inverseSurface @{inverse_surface.strip};
@define-color inverseOnSurface @{inverse_on_surface};
@define-color inversePrimary @{inverse_primary.strip};

Configuration

Here is a list of different locations for the configuration file:

• Windows: C:\Users\user\AppData\Roaming\InioX\matugen\config\config.toml
• Linux: /home/user/.config/matugen/config.toml
• MacOS: /Users/user/Library/Application Support/com.InioX.matugen/config.toml

Note You can also use a custom configuration path by using the -c argument

Configuration items

Name	Type	Default	Description
reload_apps	bool	false	Whether to reload apps.
set_wallpaper	bool	false	Whether to set the wallpaper (if true, requires wallpaper_tool to be set).
wallpaper_tool	String	None	The wallpaper tool to use (Swwww, Swaybg, Feh, Nitrogen).
prefix	String	"@"	The prefix to use (for example: @{primary})
reload_gtk_theme	bool	false	Whether to reload the gtk theme. REMOVED, USE gtk_theme in config.reload_apps_list.
run_after	Vec	[]	The commands to run after the templates have been generated.
swww_options	<Vec>	[]	The options to use for Swwww
feh_options	<Vec>	[]	The options to use for Feh

Apps

Name	Type	Default	Description
kitty	bool	true	Whether to reload kitty.
waybar	bool	true	Whether to reload waybar.
dunst	bool	true	Whether to reload dunst.
gtk_theme	bool	true	Whether to reload the GTK theme.

Example configuration

# config_directory/config.toml
[config]
reload_apps = true
set_wallpaper = true
wallpaper_tool = 'Swww'
prefix = '@'
swww_options = [
    "--transition-type",
    "center",
]
run_after = [
    [ "echo", "'hello'" ],
    [ "echo", "'hello again'" ],
]

[config.reload_apps_list]
waybar = true
kitty = true
gtk_theme = true
dunst = true

Adding templates

# config_directory/config.toml

[templates.test] # First way of adding template
input_path = '~/.config/example/template.css'
output_path = '~/.config/example'

[templates] # Another way
test2 = { input_path = '~/.config/example/template2.css', output_path = '~/.config/example2' }

Acknowledgment

• material-color-utilities-rs