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

52 lines
3 KiB
Markdown
Raw Normal View History

2022-09-27 15:08:18 +00:00
# Studio Default Metadata File
The `- pmm: studio` Metadata File is used to dynamically create collections based on the studios available in your library.
This file also merges similarly named studios (such as "20th Century Fox" and "20th Century Animation") into one ("20th Century Studios")
Example Collections Created:
![](../images/studio.png)
2022-09-27 15:08:18 +00:00
2022-09-27 22:01:34 +00:00
The below YAML in your config.yml will create the collections:
2022-09-27 15:08:18 +00:00
```yaml
libraries:
Movies:
metadata_path:
- pmm: studio
```
## 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 Studio found in your library |
| `exclude` | **Description:** Overrides the default exclude list<br>**Values:** Any Studio 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 Studio found in your library |
| `append_include` | **Description:** Appends to the existing include list<br>**Values:** Any Studio found in your library |
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Studio found in your library |
| `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Studio found in your library |
2022-09-27 15:08:18 +00:00
The below is an example config.yml extract with some template_variables changed from their defaults.
2022-09-27 15:08:18 +00:00
```yaml
libraries:
Movies:
metadata_path:
- pmm: studio
template_variables:
2022-10-06 19:01:28 +00:00
append_include:
- Big Bull Productions
2022-09-27 15:08:18 +00:00
sort_by: title.asc
collection_section: 4
collection_mode: show_items
use_separator: false
sep_style: gray
2022-10-06 19:01:28 +00:00
```