mirror of
https://github.com/meisnate12/Plex-Meta-Manager
synced 2024-11-15 01:07:24 +00:00
147 lines
8 KiB
Markdown
147 lines
8 KiB
Markdown
# 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 Show Libraries, but has a Movie Library [Counterpart](../movie/content_rating_us).**
|
|
|
|
|
|
|
|
## Collections Section 14
|
|
|
|
| Collection | Key | Description |
|
|
|:---------------------------------------------------------|:--------------------------------------------:|:-------------------------------------------------------------------------------|
|
|
| `Ratings Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
|
|
| `<<Content Rating>> Shows`<br>**Example:** `TV-14 Shows` | `<<Content Rating>>`<br>**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:
|
|
|
|
```yaml
|
|
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 Collection Variables](../collection_variables) are available as well as the additional Variables below which can be used to customize the file.
|
|
|
|
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
|
|
|
|
| Variable | Description & Values |
|
|
|:-------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
|
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
|
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
|
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** List of Content Ratings found in your library |
|
|
| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.<br>**Values:** List of Content Ratings found in your library |
|
|
| `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Dictionary List of Content Ratings found in your library |
|
|
| `append_include` | **Description:** Appends to the [default include list](#default-include).<br>**Values:** List of Content Ratings found in your library |
|
|
| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).<br>**Values:** Dictionary List of Content Ratings found in your library |
|
|
| `content_rating_name` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. |
|
|
| `content_rating_other_name` | **Description:** Changes the Other Collection name.<br>**Default:** `Not Rated <<library_translationU>>s`<br>**Values:** Any string. |
|
|
| `content_rating_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. |
|
|
| `content_rating_other_summary` | **Description:** Changes the Other Collection summary.<br>**Default:** `<<library_translationU>>s that are Unrated, Not Rated or any other uncommon Ratings.`<br>**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.
|
|
|
|
```yaml
|
|
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`
|
|
|
|
```yaml
|
|
include:
|
|
- TV-G
|
|
- TV-Y
|
|
- TV-PG
|
|
- TV-14
|
|
- TV-MA
|
|
```
|
|
|
|
## Default `addons`
|
|
|
|
```yaml
|
|
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
|
|
```
|