Plex-Meta-Manager/docs/defaults/show/content_rating_us.md

8.5 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 has a Movie Library Counterpart.

Requirements & Recommendations

Supported Library Types: Show

Collections Section 110

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 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.

This file contains a Separator so all Shared Separator Variables are available as well.

Variable Description & Values
limit Description: Changes the Builder Limit for all collections in a Defaults file.
Values: Number Greater than 0
limit_<<key>>1 Description: Changes the Builder Limit of the specified key's collection.
Default: limit
Values: Number Greater than 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>>1 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
remove_include Description: Removes from 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
remove_addons Description: Removes from the default addons dictionary.
Values: Dictionary List of Content Ratings found in your library
name_format Description: Changes the title format of the Dynamic Collections.
Default: <<key_name>> <<library_translationU>>s
Values: Any string with <<key_name>> in it.
summary_format Description: Changes the summary format of the Dynamic Collections.
Default: <<library_translationU>>s that are rated <<key_name>>.
Values: Any string.
  1. Each default collection has a key that when calling to effect a specific collection you must replace <<key>> with when calling.

{% include-markdown "../collection_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.

???+ tip

Anywhere you see this icon:

> :fontawesome-solid-circle-plus:

That's a tooltip, you can press them to get more information.
libraries:
  Movies:
    metadata_path:
      - pmm: content_rating_us
        template_variables:
          sep_style: blue #(1)!
          use_other: false #(2)!
          append_addons:
            R: #(3)!
              - "de/18" #(4)!
          sort_by: title.asc
  1. Use the blue Separator Style
  2. Do not create a "Not Rated Movies" collection
  3. Defines a collection which will be called "R", this does not need to already exist in your library
  4. Adds the "de/18" content rating to the "R" addon list, "de/18" must exist in your library if the "R" content rating does not

Default values

These are lists provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.

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"
    - G - All Ages
  TV-Y:
    - TV-Y7
    - TV-Y7-FV
    - 7
    - 8
    - 9
    - "07"
    - "08"
    - "09"
  TV-PG:
    - gb/PG
    - gb/9+
    - 10
    - 11
    - 12
    - 13
    - PG - Children
  TV-14:
    - gb/12A
    - 12+
    - PG-13
    - TV-13
    - gb/14+
    - gb/15
    - 14
    - 15
    - 16
    - 17
    - PG-13 - Teens 13 or older
  TV-MA:
    - 18
    - gb/18
    - MA-17
    - NC-17
    - R
    - TVMA
    - R - 17+ (violence & profanity)
    - R+ - Mild Nudity
    - Rx - Hentai