Skip to content

Audio/Subtitle Language Flag Overlay

The languages Default Overlay File is used to an overlay of a flag and ISO 639-1 Code based on the audio/subtitle languages available on each item within your library.

header image

Requirements & Recommendations

Supported Overlay Level: Movie, Show, Season, Episode

Recommendations: Designed for TRaSH Guides filename naming scheme.

Supported Audio/Subtitle Language Flags

Audio/Subtitle Language Flag Key Weight
English en 610
German de 600
French fr 590
Spanish es 580
Portuguese pt 570
Japanese ja 560
Korean ko 550
Chinese zh 540
Danish da 530
Russian ru 520
Italian it 510
Hindi hi 500
Telugu te 490
Farsi fa 480
Thai th 470
Dutch nl 460
Norwegian no 450
Icelandic is 440
Swedish sv 430
Turkish tr 420
Polish pl 410
Czech cs 400
Ukrainian uk 390
Hungarian hu 380
Arabic ar 370
Bulgarian bg 360
Bengali bn 350
Bosnian bs 340
Catalan ca 330
Welsh cy 320
Greek el 310
Estonian et 300
Basque eu 290
Finnish fi 280
Tagalog tl 270
Filipino fil 265
Galician gl 260
Hebrew he 250
Croatian hr 240
Indonesian id 230
Georgian ka 220
Kazakh kk 210
Kannada kn 200
Latin la 190
Lithuanian lt 180
Latvian lv 170
Macedonian mk 160
Malayalam ml 150
Marathi mr 140
Malay ms 130
Norwegian Nokmål nb 120
Norwegian Nynorsk nn 110
Punjabi pa 100
Romanian ro 90
Slovak sk 80
Slovenian sl 70
Albanian sq 60
Serbian sr 50
Somali so 45
Swahili sw 40
Tamil ta 30
Urdu ur 20
Vietnamese vi 15
Bambara bm 12
Lingala ln 11
Wolof wo 10
Mayan myn 8
Inuktitut iu 7
Romani rom 6
Amharic am 5
Sundanese su 4
Zulu zu 3
Luxembourgish lb 2
Mossi mos 1
Lingala ln 11
Bambara bm 12
Afrikaans af 13
Mongolian mn 14
Khmer kh 16
Limburgish li 17
Irish ga 18
Aymara ay 19
Lao lo 9

Below is a screenshot of the default Round (round) style which can be set via the style Template Variable.

round style

Below is a screenshot of the alternative Square (square) style which can be set via the style Template Variable.

square style

Below is a screenshot of the alternative Half (half) style which can be set via the style Template Variable.

half style

Config

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

libraries:
  Movies:
    overlay_files:
      - default: languages
  TV Shows:
    overlay_files:
      - default: languages
      - default: languages
        template_variables:
          builder_level: episode
      - default: languages
        template_variables:
          builder_level: season

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: languages
        template_variables:
          languages: #(1)!
            - en
            - ja
          use_subtitles: true #(2)!
          style: square #(3)!

  1. Overrides which languages the overlay will apply for
  2. Display flags based on subtitle languages rather than audio languages
  3. Sets the flag images to have squared corners

  • 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 15/206/397/588/779
horizontal_align left/right/center
vertical_offset 15/76/137/198/259
vertical_align top/bottom/center
back_color #00000099
back_radius 26/0
back_width 190
back_height 105
back_align left/right
font fonts/Inter-Bold.ttf
font_size fonts/Inter-Bold.ttf_SIZE
Variable Description & Values
country_<<key>>1 Description: Controls the country image for the Overlay.
Default: Listed in the Table above
Values: ISO 3166-1 Country Code for the flag desired
flag_alignment Description: Controls the flag alignment in the backdrop.
Default: left
Values: left or right
group_alignment Description: Choose the display alignment for the flag group.
Default: vertical
Values: horizontal, or vertical
hide_text Description: Disables the country code text, showing only the flag.
Default: false
Values:** true to hide the country text
horizontal_position Description: Choose the horizontal position for the flag group.
Default: left
Values: left, left2, center, center_left, center_right, right or right2
horizontal_spacing Description: Controls the vertical spacing from one overlay in the queue to the next.
Values: Any Integer
initial_horizontal_align Description: Controls the initial horizontal align the queue starts from.
Values: left, center, or right
initial_horizontal_offset Description: Controls the initial horizontal offset the queue starts from.
Values: Any Integer
initial_vertical_align Description: Controls the initial vertical align the queue starts from.
Values: top, center, or bottom
initial_vertical_offset Description: Controls the initial vertical offset the queue starts from.
Values: Any Integer
languages Description: Controls which Languages will be active.
Default: ["en", "de", "fr", "es", "pt", "ja"]
Values: List of ISO 639-1 Codes for the Languages desired
offset Description: Controls the offset between the flag and the text.
Default: 10
Values: Any Integer 0 or greater
overlay_limit Description: Choose the number of overlay this queue displays.
Default: 3
Values: 1, 2, 3, 4, or 5
position Description: Use the Custom Given Queue instead of the the provided Queues.
Values: List of Coordinates
size Description: Controls the size of the overlay.
Default: small
Values: small or big
style Description: Controls the visual theme of the overlays created.
Values:
roundRound Theme
squareSquare Theme
halfSquare Flag with Round Background
use_lowercase Description: Controls if the overlay display is in lowercase.
Values: true to use lowercase text
use_subtitles Description: Controls if the overlay is based on subtitle language instead of audio language.
Values: true to look at subtitle language instead of audio language
vertical_position Description: Choose the vertical position for the flag group.
Default: top
Values: top, top2, top3, center, center_top, center_bottom, bottom, bottom2 or bottom3
vertical_spacing Description: Controls the vertical spacing from one overlay in the queue to the next.
Values: Any Integer
builder_level Description: Choose the Overlay Level.
Values: season or episode
weight_<<key>>1 Description: Controls the weight of the Overlay. Higher numbers have priority.
Values: 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. 

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.

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>>1 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>>1 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>>1 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>>1 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>>1 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]
  1. Each default overlay has a key that when calling to effect a specific collection you must replace <<key>> with when calling.

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.

The Audio/Subtitle Language Flag overlays use the plex_search Builder on either audio or subtitle tracks names.