Skip to content

Ribbon Overlays

The ribbon Default Overlay File is used to create a ribbon overlay based on the Top Lists of various sites on each item within your library.

Requirements & Recommendations

Supported Overlay Level: Movie, Show

Supported Ribbon

Ribbon Key Weight
Oscars Best Picture oscars 180
Oscars Best Director oscars_director 170
Golden Globe Winner golden 160
Golden Globe Director golden_director 150
BAFTA Winner bafta 140
Cannes Winner cannes 130
Berlinale Winner berlinale 120
Venice Winner venice 110
Sundance Winner sundance 100
Emmys Winner emmys 90
Critic's Choice Winner choice 80
Independent Spirit Award Winner spirit 70
César Winner cesar 60
IMDb Top 250 imdb 50
Rotten Tomatoes Certified Fresh rotten 40
Metacritic Must See metacritic 30
Common Sense Selection common 20
Razzies Winner razzie 10

Config

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

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

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.

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.

Default Template Variable Values (click to expand)
Variable Default
horizontal_offset 0
horizontal_align right
vertical_offset 0
vertical_align bottom
Variable Description & Values
use_all Description: Used to turn on/off all keys.
Default: true
Values: true or false
weight_<<key>>1 Description: Controls the weight of the Overlay. Higher numbers have priority.
Values: Any Number
style Description: Controls the color of the ribbon.
Default: yellow
Values: yellow, gray, black, red
  1. Each default overlay has a key that when calling to effect a specific overlay you must replace <<key>> with when calling.
Variable Description & Values
use_<<key>>1 Description: Turns off individual Overlays in a Defaults file.
Values: false to turn off the overlay
file Description: Controls the images associated with all the Overlays to a local file.
Values: Filepath to Overlay Image
file_<<key>>1 Description: Controls the image associated with this key's Overlay to a local file.
Values: Filepath to Overlay Image
url Description: Controls the images associated with all the Overlays to a url.
Values: URL to Overlay Image
url_<<key>>1 Description: Controls the image associated with this key's Overlay to a url.
Values: URL to Overlay Image
git Description: Controls the images associated with all the Overlays to the git repo.
Values: Git Path to Overlay Image
git_<<key>>1 Description: Controls the image associated with this key's Overlay to the git repo.
Values: Git Path to Overlay Image
repo Description: Controls the images associated with all the Overlays to a custom repo.
Values: Repo Path to Overlay Image
repo_<<key>>1 Description: Controls the image associated with this key's Overlay to a custom repo.
Values: Repo Path to Overlay Image
horizontal_offset Description: Controls the Horizontal Offset of this overlay. Can be a %.
Values: Number 0 or greater or 0%-100%
horizontal_align Description: Controls the Horizontal Alignment of the overlay.
Values: left, center, or right
vertical_offset Description: Controls the Vertical Offset of this overlay. Can be a %.
Values: Number 0 or greater or 0%-100%
vertical_align Description: Controls the Vertical Alignment of the overlay.
Values: top, center, or bottom
back_color Description: Controls the Backdrop Color for the Text Overlay.
Values: Color Hex Code in format #RGB, #RGBA, #RRGGBB or #RRGGBBAA
AA is transparency; 00 [transparent] to FF [opaque]
back_width Description: Controls the Backdrop Width for the Text Overlay. If back_width is not specified the Backdrop Sizes to the text
Values: Any number greater than 0
back_height Description: Controls the Backdrop Height for the Text Overlay. If back_height is not specified the Backdrop Sizes to the text
Values: Any number greater than 0
back_align Description: Controls the Alignment for the Text Overlay inside the backdrop. If back_align is not specified the Backdrop Centers the text.
Values: left, right, center, top, or bottom
back_padding Description: Controls the Backdrop Padding for the Text Overlay.
Values: Any number greater than 0
back_radius Description: Controls the Backdrop Radius for the Text Overlay.
Values: Any number greater than 0
back_line_color Description: Controls the Backdrop Line Color for the Text Overlay.
Values: Color Hex Code in format #RGB, #RGBA, #RRGGBB or #RRGGBBAA``AA is transparency; 00 [transparent] to FF [opaque]
back_line_width Description: Controls the Backdrop Line Width for the Text Overlay.
Values: Any number greater than 0
  1. Each default overlay has a key that when calling to effect a specific collection you must replace <<key>> with when calling.
Example Template Variable Amendments

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

libraries:
  Movies:
    overlay_files:
      - default: ribbon
        template_variables:
          style: black
          weight_metacritic: 35
          use_common: false