Skip to content

Ribbon Overlay

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

header image

Requirements & recommendations

Supported Overlay Level: Movie, Show

Supported ribbons

Ribbon Key Weight
Oscars Best Picture oscars 190
Oscars Best Director oscars_director 180
Golden Globe Winner golden 170
Golden Globe Director golden_director 160
BAFTA Winner bafta 150
Cannes Winner cannes 140
Berlinale Winner berlinale 130
Venice Winner venice 120
Sundance Winner sundance 110
Emmys Winner emmys 100
Critic's Choice Winner choice 90
Independent Spirit Award Winner spirit 80
César Winner cesar 70
IMDb Top 250 imdb 60
Letterboxd Top 500 letterboxd 50
Rotten Tomatoes Verified Hot rottenverified 45
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.

Example Template Variable Amendments (Click to Expand)

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

Click the icon to learn more

libraries:
  Movies:
    overlay_files:
      - default: ribbon
        template_variables:
          style: black #(1)!
          weight_IMDB: 200 #(2)!
          use_common: false #(3)!
  1. Changes the ribbon color to black
  2. Gives the imdb key the highest weight, meaning this ribbon image will always be chosen over other ribbons.
  3. Disables the "Common Sense Selection" overlay

  • 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
style Controls the color of the ribbon. Default: yellow
yellow, gray, black, red
use_all Used to turn on/off all keys. Default: true
true or false
weight_<<key>> Controls the weight of the Overlay. Higher numbers have priority. Any Number
  1. Each default collection has a key that you must replace <<key>> with when using this Template Variable. These keys are found in the table at the top of this page.

When something in this table is noted as expecting a number, typically that number is expressed in pixels, assuming an image 1000x1500 in size.

If the number is an offset, the value is relative to the corresponding alignment. Percentages are also relative to the alignment.

For example: 

libraries:
  Movies:
    overlay_files:
      - default: ribbon
        template_variables:
          horizontal_align: left
          horizontal_offset: 247
          vertical_align: bottom
          vertical_offset: 40%
That would place the ribbon overlay 247 pixels in from the left edge of the poster, and 40% of the way up from the bottom.

libraries:
  Movies:
    overlay_files:
      - default: ribbon
        template_variables:
          back_width: 198
          back_height: 47
That would set the ribbon overlay background to 198 pixels wide by 47 pixels high.

Color values should be wrapped in quotes in the YAML, as the # denotes a comment in YAML and if left unquoted will prevent the value from being seen by Kometa.

File paths need to be valid in the context where Kometa is running; this is primarily an issue when running in docker, as Kometa inside the container cannot see host paths.

Variable Description Values
back_align Controls the Alignment for the Text Overlay inside the backdrop. If back_align is not specified the Backdrop Centers the text. left, right, center, top, or bottom
back_color Controls the Backdrop Color for the Text Overlay. Color Hex Code in format #RGB, #RGBA, #RRGGBB or #RRGGBBAA
AA is transparency; 00 [transparent] to FF [opaque]
back_height Controls the Backdrop Height for the Text Overlay. If back_height is not specified the Backdrop Sizes to the text Any number greater than 0 [pixels assuming a 1000x1500 image]
back_line_color Controls the Backdrop Line Color for the Text Overlay. Color Hex Code in format #RGB, #RGBA, #RRGGBB or #RRGGBBAA``AA is transparency; 00 [transparent] to FF [opaque]
back_line_width Controls the Backdrop Line Width for the Text Overlay. Any number greater than 0 [pixels assuming a 1000x1500 image]
back_padding Controls the Backdrop Padding for the Text Overlay. Any number greater than 0 [pixels assuming a 1000x1500 image]
back_radius Controls the Backdrop Radius for the Text Overlay. Any number greater than 0 [pixels assuming a 1000x1500 image]
back_width Controls the Backdrop Width for the Text Overlay. If back_width is not specified the Backdrop Sizes to the text Any number greater than 0 [pixels assuming a 1000x1500 image]
file_<<key>> Controls the image associated with this key's Overlay to a local file. Filepath to Overlay Image
file Controls the images associated with all the Overlays to a local file. Filepath to Overlay Image
git_<<key>> Controls the image associated with this key's Overlay to the git repo. Git Path to Overlay Image
git Controls the images associated with all the Overlays to the git repo. Git Path to Overlay Image
horizontal_align Controls the Horizontal Alignment of the overlay. left, center, or right
horizontal_offset Controls the Horizontal Offset of this overlay. Can be a %. Number 0 or greater or 0%-100% [pixels assuming a 1000x1500 image]
repo_<<key>> Controls the image associated with this key's Overlay to a custom repo. Repo Path to Overlay Image
repo Controls the images associated with all the Overlays to a custom repo. Repo Path to Overlay Image
url_<<key>> Controls the image associated with this key's Overlay to a url. URL to Overlay Image
url Controls the images associated with all the Overlays to a url. URL to Overlay Image
use_<<key>> Turns off individual Overlays in a Defaults File. false to turn off the overlay
vertical_align Controls the Vertical Alignment of the overlay. top, center, or bottom
vertical_offset Controls the Vertical Offset of this overlay. Can be a %. Number 0 or greater or 0%-100% [pixels assuming a 1000x1500 image]

Default value source

This is a reference showing the source of the data used in this Defaults File.

Nothing in this section is required for using the Defaults File, but it can be useful for understanding where the data comes from.

Nothing in this section is directly useful for customizing this Defaults File.

Nothing here is a code example for end user use. It all looks like code, since it is taken directly from the Kometa source code to ensure it is up-to-date and accurate, but it is not intended for end user use, and is expressed in a different format to the way you would customize the defaults via Template Variables.

I want to customize this default

To learn how to customize any Defaults File using Template Variables see the Defaults Usage Guide.

Each Defaults File has its own set of Template Variables, which are used to control the behavior of that default. The Template Variables for this file can be found here.

I want to know what's behind the defaults

The lists provided here are for reference to show what values will be in use if no customization is done.

These do not show how to customize the defaults.

Nothing here is a code example for end user use. It all looks like code, since it is taken directly from the Kometa source code to ensure it is up-to-date and accurate, but it is not intended for end user use.

These lists are provided for reference only.

If you want to customize these collections, refer to the Defaults Usage Guide to learn how to use Template Variables.

The Ribbon overlays use the imdb_award Builder, imdb_chart Builder, mdblist_list Builder,