🍙 PimpMyRice

Theme

A theme is composed of:

and is configured through a PIMP_CONFIG_DIR/themes/THEME_NAME/theme.json file.

theme.json
{
    "wallpaper": {
        "path": "example.png"
    },
    "modes": {
        "dark": {
            "palette": {
                "term": {
                    "color0": "#e5d4ce",
                    "color1": "#407f39",
                    "color2": "#397f66",
                    ...
            },
            "wallpaper": {
                ...
            },
            "style": {
                ...
            }
        },
        "light": {
            ...
        }
    },
    "style": {
        "bar": {
            "bg": "transparent"
        },
        "blur": {
            "enabled": false
        },
        ...
    },
    "tags": [
        "chill",
        "dim"
    ],
    "$schema": "../../.json_schemas/theme.json"
}

Wallpaper

    "wallpaper": {
        "path": "example.png"
        "mode": "fit" # optional, defaults to 'fill'
    },

Mode

A Mode is composed of:

  • Palette
  • Wallpaper (optional)
  • Style (optional)

Here's an example:

theme.json
    "modes": {
        "dark": {
            "wallpaper": "dark_wp.jpg"
            "style": {
                "opacity": {
                    "terminal": 0.93
                }
            },
            "palette": {
                ...
            }
        }
        ...

palette can be a global palette, using from_global:

    "palette": {
        "from_global": "catppuccin_dark"
    },

Style

style can inherit from a global style, using from_global:

    "style": {
        "from_global": "flat",
        "bar": {
            "bg": "transparent"
        },
        ...

Tags

Tags are utilized to categorize and filter themes, for example using pimp random.

    "tags": [
        "chill",
        "dim"
    ]

On this page