Ratings Overlay¶

The ratings Default Overlay File is used to an overlay based on the Critic Rating, Audience Rating, and User Rating in Plex for each item within your library.

This file only updates the overlays based on the data in Plex, it will not pull the ratings directly from any third-party website, see recommendations below for more info.

Please read Kometa Ratings Explained for more understanding on how Kometa interacts with ratings.

Requirements & Recommendations¶

Supported Overlay Level: Movie, Show, Episode

Requirements: Template Variables must be configured, otherwise this file will not apply any overlays.

Recommendations: Use the Mass * Rating Update Library Operation and the Mass Episode * Rating Update Library Operation to update Plex to the Ratings you want on the Overlay.

Config¶

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

libraries:
  Movies:
    overlay_files:
      - default: network
        template_variables:
          rating1: critic
          rating2: audience
          rating3: user
          rating1_image: imdb
          rating2_image: rt_popcorn
          rating3_image: tmdb
    operations:
      mass_critic_rating_update: imdb
      mass_audience_rating_update: mdb_tomatoesaudience
      mass_user_rating_update: tmdb
  TV Shows:
    overlay_files:
      - default: network
        template_variables:
          rating1: critic
          rating2: audience
          rating3: user
          rating1_image: imdb
          rating2_image: rt_popcorn
          rating3_image: tmdb
      - default: network
        template_variables:
          builder_level: episode
          rating1: critic
          rating2: audience
          rating1_image: imdb
          rating2_image: tmdb
    operations:
      mass_critic_rating_update: imdb
      mass_audience_rating_update: mdb_tomatoesaudience
      mass_user_rating_update: tmdb
      mass_episode_critic_rating_update: imdb
      mass_episode_audience_rating_update: tmdb

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 href="#__codelineno-1-1"> Movies: overlay_files: - default: ratings template_variables: rating1: critic #(1)! rating1_image: imdb #(2)! rating2: audience #(3)! rating2_image: rt_popcorn #(4)! rating3: user #(5)! rating3_image: tmdb #(6)! horizontal_position: right #(7)! operations: #(8)! mass_critic_rating_update: imdb mass_audience_rating_update: mdb_tomatoesaudience mass_user_rating_update: tmdb TV Shows: overlay_files: - default: ratings template_variables: rating1: critic #(1)! rating1_image: imdb #(2)! rating2: audience #(3)! rating2_image: rt_popcorn #(4)! rating3: user #(5)! rating3_image: tmdb #(6)! horizontal_position: right #(7)! - default: ratings template_variables: builder_level: episode rating1: critic #(1)! rating1_image: imdb #(2)! rating2: audience #(3)! rating2_image: tmdb #(9)! horizontal_position: right #(7)! operations: #(8)! mass_critic_rating_update: imdb mass_audience_rating_update: mdb_tomatoesaudience mass_user_rating_update: tmdb mass_episode_critic_rating_update: imdb mass_episode_audience_rating_update: tmdb

In the first slot on the overlay, insert the value of the critic rating
In the first slot on the overlay, use the imdb image
In the second slot on the overlay, insert the value of the audience rating
In the second slot on the overlay, use the rt_popcorn image
In the third slot on the overlay, insert the value of the user rating
In the third slot on the overlay, use the tmdb image
Place the rating value to the right of the image
Operations are used to force ratings from third-party services into the Plex ratings slots.
In the second slot on the overlay, use the tmdb image

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.
Overlay Text Template Variables are additional variables shared across the Kometa Text Overlay Defaults.

Default Template Variable Values (click to expand)

Variable	Default
`horizontal_offset`	`30`
`horizontal_align`	`left`
`vertical_offset`	`0`
`vertical_align`	`center`
`back_color`	`#00000099`
`back_radius`	`30`
`back_width`	`160`
`back_height`	`160`
`back_padding`	`15`
`back_radius`	`30`

File-Specific Template VariablesOverlay Template VariablesOverlay Text Template Variables

