Skip to content

Latest commit

 

History

History
243 lines (206 loc) · 7.13 KB

README.md

File metadata and controls

243 lines (206 loc) · 7.13 KB
Raw
A cross-platform material you color generation tool

Description

Features

  • Generate/Export Material You Color Palette:
    • Generate a Material You color palette either from an image or a color
    • Output the generated palette as JSON to stdout, or use keywords inside templates that get exported as files
  • Keyword Filters:
    • Use filters to change values of the keywords, like changing lightness for colors and manipulating strings with replace, to_upper, to_lower and set_lightness
  • Custom Keywords/Colors:
    • Define your own custom keywords or colors you would like to be harmonized inside the config file, that you can then use in templates
  • Palette Customization:
    • Customize the contrast and scheme type for the palette
  • Restart Apps/Change Wallpaper:
    • Restart supported apps and set the wallpaper on Windows, MacOS, Linux and NetBSD

If you would like to learn more about the features and configuration, read the wiki here.

Other projects

  • Mitsugen - For gnome-shell, based on the old version of Matugen
  • pywal - More color generation backends, default theme files.
  • wpgtk - Like pywal, but with a gui and more features.

Supported platforms

  • Windows
  • Linux
  • MacOS
  • NetBSD

Installation

Cargo Cargo Version

Click to expand 
cargo install matugen

Arch AUR Version

Click to expand

Using your favourite AUR helper:

yay -S matugen-bin

NixOS nixpkgs NixOS Version

Click to expand

Add matugen to your flake inputs:

inputs = {
  matugen = {
    url = "github:/InioX/Matugen";
    # If you need a specific version:
    ref = "refs/tags/matugen-v0.10.0"
  };
  # ...
};

Then you can add it to your packages:

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

This flake also provides a NixOS/Home Manager module, which can be imported by adding this in your configuration:

{pkgs, inputs, ...}: {
  imports = [
    inputs.matugen.nixosModules.default
  ];

  # ...
}

The module does NOT automatically symlink the files. For an example of using this module with Home Manager, see #28

Option details can be found by reading the module. A search.nixos.org-like option viewer is planned.

NetBSD pkgsrc current package

Click to expand 
pkgin install matugen

or, if you prefer to build it from source

cd /usr/pkgsrc/graphics/matugen
make install

Themes

Templates

Acknowledgements