Mirrors/Plex-Meta-Manager
2
0
Fork 0
mirror of https://github.com/meisnate12/Plex-Meta-Manager synced 2024-11-26 22:40:26 +00:00
Code Issues Projects Releases Packages Wiki Activity
Plex-Meta-Manager/docs/defaults/overlays/commonsense.md
Chaz Larson e317c0d533 greater *than* 0
2023-09-25 18:10:21 -05:00

5.2 KiB
Raw Blame History

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 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
horizontal_align left
vertical_offset 270
vertical_align bottom
back_color #00000099
back_radius 30
back_width 305
back_height 105
Variable Description & Values
font Description: Choose the font for the Overlay.
Default: fonts/Inter-Medium.ttf
Values: Path to font file
font_style Description: Font style for Variable Fonts.
Values: Variable Font Style
font_size Description: Choose the font size for the Overlay.
Default: 55
Values: Any number greater than 0
font_color Description: Choose the font color for the Overlay.
Default: #FFFFFF
Values: Color Hex Code in format #RGB, #RGBA, #RRGGBB or #RRGGBBAA
stroke_width Description: Font Stroke Width for the Text Overlay.
Values: Any number greater than 0
stroke_color Description: Font Stroke Color for the Text Overlay.
Values: Color Hex Code in format #RGB, #RGBA, #RRGGBB or #RRGGBBAA
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

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"