Plex-Meta-Manager/docs/defaults/overlays/content_rating_us_show.md

3.9 KiB

Content Rating US Show Overlay

The content_rating_us_show Default Overlay File is used to create an overlay based on the MPAA Age Rating on each item within your library.

Requirements & Recommendations

Supported library types: Show

Requirements: Use the Mass Content Rating Update Library Operation with either mdb or omdb to update Plex to the MPAA Rating.

Supported Content Rating US

Rating Key
TV-G tv-g
TV-Y tv-y
TV-PG tv-pg
TV-14 tv-14
TV-MA tv-ma
NR nr

Config

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

libraries:
  TV Shows:
    overlay_path:
      - pmm: content_rating_us_show
      - pmm: content_rating_us_show
        template_variables:
          builder_level: season
      - pmm: content_rating_us_show
        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
color ``
horizontal_offset 15
horizontal_align left
vertical_offset 270
vertical_align bottom
Variable Description & Values
color Description: Color version of the content rating images
Default:`` Set to false if you want b&w version.
back_color Description: Choose the back color in RGBA for the overlay lozenge.
Default:#00000099
back_radius Description: Choose the back radius for the overlay lozenge.
Default:30
back_width Description: Choose the back width for the overlay lozenge.
Default:305
back_height Description: Choose the back height for the overlay lozenge.
Default:105
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: left
Values: left, right, top, bottom

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

libraries:
  TV Shows:
    overlay_path:
      - pmm: content_rating_us_show
        template_variables:
          color: false
      - pmm: content_rating_us_show
        template_variables:
          color: false
          builder_level: season
      - pmm: content_rating_us_show
        template_variables:
          color: false
          builder_level: episode