Ratings Overlays¶
The ratings
Default Overlay File is used to create 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 overlays:
Movies:
overlay_files:
- default: ratings
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: ratings
template_variables:
rating1: critic
rating2: audience
rating3: user
rating1_image: imdb
rating2_image: rt_popcorn
rating3_image: tmdb
- default: ratings
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.
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.
-
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 |
These can be prependd with rating1_
, rating2_
, or rating3_
to change that attribute on each rating
individually.
Warning
To amend horizontal_offset
and vertical_offset
you must prepend the variable with rating1_
,
rating2_
, or rating3_
Variable | Description & Values | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
rating1 |
Description: Choose the rating to display in rating1. Values: critic , audience , or user |
||||||||||||
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. Values:
|
||||||||||||
rating1_extra |
Description: Extra text after rating1. Default: % for rt_popcorn , rt_tomato , tmdb . Values: Any Value |
||||||||||||
rating2 |
Description: Choose the rating to display in rating2. Values: critic , audience , or user |
||||||||||||
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. Values:
|
||||||||||||
rating2_extra |
Description: Extra text after rating2. Default: % for rt_popcorn , rt_tomato , tmdb . Values: Any Value |
||||||||||||
rating3 |
Description: Choose the rating to display in rating3. Values: critic , audience , or user |
||||||||||||
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. Values:
|
||||||||||||
rating3_extra |
Description: Extra text after rating3. Default: % for rt_popcorn , rt_tomato , tmdb . Values: Any Value |
||||||||||||
horizontal_position |
Description: Choose the horizontal position for the rating group. Default: left Values: left , right , or center |
||||||||||||
vertical_position |
Description: Choose the vertical position for the rating group. Default: center Values: top , bottom , or center |
||||||||||||
rating_alignment |
Description: Choose the display alignment for the rating group. Default: vertical Values: horizontal , or vertical |
||||||||||||
minimum_rating |
Description: Minimum Rating to display Default: 0.0 Values: Any Number |
||||||||||||
fresh_rating |
Description: Determines when ratings are considered Fresh Default: 6.0 Values: Any Number |
||||||||||||
maximum_rating |
Description: Maximum Rating to display Default: 10.0 Values: Any Number |
||||||||||||
addon_offset |
Description: Text Addon Image Offset from the text. Default: 15 Values: Any number greater than 0 |
||||||||||||
rating1_addon_offset |
Description: Text Addon Image Offset from the text. Default: 15 Values: Any number greater than 0 |
||||||||||||
rating2_addon_offset |
Description: Text Addon Image Offset from the text. Default: 15 Values: Any number greater than 0 |
||||||||||||
rating3_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 |
||||||||||||
rating1_addon_position |
Description: Text Addon Image Alignment in relation to the text. Default: top Values: left , right , top , bottom |
||||||||||||
rating2_addon_position |
Description: Text Addon Image Alignment in relation to the text. Default: top Values: left , right , top , bottom |
||||||||||||
rating3_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 |
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, 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: 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
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 |
---|---|
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% [pixels assuming a 1000x1500 image] |
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% [pixels assuming a 1000x1500 image] |
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 textValues: Any number greater than 0 [pixels assuming a 1000x1500 image] |
back_height |
Description: Controls the Backdrop Height for the Text Overlay. If back_height is not specified the Backdrop Sizes to the textValues: Any number greater than 0 [pixels assuming a 1000x1500 image] |
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 [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_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] |
- 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 |
Description: Choose the font for the Overlay. Default: fonts/Inter-Medium.ttf Values: Path to font file |
font_style |
Description: Font style for Variable Fonts. Values: Variable Font Style |
font_size |
Description: Choose the font size for the Overlay. Default: 55 Values: Any number greater than 0 [pixels assuming a 1000x1500 image] |
font_color |
Description: Choose the font color for the Overlay. Default: #FFFFFF Values: Color Hex Code in format #RGB , #RGBA , #RRGGBB or #RRGGBBAA |
stroke_width |
Description: Font Stroke Width for the Overlay. Values: Any number greater than 0 [pixels assuming a 1000x1500 image] |
stroke_color |
Description: Font Stroke Color for the Overlay. Values: Color Hex Code in format #RGB , #RGBA , #RRGGBB or #RRGGBBAA |
font_<<key>> |
Description: Choose the font for this key's Overlay. Default: fonts/Inter-Medium.ttf Values: Path to font file |
font_style_<<key>> |
Description: Font style for this key's Variable Fonts. Values: Variable Font Style |
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_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 |
stroke_width_<<key>> |
Description: Font Stroke Width for this key's Overlay. Values: Any number greater than 0 [pixels assuming a 1000x1500 image] |
stroke_color_<<key>> |
Description: Font Stroke Color for this key's Overlay. Values: Color Hex Code in format #RGB , #RGBA , #RRGGBB or #RRGGBBAA |
Example Template Variable Amendments
The below is an example config.yml extract with some Template Variables added in to change how the file works.
Warning
This example uses fonts not packaged with Kometa. See bullmoose20's Configs
Movies:
overlay_files:
- default: ratings
template_variables:
rating1: critic
rating1_image: imdb
rating1_font: config/metadata/fonts/Impact.ttf
rating1_font_size: 70
rating2: audience
rating2_image: rt_popcorn
rating2_font: config/metadata/fonts/Adlib.ttf
rating2_font_size: 63
rating3: user
rating3_image: tmdb
rating3_font: config/metadata/fonts/Avenir_95_Black.ttf
rating3_font_size: 70
horizontal_position: right
operations:
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
rating1_image: imdb
rating1_font: config/metadata/fonts/Impact.ttf
rating1_font_size: 70
rating2: audience
rating2_image: rt_popcorn
rating2_font: config/metadata/fonts/Adlib.ttf
rating2_font_size: 63
rating3: user
rating3_image: tmdb
rating3_font: config/metadata/fonts/Avenir_95_Black.ttf
rating3_font_size: 70
horizontal_position: right
- default: ratings
template_variables:
builder_level: episode
rating1: critic
rating1_image: imdb
rating1_font: config/metadata/fonts/Impact.ttf
rating1_font_size: 70
rating2: audience
rating2_image: tmdb
rating2_font: config/metadata/fonts/Avenir_95_Black.ttf
rating2_font_size: 70
horizontal_position: right
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