Variable	Description & Values
`fresh_rating`	Description: Determines when ratings are considered Fresh Default: 6.0 Values: Any Number
`horizontal_position`	Description: Choose the horizontal position for the rating group. Default: `top` Values: `left`, `right`, or `center`
`vertical_position`	Description: Choose the vertical position for the rating group. Default: `center` Values: `top`, `bottom`, or `center`
`maximum_rating`	Description: Maximum Rating to display Default: 10.0 Values: Any Number
`minimum_rating`	Description: Minimum Rating to display Default: 0.0 Values: Any Number
`rating1`	Description: Choose the rating to display in rating1. Values: `critic`, `audience`, or `user`
`rating_alignment`	Description: Choose the display alignment for the rating group. Default: `vertical` Values: `horizontal`, or `vertical`
`rating1_addon_offset`	Description: Text Addon Image Offset from the text. Default: `15` Values: Any number greater than 0
`rating1_addon_position`	Description: Text Addon Image Alignment in relation to the text. Default: `top` Values: `left`, `right`, `top`, `bottom`
`rating1_extra`	Description: Extra text after rating1. Default: `%` for `rt_popcorn`, `rt_tomato`, `tmdb`. Values: Any Value
`rating1_image`	Description: Choose the rating image to display in rating1. Values: `anidb`, `imdb`, `letterboxd`, `tmdb`, `metacritic`, `rt_popcorn`, `rt_tomato`, `trakt`, `mal`, `mdb`, or `star`
`rating1_style`	Description: Choose the rating number style for rating1. Please refer to the detailed style guide.
`rating2`	Description: Choose the rating to display in rating2. Values: `critic`, `audience`, or `user`
`rating2_addon_offset`	Description: Text Addon Image Offset from the text. Default: `15` Values: Any number greater than 0
`rating2_addon_position`	Description: Text Addon Image Alignment in relation to the text. Default: `top` Values: `left`, `right`, `top`, `bottom`
`rating2_extra`	Description: Extra text after rating2. Default: `%` for `rt_popcorn`, `rt_tomato`, `tmdb`. Values: Any Value
`rating2_image`	Description: Choose the rating image to display in rating2. Values: `anidb`, `imdb`, `letterboxd`, `tmdb`, `metacritic`, `rt_popcorn`, `rt_tomato`, `trakt`, `mal`, `mdb`, or `star`
`rating2_style`	Description: Choose the rating number style for rating2. Please refer to the detailed style guide.
`rating3`	Description: Choose the rating to display in rating3. Values: `critic`, `audience`, or `user`
`rating3_addon_offset`	Description: Text Addon Image Offset from the text. Default: `15` Values: Any number greater than 0
`rating3_addon_position`	Description: Text Addon Image Alignment in relation to the text. Default: `top` Values: `left`, `right`, `top`, `bottom`
`rating3_extra`	Description: Extra text after rating3. Default: `%` for `rt_popcorn`, `rt_tomato`, `tmdb`. Values: Any Value
`rating3_image`	Description: Choose the rating image to display in rating3. Values: `anidb`, `imdb`, `letterboxd`, `tmdb`, `metacritic`, `rt_popcorn`, `rt_tomato`, `trakt`, `mal`, `mdb`, or `star`
`rating3_style`	Description: Choose the rating number style for rating3. Please refer to the detailed style guide.
`addon_offset`	Description: Text Addon Image Offset from the text. Default: `15` Values: Any number greater than 0
`addon_position`	Description: Text Addon Image Alignment in relation to the text. Default: `top` Values: `left`, `right`, `top`, `bottom`
`builder_level`	Description: Choose the Overlay Level. Values: `episode`

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.

These variables can be prepended with rating1_, rating2_, or rating3_ to change that attribute on each rating individually.

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.

libraries:
  Movies:
    overlay_files:
      - default: resolution
        template_variables:
          horizontal_align: left
          horizontal_offset: 247
          vertical_align: bottom
          vertical_offset: 40%

libraries:
  Movies:
    overlay_files:
      - default: resolution
        template_variables:
          back_width: 198
          back_height: 47

For example: That would place the resolution overlay 247 pixels in from the left edge of the poster, and 40% of the way up from the bottom.

