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

56 lines
3.1 KiB
Markdown
Raw Normal View History

# Genre Default Metadata File
The `genre` Metadata File is used to dynamically create collections based on the genres available in your library.
This file also merges similarly named genres (such as "Sci-Fi", "SciFi" and "Sci-Fi & Fantasy") into one ("Science Fiction")
Example Collections Created:
![](../images/genre.png)
The below YAML in your config.yml will create the collections:
```yaml
libraries:
Movies:
metadata_path:
- pmm: genre
```
## 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.
2022-10-06 19:01:28 +00:00
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 Genre found in your library |
| `exclude` | **Description:** Overrides the default exclude list<br>**Values:** Any Genre 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 Genre found in your library |
| `append_include` | **Description:** Appends to the existing include list<br>**Values:** Any Genre found in your library |
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Genre found in your library |
| `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Genre found in your library |
2022-10-08 16:31:06 +00:00
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: genre
template_variables:
2022-10-06 19:01:28 +00:00
exclude:
- Politics
- News
addons:
Horror:
- Thriller # Adds all thriller items to the Horror collection
sort_by: title.asc
collection_section: 5
collection_mode: show_items
use_separator: false
sep_style: red
2022-10-06 19:01:28 +00:00
```