Skip to content

Maintainerr - Overlays - Templates

Configuration options for maintainerr overlays templates.

Available Options

This page documents 8 configuration options.

nixflix.maintainerr.overlays.templates

Overlay templates to declaratively manage in Maintainerr. Templates present in Maintainerr but not listed here will be deleted, unless they are built-in presets (isPreset = true in the API), which are never modified or removed.

Typelist of (submodule)
Default
[ ]
Declared inmodules/maintainerr/overlays/templates/options.nix

nixflix.maintainerr.overlays.templates.*.canvasHeight

Canvas height in pixels. Typically 1500 for poster, 1080 for titlecard.

Typesigned integer
Example
1500
Declared inmodules/maintainerr/overlays/templates/options.nix

nixflix.maintainerr.overlays.templates.*.canvasWidth

Canvas width in pixels. Typically 1000 for poster, 1920 for titlecard.

Typesigned integer
Example
1000
Declared inmodules/maintainerr/overlays/templates/options.nix

nixflix.maintainerr.overlays.templates.*.description

Human-readable description of what the template displays.

Typestring
Default
""
Declared inmodules/maintainerr/overlays/templates/options.nix

nixflix.maintainerr.overlays.templates.*.elements

Canvas elements (shapes and variables) making up the overlay. Each element is a free-form attribute set matching the Maintainerr element schema. Elements may be of type "shape" (shapeType, fillColor, etc.) or "variable" (segments, fontFamily, fontSize, etc.).

Typelist of anything
Default
[ ]
Example
[
  {
    id = "pill-bg";
    type = "shape";
    x = 30; y = 60; width = 400; height = 70;
    rotation = 0; layerOrder = 0; opacity = 1; visible = true;
    shapeType = "rectangle";
    fillColor = "#B20710"; strokeColor = null; strokeWidth = 0; cornerRadius = 35;
  }
]
Declared inmodules/maintainerr/overlays/templates/options.nix

nixflix.maintainerr.overlays.templates.*.isDefault

Set this template as the default for its mode (poster or titlecard). Only one template per mode may be the default; if multiple templates in the same mode declare isDefault = true, the last one processed wins.

Typeboolean
Default
false
Declared inmodules/maintainerr/overlays/templates/options.nix

nixflix.maintainerr.overlays.templates.*.mode

Whether this template is for poster images or title card images.

Typeone of "poster", "titlecard"
Declared inmodules/maintainerr/overlays/templates/options.nix

nixflix.maintainerr.overlays.templates.*.name

Template name. Used as the unique identifier for create/update/delete.

Typestring
Example
"My Custom Pill"
Declared inmodules/maintainerr/overlays/templates/options.nix