Skip to content

Home

Jump to bottom
ini edited this page Mar 31, 2025 · 13 revisions


Contents

  • Configuration - Shows information about configuration and creating templates
  • Configuration before 1.0.0 - Same as Configuration but for the old version.
  • Filters - Shows usage and examples of using filters in templates
  • Usage - Shows usage in the CLI
  • Templates Extra - Additional advanced syntax for templates
  • Features - Shows how to compile Matugen with features, and which features there are.

Basics

The best way to get started is to look at the official template theme repo

Running matugen image <image_path> will "compile" all the templates configured in the [templates] section of $HOME/.config/matugen/config.toml. You can do this to get started (assuming you use swww and it's in matugen's $PATH)

1. Write the following to that config.toml file

[config.wallpaper]
command = "swww"
arguments = ["img", "--transition-type", "center"]
set = true


[templates.waybar]
input_path = './templates/colors.css'
output_path = '~/.config/waybar/colors.css'
post_hook = 'pkill -SIGUSR2 waybar'

2. Copy colors.css to $HOME/.config/matugen/templates/colors.css

3. Add this line to the top of your ~/.config/waybar/style.css file

@import "colors.css";

4. Run matugen image <whatever_wallpaper_you_want>

Clone this wiki locally