3.2 KiB

Raw Blame History

Studio Overlay

The studio Default Overlay File is used to create an overlay based on the show studio on each item within your library.

Requirements & Recommendations

Supported library types: Movie / Show

Bigger Style

Below is a screenshot of the alternative White (bigger) style which can be set via the style template variable.

Config

The below YAML in your config.yml will create the overlays:

libraries:
  Movies:
    overlay_files:
      - default: studio
  TV Shows:
    overlay_files:
      - default: studio

Template Variables

Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.

Note that the template_variables: section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.

??? abstract "Variable Lists (click to expand)"

* **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file.

* **Overlay Template Variables** are additional variables shared across the Kometa Overlay Defaults.

??? example "Default Template Variable Values (click to expand)"

    | Variable            | Default     |
    |:--------------------|:------------|
    | `horizontal_offset` | `15`        |
    | `horizontal_align`  | `left`      |
    | `vertical_offset`   | `150`       |
    | `vertical_align`    | `bottom`    |
    | `back_color`        | `#00000099` |
    | `back_radius`       | `30`        |
    | `back_width`        | `305`       |
    | `back_height`       | `105`       |
    
=== "File-Specific Template Variables"

    | Variable        | Description & Values                                                                             |
    |:----------------|:-------------------------------------------------------------------------------------------------|
    | `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode`                  |
    | `style`         | **Description:** Choose between the standard size or the **bigger** one.<br>**Values:** `bigger` |

=== "Overlay Template Variables"

    {%
       include-markdown "../overlay_variables.md"
    %}

???+ example "Example Template Variable Amendments"

The below is an example config.yml extract with some Template Variables added in to change how the file works.

```yaml
libraries:
  Movies:
    overlay_files:
      - default: studio
        template_variables:
          vertical_offset: 390
  TV Shows:
    overlay_files:
      - default: studio
      - default: studio
        template_variables:
          builder_level: season
          vertical_align: bottom
          vertical_offset: 15
          horizontal_align: left
          horizontal_offset: 15
          style: bigger
      - default: studio
        template_variables:
          builder_level: episode
          vertical_align: top
          vertical_offset: 15
```

3.2 KiB Raw Blame History