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>>
Choose the font for this key's Overlay.
Default:fonts/Inter-Medium.ttf Path to font file
font_color_<<key>>
Choose the font color for this key's Overlay.
Default:#FFFFFF Color Hex Code in format #RGB, #RGBA, #RRGGBB or #RRGGBBAA
font_color
Choose the font color for the Overlay.
Default:#FFFFFF Color Hex Code in format #RGB, #RGBA, #RRGGBB or #RRGGBBAA
font_size_<<key>>
Choose the font size for this key's Overlay.
Default:55 Any number greater than 0 [pixels assuming a 1000x1500 image]
font_size
Choose the font size for the Overlay.
Default:55 Any number greater than 0 [pixels assuming a 1000x1500 image]
font_style_<<key>>
Font style for this key's Variable Fonts. The valid values depend on the font; the default font (fonts/Inter-Medium.ttf) exposes Thin, ExtraLight, Light, Regular, Medium, SemiBold, Bold, ExtraBold, Black. For other fonts, the runtime error message lists the valid options.
Variable Font Style
font_style
Font style for Variable Fonts. The valid values depend on the font; the default font (fonts/Inter-Medium.ttf) exposes Thin, ExtraLight, Light, Regular, Medium, SemiBold, Bold, ExtraBold, Black. For other fonts, the runtime error message lists the valid options.
Variable Font Style
font
Choose the font for the Overlay.
Default:fonts/Inter-Medium.ttf Path to font file
stroke_color_<<key>>
Font Stroke Color for this key's Overlay.
Color Hex Code in format #RGB, #RGBA, #RRGGBB or #RRGGBBAA
stroke_color
Font Stroke Color for the Overlay.
Color Hex Code in format #RGB, #RGBA, #RRGGBB or #RRGGBBAA
stroke_width_<<key>>
Font Stroke Width for this key's Overlay.
Any number greater than 0 [pixels assuming a 1000x1500 image]
stroke_width
Font Stroke Width for the Overlay.
Any number greater than 0 [pixels assuming a 1000x1500 image]
These services do not store season or episode-level ratings, using these options will allow show ratings to be
applied at the season or episode level.
YAML Lists Explained
YAML supports different ways to define lists. Below are some common methods:
1. List Within a Mapping
fruits:
- apple
- banana
- cherry
2. Inline Style
fruits: [ apple, banana, cherry ]
Each style can be used depending on your needs. The block style is typically more readable for longer lists,
while the inline style is compact and useful for short lists.
YAML Dictionaries Explained
Dictionaries are used to associate key/value pairs that are unordered. Dictionaries can be nested by increasing
the indentation,
or new dictionaries can be created at the same level by resolving the previous one.
cache: true cache_expiration: 60
The "keys" are cache and cache_expiration and the "values" are true and
60 respectively.
You can use multiple score filters but the number will have to match every filter. All unrated items are considered
to have a 0 rating.
These filters only work if the URL is to the List View of the Letterboxd list (i.e. it should have
/detail/ in the URL) or to an account's Reviews (i.e. it should have
/USERNAME/films/reviews/ in the URL).
This filter only works if the URL is to the List View of the Letterboxd list (i.e. it should have
/detail/ in the URL).
When title is not provided and the mapping name was not specified as an ID, the default behaviour is to
use the mapping name as title for matching.
When mapping_id is not provided and the mapping name was specified as an ID, the default behaviour is
to use the mapping name as mapping_id for matching.
When the server does not have a Plex Pass then the Edition Field is not accessible. In this scenario, Kometa will
check the movie's filepath for {edition-...} to determine what the edition is.
Requires Plex Pass.
Must be using the New Plex Movie Agent or the New Plex TV Agent.
Each default has a key that when calling to effect a specific collection/overlay you must replace
<<key>> with when calling.
You can use current_year to have Kometa use the current year's value. This can be combined with a
-# at the end to subtract that number of years. i.e. current_year-2
Also filters out missing movies/shows from being added to Radarr/Sonarr. These values also cannot use the count
modifiers.
You can use current_year to have Kometa use the current year's value. This can be combined with a
-# at the end to subtract that number of years. i.e. current_year-2
Also filters out missing movies/shows from being added to Radarr/Sonarr. These values also cannot use the count
modifiers.
You can use current_year to have Kometa use the current year's value. This can be combined with a
-# at the end to subtract that number of years. i.e. current_year-2
Also filters out missing movies/shows from being added to Radarr/Sonarr. These values also cannot use the count
modifiers.
Also is a Tag Filter and can use all of those modifiers.
Requires Template Variables to function
Designed to use the TRaSH Guides filename naming scheme
Editions overlay is designed to use the Editions field within Plex (which requires Plex Pass to use) or the TRaSH Guides filename naming scheme
Designed to use the TRaSH Guides filename naming scheme
While these overlays can technically be applied at this level, they were not designed for it. For example, a show's
season cannot have a resolution since it is not a video file, and an episode cannot have a Common Sense rating since
only Movies and Shows are rated by Common Sense.