Plex-Meta-Manager/docs/defaults/both/content_rating_cs.md

54 lines
No EOL
3.3 KiB
Markdown

# Common Sense Media Content Rating Default Metadata File
The `- pmm: content_rating_cs` Metadata File is used to dynamically create collections based on the content ratings available in your library.
If you do not use the UK-based rating system within Plex, this file will attempt to match the standard ratings (such as PG-13) to the respective UK rating system (such as 12)
Example Collections Created:
![](../images/content_rating_cs.png)
The below YAML in your config.yml will create the collections:
```yaml
libraries:
Movies:
metadata_path:
- pmm: content_rating_cs
```
## 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 changed from their defaults.
```yaml
libraries:
Movies:
metadata_path:
- pmm: content_rating_cs
template_variables:
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
collection_section: 21
collection_mode: show_items
use_other: false
use_separator: false
sep_style: blue
```