Mirrors/Plex-Meta-Manager
2
0
Fork 0
mirror of https://github.com/meisnate12/Plex-Meta-Manager synced 2024-12-04 02:09:16 +00:00
Code Issues Projects Releases Packages Wiki Activity
Plex-Meta-Manager/docs/defaults/overlays/language_count.md
meisnate12 63e9e7a56b [24] move to mkdocs
2023-11-06 15:38:00 -05:00

4.3 KiB
Raw Blame History

Audio/Subtitle Language Count Overlay

The language_count Default Overlay File is used to create an overlay based on the number of audio/subtitle languages available on each item within your library.

Requirements & Recommendations

Supported Overlay Level: Movie, Show, Season, Episode

Supported Audio/Subtitle Languages

Audio/Subtitle Languages Key Weight
Dual dual 20
Multi multi 10

Config

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

libraries:
  Movies:
    overlay_path:
      - pmm: language_count
  TV Shows:
    overlay_path:
      - pmm: language_count
      - pmm: language_count
        template_variables:
          builder_level: season
      - pmm: language_count
        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 0
horizontal_align center
vertical_offset 30
vertical_align bottom
back_color #00000099
back_radius 30
back_width 188
back_height 105
Variable Description & Values
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
minimum Description: Choose the minimum for the multi Overlay.
Default: 2
Values: Any Number
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 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: language_count
        template_variables:
          use_subtitles: true