Mirrors/Plex-Meta-Manager
2
0
Fork 0
mirror of https://github.com/meisnate12/Plex-Meta-Manager synced 2024-11-27 06:50:22 +00:00
Code Issues Projects Releases Packages Wiki Activity
Plex-Meta-Manager/docs/defaults/both/content_rating_cs.md
Chaz Larson b645955c57 clarify what those default lists are
2022-12-11 13:35:51 -06:00

9.8 KiB
Raw Blame History

Common Sense Media Content Rating Collections

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

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

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

This file works with Movie and Show Libraries.

Collections Section 14

Collection Key Description
Ratings Collections separator Separator Collection to denote the Section of Collections.
<<Content Rating>> Movies/Shows
Example: Age 5+ Movies		 <<Number>>
Example: 5		 Collection of Movies/Shows that have this Content Rating.
Not Rated Movies/Shows other Collection of Movies/Shows that are Unrated, Not Rated or any other uncommon Ratings.

Config

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

libraries:
  Movies:
    metadata_path:
      - pmm: content_rating_cs
  TV Shows:
    metadata_path:
      - pmm: content_rating_cs

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

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 then 0
limit_<<key>>1 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>>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
append_addons Description: Appends to the default addons dictionary.
Values: Dictionary List of Content Ratings found in your library
content_rating_cs_name Description: Changes the title format of the Dynamic Collections.
Default: Age <<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_cs_summary Description: Changes the summary format of the Dynamic Collections.
Default: <<library_translationU>>s that are rated <<key_name>> accorfing to the Common Sense Rating System.
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.
  1. Each default collection has a key that when calling to effect a specific collection you must replace <<key>> with when calling.

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_cs
        template_variables:
          use_separator: false
          sep_style: blue
          use_other: false
          append_addons:
            German 18:  # this doesn't have to exist already
              - de/18 # adds "de/18" to the existing "18" addon list
          sort_by: title.asc

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:
  - 1
  - 2
  - 3
  - 4
  - 5
  - 6
  - 7
  - 8
  - 9
  - 10
  - 11
  - 12
  - 13
  - 14
  - 15
  - 16
  - 17
  - 18

Default addons

addons:
  1:
    - gb/U
    - gb/0+
    - G
    - TV-Y
    - E
    - gb/E
    - G - All Ages
    - "01"
  2:
    - gb/U
    - gb/0+
    - G
    - TV-Y
    - E
    - gb/E
    - G - All Ages
    - "02"
  3:
    - gb/U
    - gb/0+
    - G
    - TV-Y
    - E
    - gb/E
    - G - All Ages
    - "03"
  4:
    - gb/U
    - gb/0+
    - G
    - TV-Y
    - E
    - gb/E
    - G - All Ages
    - "04"
  5:
    - gb/U
    - gb/0+
    - G
    - TV-Y
    - E
    - gb/E
    - G - All Ages
    - "05"
  6:
    - gb/U
    - gb/0+
    - G
    - TV-Y
    - E
    - gb/E
    - G - All Ages
    - "06"
  7:
    - gb/PG
    - TV-PG
    - TV-Y7
    - TV-Y7-FV
    - PG
    - PG - Children
    - "07"
  8:
    - gb/PG
    - TV-PG
    - TV-Y7
    - TV-Y7-FV
    - PG
    - PG - Children
    - "08"
  9:
    - gb/PG
    - TV-PG
    - TV-Y7
    - TV-Y7-FV
    - PG
    - PG - Children
    - gb/9+
    - "09"
  10:
    - gb/PG
    - TV-PG
    - TV-Y7
    - TV-Y7-FV
    - PG
    - PG - Children
    - gb/9+
  11:
    - gb/PG
    - TV-PG
    - TV-Y7
    - TV-Y7-FV
    - PG
    - PG - Children
    - gb/9+
  12:
    - gb/12
    - gb/12A
    - 12+
    - PG
    - PG - Children
  13:
    - gb/12
    - gb/12A
    - 12+
    - PG-13
    - PG-13 - Teens 13 or older
  14:
    - gb/12
    - 12
    - gb/12A
    - 12+
    - PG-13
    - TV-14
    - 13
    - PG-13 - Teens 13 or older
  15:
    - gb/15
    - gb/14+
    - TV-14
    - 13
    - 14
    - PG-13 - Teens 13 or older
  16:
    - gb/15
    - gb/14+
    - TV-14
    - 13
    - 14
    - 15
    - PG-13 - Teens 13 or older
  17:
    - gb/15
    - gb/14+
    - TV-14
    - 13
    - 14
    - 15
    - 16
    - R - 17+ (violence & profanity)
  18:
    - gb/18
    - MA-17
    - TVMA
    - TV-MA
    - R
    - 16
    - 17
    - gb/R18
    - gb/X
    - X
    - NC-17
    - R - 17+ (violence & profanity)
    - R+ - Mild Nudity
    - Rx - Hentai