meisnate12
2 years ago
parent
cad9ada59a
commit
b610e4aa59
@ -0,0 +1,242 @@
|
||||
# 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 Movie and TV Libraries.**
|
||||
|
||||
|
||||
|
||||
## Collections Section 14
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:--------------------------------------------------------------|:-----------------------------------------:|:--------------------------------------------------------------------------------------|
|
||||
| `Ratings Collections` | `separator` | Separator Collection to denote the Section of Collections. |
|
||||
| `<<Content Rating>> Movies/Shows`<br>**Example:** `15 Movies` | `<<Content Rating>>`<br>**Example:** `15` | 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:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: content_rating_us
|
||||
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](../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.<br>**Values:** `false` to turn of the collection |
|
||||
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
||||
| `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>>` | **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:** Any Content Rating 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 list](#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:** Any Content Rating found in your library |
|
||||
| `append_include` | **Description:** Appends to the [default include list](#default-include).<br>**Values:** Any Content Rating found in your library |
|
||||
| `append_addons` | **Description:** Appends to the [default addons list](#default-addons).<br>**Values:** Any Content Rating 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. |
|
||||
|
||||
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`
|
||||
|
||||
<table class="clearTable">
|
||||
<tr>
|
||||
<th>Movies</th>
|
||||
<th>TV SHows</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml
|
||||
include:
|
||||
- G
|
||||
- PG
|
||||
- PG-13
|
||||
- R
|
||||
- NC-17
|
||||
```
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
```yaml
|
||||
include:
|
||||
- TV-G
|
||||
- TV-Y
|
||||
- TV-PG
|
||||
- TV-14
|
||||
- TV-MA
|
||||
```
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
## Default `addons`
|
||||
|
||||
<table class="clearTable">
|
||||
<tr>
|
||||
<th>Movies</th>
|
||||
<th>TV SHows</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml
|
||||
addons:
|
||||
G:
|
||||
- gb/U
|
||||
- gb/0+
|
||||
- U
|
||||
- TV-Y
|
||||
- TV-G
|
||||
- E
|
||||
- gb/E
|
||||
- 1
|
||||
- 2
|
||||
- 3
|
||||
- 4
|
||||
- 5
|
||||
- 6
|
||||
- "01"
|
||||
- "02"
|
||||
- "03"
|
||||
- "04"
|
||||
- "05"
|
||||
- "06"
|
||||
PG:
|
||||
- gb/PG
|
||||
- gb/9+
|
||||
- TV-PG
|
||||
- TV-Y7
|
||||
- TV-Y7-FV
|
||||
- 7
|
||||
- 8
|
||||
- 9
|
||||
- "07"
|
||||
- "08"
|
||||
- "09"
|
||||
- "10"
|
||||
- "11"
|
||||
PG-13:
|
||||
- gb/12A
|
||||
- gb/12
|
||||
- 12+
|
||||
- TV-13
|
||||
- 12
|
||||
- 13
|
||||
- 14
|
||||
- 15
|
||||
- 16
|
||||
R:
|
||||
- 17
|
||||
- 18
|
||||
- gb/18
|
||||
- MA-17
|
||||
- TVMA
|
||||
- TV-MA
|
||||
- gb/14+
|
||||
- gb/15
|
||||
- TV-14
|
||||
NC-17:
|
||||
- gb/R18
|
||||
- gb/X
|
||||
- R18
|
||||
- X
|
||||
```
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
```yaml
|
||||
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
|
||||
```
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@ -1,55 +0,0 @@
|
||||
# US Content Rating Default Metadata File
|
||||
|
||||
The `content_rating_us` 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 international ratings (such as "gb/12A") to the respective US rating system (such as "PG-13")
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: content_rating_us
|
||||
```
|
||||
|
||||
ohhh
|
||||
## Template Variables
|
||||
Template Variables can be used to manipulate the file from the default settings which are provided.
|
||||
|
||||
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
|
||||
|
||||
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
|
||||
| `include` | **Description:** Overrides the default include list<br>**Values:** Any Content Rating found in your library |
|
||||
| `exclude` | **Description:** Overrides the default exclude list<br>**Values:** Any Content Rating found in your library |
|
||||
| `addons` | **Description:** Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Any Content Rating found in your library |
|
||||
| `append_include` | **Description:** Appends to the existing include list<br>**Values:** Any Content Rating found in your library |
|
||||
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Content Rating found in your library |
|
||||
| `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Content Rating found in your library |
|
||||
|
||||
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:
|
||||
addons:
|
||||
R:
|
||||
- "de/18"
|
||||
sort_by: title.asc
|
||||
collection_section: 25
|
||||
collection_mode: show_items
|
||||
use_other: false
|
||||
use_separator: false
|
||||
sep_style: blue
|
||||
```
|
||||
|
||||
@ -1,54 +0,0 @@
|
||||
# US Content Rating Default Metadata File
|
||||
|
||||
The `show/content_rating_us` 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 international ratings (such as "gb/12A") to the respective US rating system (such as "TV-14")
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: show/content_rating_us
|
||||
```
|
||||
|
||||
ohhh
|
||||
## Template Variables
|
||||
Template Variables can be used to manipulate the file from the default settings which are provided.
|
||||
|
||||
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
|
||||
|
||||
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
|
||||
| `include` | **Description:** Overrides the default include list<br>**Values:** Any Content Rating found in your library |
|
||||
| `exclude` | **Description:** Overrides the default exclude list<br>**Values:** Any Content Rating found in your library |
|
||||
| `addons` | **Description:** Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Any Content Rating found in your library |
|
||||
| `append_include` | **Description:** Appends to the existing include list<br>**Values:** Any Content Rating found in your library |
|
||||
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Content Rating found in your library |
|
||||
| `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Content Rating found in your library |
|
||||
|
||||
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:
|
||||
addons:
|
||||
R:
|
||||
- "de/18"
|
||||
sort_by: title.asc
|
||||
collection_section: 25
|
||||
collection_mode: show_items
|
||||
use_other: false
|
||||
use_separator: false
|
||||
sep_style: blue
|
||||
```
|
||||
Loading…
Reference in new issue