Plex-Meta-Manager/docs/defaults/show/content_rating_us.md
2022-10-13 17:02:05 -04:00

8.1 KiB

US Content Rating Collections

The content_rating_us Default Metadata File is used to dynamically create collections based on the content ratings available in your library.

If you do not use the US-based rating system within Plex, this file will attempt to match the ratings in your library to the respective rating system.

This file works with TV Libraries, but has a Movie Library Counterpart.

Collections Section 14

Collection Key Description
Ratings Collections separator Separator Collection to denote the Section of Collections.
<<Content Rating>> Shows
Example: TV-14 Shows
<<Content Rating>>
Example: TV-14
Collection of Shows that have this Content Rating.
Not Rated Shows other Collection of Shows that are Unrated, Not Rated or any other uncommon Ratings.

Config

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

libraries:
  TV Shows:
    metadata_path:
      - pmm: content_rating_us

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 templates_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 Variables are available as well as the additional Variables below which can be used to customize the file.

Variable Description & Values
use_separator Description: Turn the Separator Collection off.
Values: false to turn of the collection
sep_style Description: Choose the Separator Style.
Default: orig
Values: orig, red, blue, green, gray, purple, or stb
limit Description: Changes the Builder Limit for all collections in a Defaults file.
Values: Number Greater then 0
limit_<<key>> Description: Changes the Builder Limit of the specified key's collection.
Default: limit
Values: Number Greater then 0
sort_by Description: Changes the Smart Filter Sort for all collections in a Defaults file.
Default: release.desc
Values: Any smart_filter Sort Option
sort_by_<<key>> Description: Changes the Smart Filter Sort of the specified key's collection.
Default: sort_by
Values: Any smart_filter Sort Option
include Description: Overrides the default include list.
Values: List of Content Ratings found in your library
exclude Description: Exclude these Content Ratings from creating a Dynamic Collection.
Values: List of Content Ratings found in your library
addons Description: Overrides the default addons dictionary. Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
Values: Dictionary List of Content Ratings found in your library
append_include Description: Appends to the default include list.
Values: List of Content Ratings found in your library
append_addons Description: Appends to the default addons dictionary.
Values: Dictionary List of Content Ratings found in your library
content_rating_name Description: Changes the title format of the Dynamic Collections.
Default: <<key_name>> <<library_translationU>>s
Values: Any string with <<key_name>> in it.
content_rating_other_name Description: Changes the Other Collection name.
Default: Not Rated <<library_translationU>>s
Values: Any string.
content_rating_summary Description: Changes the summary format of the Dynamic Collections.
Default: <<library_translationU>>s that are rated <<key_name>>.
Values: Any string.
content_rating_other_summary Description: Changes the Other Collection summary.
Default: <<library_translationU>>s that are Unrated, Not Rated or any other uncommon Ratings.
Values: Any string.

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

libraries:
  Movies:
    metadata_path:
      - pmm: content_rating_us
        template_variables:
          use_other: false
          use_separator: false
          sep_style: blue
          append_addons:
            R:
              - "de/18"
          sort_by: title.asc

Default include

include:
  - TV-G
  - TV-Y
  - TV-PG
  - TV-14
  - TV-MA

Default addons

addons:
  TV-G: 
    - gb/U
    - gb/0+
    - U
    - G
    - 1
    - 2
    - 3
    - 4
    - 5
    - 6
    - "01"
    - "02"
    - "03"
    - "04"
    - "05"
    - "06"
  TV-Y:
    - TV-Y7
    - TV-Y7-FV
    - 7
    - 8
    - 9
    - "07"
    - "08"
    - "09"
  TV-PG:
    - gb/PG
    - gb/9+
    - 10
    - 11
    - 12
    - 13
  TV-14:
    - gb/12A
    - 12+
    - PG-13
    - TV-13
    - gb/14+
    - gb/15
    - 14
    - 15
    - 16
    - 17
  TV-MA:
    - 18
    - gb/18
    - MA-17
    - NC-17
    - R
    - TVMA