Plex-Meta-Manager/docs/defaults/overlays/languages.md
Geography 588c61af6e
Update languages.md
Updated languages overlay doc with Lingala mapped to Democratic Republic of the Congo
2023-09-19 14:19:45 +01:00

14 KiB

Audio/Subtitle Language Flags Overlay

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

Requirements & Recommendations

Supported library types: Movie & Show

Supported Audio/Subtitle Language Flags

Audio/Subtitle Languages Key Weight Default Flag Default Use
English en 610 us
German de 600 de
French fr 590 fr
Spanish es 580 es
Portuguese pt 570 pt
Japanese ja 560 jp
Korean ko 550 kr
Chinese zh 540 cn
Danish da 530 dk
Russian ru 520 ru
Italian it 510 it
Hindi hi 500 in
Telugu te 490 in
Farsi fa 480 ir
Thai th 470 th
Dutch nl 460 nl
Norwegian no 450 no
Icelandic is 440 is
Swedish sv 430 se
Turkish tr 420 tr
Polish pl 410 pl
Czech cs 400 cz
Ukrainian uk 390 ua
Hungarian hu 380 hu
Arabic ar 370 eg
Bulgarian bg 360 bg
Bengali bn 350 bd
Bosnian bs 340 ba
Catalan ca 330 es
Welsh cy 320 uk
Greek el 310 gr
Estonian et 300 ee
Basque eu 290 es
Finnish fi 280 fi
Tagalog tl 270 ph
Filipino fil 265 ph
Galician gl 260 es
Hebrew he 250 il
Croatian hr 240 hr
Indonesian id 230 id
Georgian ka 220 ge
Kazakh kk 210 kz
Kannada kn 200 in
Latin la 190 it
Lithuanian lt 180 lt
Latvian lv 170 lv
Macedonian mk 160 mk
Malayalam ml 150 in
Marathi mr 140 in
Malay ms 130 my
Norwegian Nokmål nb 120 no
Norwegian Nynorsk nn 110 no
Punjabi pa 100 in
Romanian ro 90 ro
Slovak sk 80 sk
Slovenian sl 70 si
Albanian sq 60 al
Serbian sr 50 rs
Somali so 45 so
Swahili sw 40 tz
Tamil ta 30 in
Urdu ur 20 pk
Vietnamese vi 15 vn
Lingala ln 11 cd
Wolof wo 10 sn
Mayan myn 8 mx
Inuktitut iu 7 ca
Romani rom 6 ro
Amharic am 5 et
Sundanese su 4 id
Zulu zu 3 za
Luxembourgish lb 2 lu
Mossi mos 1 bf

Square Style

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

Half Style

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

Config

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

libraries:
  Movies:
    overlay_path:
      - pmm: languages
  TV Shows:
    overlay_path:
      - pmm: languages
      - pmm: languages
        template_variables:
          builder_level: season
      - pmm: languages
        template_variables:
          builder_level: episode

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 is its default value if it has one if not it's just ignored.

All Shared Overlay Variables are available with the default values below as well as the additional Variables below which can be used to customize the file.

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/
back_width 190
back_height 105
back_align left/right
font fonts/Inter-Bold.ttf
font_size 50
Variable Description & Values
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
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
builder_level Description: Choose the Overlay Level.
Values: season or episode
horizontal_position Description: Choose the horizontal position for the flag group.
Default: left
Values: left, left2, center, center_left, center_right, right or right2
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
overlay_limit Description: Choose the number of overlay this queue displays.
Default: 3
Values: 1, 2, 3, 4, or 5
group_alignment Description: Choose the display alignment for the flag group.
Default: vertical
Values: horizontal, or vertical
style Description: Controls the visual theme of the overlays created.
Values:
roundRound Theme
squareSquare Theme
halfSquare Flag with Round Background
flag_alignment Description: Controls the flag alignment in the backdrop.
Default: left
Values: left or right
offset Description: Controls the offset between the flag and the text.
Default: 10
Values: Any Integer 0 or greater
use_lowercase Description: Controls if the overlay display is in lowercase.
Values: true to use lowercase text
position Description: Use the Custom Given Queue instead of the the provided Queues.
Values: List of Coordinates
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
weight_<<key>>1 Description: Controls the weight of the Overlay. Higher numbers have priority.
Values: Any Number
  1. Each default overlay has a key that when calling to effect a specific overlay you must replace <<key>> with when calling.

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

libraries:
  Movies:
    overlay_path:
      - pmm: languages
        template_variables:
          languages:
            - en
            - ja
          use_subtitles: true
          style: square