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.
| Type | list of (submodule) |
| Default | |
| Declared in | modules/maintainerr/overlays/templates/options.nix |
nixflix.maintainerr.overlays.templates.*.canvasHeight¶
Canvas height in pixels. Typically 1500 for poster, 1080 for titlecard.
| Type | signed integer |
| Example | |
| Declared in | modules/maintainerr/overlays/templates/options.nix |
nixflix.maintainerr.overlays.templates.*.canvasWidth¶
Canvas width in pixels. Typically 1000 for poster, 1920 for titlecard.
| Type | signed integer |
| Example | |
| Declared in | modules/maintainerr/overlays/templates/options.nix |
nixflix.maintainerr.overlays.templates.*.description¶
Human-readable description of what the template displays.
| Type | string |
| Default | |
| Declared in | modules/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.).
| Type | list of anything |
| Default | |
| Example | |
| Declared in | modules/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.
| Type | boolean |
| Default | |
| Declared in | modules/maintainerr/overlays/templates/options.nix |
nixflix.maintainerr.overlays.templates.*.mode¶
Whether this template is for poster images or title card images.
| Type | one of "poster", "titlecard" |
| Declared in | modules/maintainerr/overlays/templates/options.nix |
nixflix.maintainerr.overlays.templates.*.name¶
Template name. Used as the unique identifier for create/update/delete.
| Type | string |
| Example | |
| Declared in | modules/maintainerr/overlays/templates/options.nix |