Plex-Meta-Manager/docs/defaults/movie/producer.md

89 lines
10 KiB
Markdown
Raw Normal View History

2022-10-10 20:56:05 +00:00
# Producer Collections
2022-10-10 20:56:05 +00:00
The `producer` Default Metadata File is used to dynamically create collections based on the most popular producers in your library.
## Requirements & Recommendations
Supported Library Types: Movie
2023-02-08 10:18:02 +00:00
## Collections Section 160
2022-10-10 20:56:05 +00:00
2022-11-16 14:30:04 +00:00
| Collection | Key | Description |
|:---------------------------------------------------|:---------------------------------------------------|:----------------------------------------------------------------------------|
2023-11-06 20:38:00 +00:00
| `Producer Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. |
| `<<producer_name>>`<br>**Example:** `Frank Welker` | `<<producer_name>>`<br>**Example:** `Frank Welker` | Collection of Movies by th Producer. |
2022-10-10 20:56:05 +00:00
2023-11-06 20:38:00 +00:00
{%
include-markdown "../people.md"
%}
2022-10-10 20:56:05 +00:00
## Config
The below YAML in your config.yml will create the collections:
```yaml
libraries:
Movies:
metadata_path:
2022-10-03 20:34:30 +00:00
- pmm: producer
```
## Template Variable Default Values
2022-10-10 20:56:05 +00:00
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.
2023-11-06 20:38:00 +00:00
This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
2022-11-03 19:44:01 +00:00
2023-04-18 13:10:22 +00:00
| Variable | Description & Values |
|:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `style` | **Description:** Controls the visual theme of the collections created.<br>**Default:** `bw`<br>**Values:** `bw`, `rainier`, `signature`, `diiivoy`, or `diiivoycolor` |
2023-09-25 23:10:21 +00:00
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
2023-11-06 20:38:00 +00:00
| `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](../../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](../../builders/smart.md#sort-options) |
2023-04-18 13:10:22 +00:00
| `data` | **Description:** Replaces the `data` dynamic collection value.<table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>depth</code></td><td>Controls the depth within the casting credits to search for common actors<hr><strong>Default:</strong> 5<hr><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create<hr><strong>Default:</strong> 25<hr><strong>Values:</strong> Number greater than 0</td></tr></table> |
| `include` | **Description:** Force these Actors to be included to create a Dynamic Collection.<br>**Values:** List of Actor Names |
| `exclude` | **Description:** Exclude these Producers from creating a Dynamic Collection.<br>**Values:** List of Producer Names |
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> (Producer)`<br>**Values:** Any string with `<<key_name>>` in it. |
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s produced by <<key_name>>.`<br>**Values:** Any string with `<<key_name>>` in it. |
2023-04-18 17:50:39 +00:00
| `tmdb_birthday` | **Description:** Controls if the Definition is run based on `tmdb_person`'s Birthday. Has 3 possible attributes `this_month`, `before` and `after`.<br>**Values:**<table class="clearTable"><tr><td>`this_month`</td><td>Run's if Birthday is in current Month</td><td>`true`/`false`</td></tr><tr><td>`before`</td><td>Run if X Number of Days before the Birthday</td><td>Number 0 or greater</td></tr><tr><td>`after`</td><td>Run if X Number of Days after the Birthday</td><td>Number 0 or greater</td></tr></table> |
2023-04-18 13:10:22 +00:00
| `tmdb_person_offset_<<key>>`<sup>1</sup> | **Description:** Changes the summary tmdb_person_offset for the specific key.<br>**Default:** `0`<br>**Values:** Dictionary of Actor Name as the keys and the tmdb_person_offset as the value. |
2022-10-17 12:13:48 +00:00
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
{%
include-markdown "../collection_variables.md"
%}
### Example Template Variable Amendments
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.
???+ tip
Anywhere you see this icon:
> :fontawesome-solid-circle-plus:
That's a tooltip, you can press them to get more information.
```yaml
libraries:
Movies:
metadata_path:
2022-10-03 20:34:30 +00:00
- pmm: producer
template_variables:
data:
depth: 15 #(1)!
limit: 5 #(2)!
style: signature #(3)!
sort_by: title.asc
use_separator: false #(4)!
tmdb_person_offset_Richard Brooks: 1 #(5)!
```
1. Check the first 15 casting credits in each movie
2. Create 5 collections maximum
3. use the [rainier Style](#signature-style)
4. Do not create a "Producers Collections" separator
5. There are two Richard Brooks, so use the 2nd [Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb