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

4.6 KiB

CommonSense Age Rating Overlay

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

Requirements & Recommendations

Supported library types: Movie & Show

Requirements: Use the Mass Content Rating Update Library Operation with either mdb_commonsense or mdb_commonsense0 to update Plex to the Common Sense Rating.

Supported CommonSense Age Rating

Rating Key
1+ 1
2+ 2
3+ 3
4+ 4
5+ 5
6+ 6
7+ 7
8+ 8
9+ 9
10+ 10
11+ 11
12+ 12
13+ 13
14+ 14
15+ 15
16+ 16
17+ 17
18+ 18
NR nr

Config

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

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

Template Variable Default Values

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.

Variable Default / Values
horizontal_offset 15
horizontal_align left
vertical_offset 270
vertical_align bottom
back_color #00000099
back_radius 30
back_width 305
back_height 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
pre_text Description: Choose the text before the key for the Overlay.
Values: Any String
post_text Description: Choose the text after the key for the Overlay.
Default: +
Values: Any String
pre_nr_text Description: Choose the text before the nr key for the Overlay.
Values: Any String
post_nr_text Description: Choose the text after the nr key for the Overlay.
Values: Any String
builder_level Description: Choose the Overlay Level.
Values: season or episode

{% include-markdown "../overlay_variables.md" %}

Example Template Variable Amendments

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: commonsense
        template_variables:
          pre_text: "CS"