That would set the resolution 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.

IMPORTANT: To amend horizontal_offset and vertical_offset you must prepend the variable with rating1_, rating2_, or rating3_.

Variable	Description & Values
`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_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_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 [pixels assuming a 1000x1500 image]
`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 [pixels assuming a 1000x1500 image]
`back_padding`	Description: Controls the Backdrop Padding for the Text Overlay. Values: Any number greater than 0 [pixels assuming a 1000x1500 image]
`back_radius`	Description: Controls the Backdrop Radius for the Text Overlay. Values: Any number greater than 0 [pixels assuming a 1000x1500 image]
`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 [pixels assuming a 1000x1500 image]
`file_<<key>>`¹	Description: Controls the image associated with this key's Overlay to a local file. Values: Filepath to Overlay Image
`file`	Description: Controls the images associated with all the Overlays to a local file. Values: Filepath to Overlay Image
`git_<<key>>`¹	Description: Controls the image associated with this key's Overlay to the git repo. Values: Git Path to Overlay Image
`git`	Description: Controls the images associated with all the Overlays to the git repo. Values: Git Path to Overlay Image
`horizontal_align`	Description: Controls the Horizontal Alignment of the overlay. Values: `left`, `center`, or `right`
`horizontal_offset`	Description: Controls the Horizontal Offset of this overlay. Can be a %. Values: Number 0 or greater or 0%-100% [pixels assuming a 1000x1500 image]
`repo_<<key>>`¹	Description: Controls the image associated with this key's Overlay to a custom repo. Values: Repo Path to Overlay Image
`repo`	Description: Controls the images associated with all the Overlays to a custom repo. Values: Repo Path to Overlay Image
`url_<<key>>`¹	Description: Controls the image associated with this key's Overlay to a url. Values: URL to Overlay Image
`url`	Description: Controls the images associated with all the Overlays to a url. Values: URL to Overlay Image
`use_<<key>>`¹	Description: Turns off individual Overlays in a Defaults File. Values: `false` to turn off the overlay
`vertical_align`	Description: Controls the Vertical Alignment of the overlay. Values: `top`, `center`, or `bottom`
`vertical_offset`	Description: Controls the Vertical Offset of this overlay. Can be a %. Values: Number 0 or greater or 0%-100% [pixels assuming a 1000x1500 image]

Each default overlay has a key that when calling to effect a specific collection you must replace <<key>> with when calling.

These variables can be prepended with rating1_, rating2_, or rating3_ to change that attribute on each rating individually.

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

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
`font_<<key>>`	Description: Choose the font for this key's Overlay. Default: `fonts/Inter-Medium.ttf` Values: Path to font file
`font_color_<<key>>`	Description: Choose the font color for this key's Overlay. Default: `#FFFFFF` Values: Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA`
`font_color`	Description: Choose the font color for the Overlay. Default: `#FFFFFF` Values: Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA`
`font_size_<<key>>`	Description: Choose the font size for this key's Overlay. Default: `55` Values: Any number greater than 0 [pixels assuming a 1000x1500 image]
`font_size`	Description: Choose the font size for the Overlay. Default: `55` Values: Any number greater than 0 [pixels assuming a 1000x1500 image]
`font_style_<<key>>`	Description: Font style for this key's Variable Fonts. Values: Variable Font Style
`font_style`	Description: Font style for Variable Fonts. Values: Variable Font Style
`font`	Description: Choose the font for the Overlay. Default: `fonts/Inter-Medium.ttf` Values: Path to font file
`stroke_color_<<key>>`	Description: Font Stroke Color for this key's Overlay. Values: Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA`
`stroke_color`	Description: Font Stroke Color for the Overlay. Values: Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA`
`stroke_width_<<key>>`	Description: Font Stroke Width for this key's Overlay. Values: Any number greater than 0 [pixels assuming a 1000x1500 image]
`stroke_width`	Description: Font Stroke Width for the Overlay. Values: Any number greater than 0 [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.

Ratings Overlays

The Ratings overlays use the plex_search Builder on ratings as set on items in Plex.