parent
ec5248963c
commit
af9aef324b
Binary file not shown.
After Width: | Height: | Size: 99 KiB |
After Width: | Height: | Size: 107 KiB |
@ -0,0 +1,53 @@
|
||||
# US Content Rating Default Metadata File
|
||||
|
||||
The `- pmm: 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:
|
||||
|
||||
![](../images/content_rating_us.png)
|
||||
|
||||
The below YAML in your config.yml will create the actor 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.
|
||||
|
||||
Below are the available variables which can be used to customize the file.
|
||||
|
||||
|
||||
| Variable | Usage | Default Value | Values |
|
||||
|:-------------------|:-----------------------------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| sort_by | Controls the sort method for the collections | `release.desc` | Any sort method in the [Sorts Options Table](#sort-options) |
|
||||
| collection_section | Controls the sort order of these collections against other default collections | `14` | Any number |
|
||||
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
|
||||
| use_other | Controls whether an "Other" collection is created for any items not included in the initial criteria | `true` | `true` or `false` |
|
||||
| use_separator | Controls whether a separator is created | `true` | `true` or `false` |
|
||||
| sep_style | Sets the theme of the separator | `orig` | `orig`, `blue`, `gray`, `green`, `purple`, `red`, `stb` |
|
||||
| item_radarr_tag | rADARR Tag for existing items | | list of tag(s) to be applied to existing items |
|
||||
|
||||
The below shows an example config.yml with all the template_variables set away from their defaults:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: content_rating_us
|
||||
template_variables:
|
||||
sort_by: title.asc
|
||||
collection_section: 25
|
||||
collection_mode: show_items
|
||||
use_other: false
|
||||
use_separator: false
|
||||
sep_style: blue
|
||||
```
|
||||
|
@ -0,0 +1,55 @@
|
||||
# country Language Default Metadata File
|
||||
|
||||
The `- pmm: country` Metadata File is used to dynamically create collections based on the counties available in your library.
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
![](../images/country1.png)
|
||||
|
||||
The below YAML in your config.yml will create the actor collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: country
|
||||
```
|
||||
## Color Style
|
||||
Below is a screenshot of the alternative `color` style which can be set via template variables
|
||||
|
||||
![](../images/country2.png)
|
||||
|
||||
## 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.
|
||||
|
||||
Below are the available variables which can be used to customize the file.
|
||||
|
||||
|
||||
| Variable | Usage | Default Value | Values |
|
||||
|:-------------------|:-----------------------------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| style | Controls the visual theme of the collections created | `white` | `white` or `color` |
|
||||
| sort_by | Controls the sort method for the collections | `release.desc` | Any sort method in the [Sorts Options Table](#sort-options) |
|
||||
| collection_section | Controls the sort order of these collections against other default collections | `13` | Any number |
|
||||
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
|
||||
| use_other | Controls whether an "Other" collection is created for any items not included in the initial criteria | `true` | `true` or `false` |
|
||||
| use_separator | Controls whether a separator is created | `true` | `true` or `false` |
|
||||
| sep_style | Sets the theme of the separator | `orig` | `orig`, `blue`, `gray`, `green`, `purple`, `red`, `stb` |
|
||||
| item_radarr_tag | Sonarr Tag for existing items | | list of tag(s) to be applied to existing items |
|
||||
|
||||
The below shows an example config.yml with all the template_variables set away from their defaults:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: country
|
||||
template_variables:
|
||||
sort_by: title.asc
|
||||
collection_section: 8
|
||||
collection_mode: show_items
|
||||
use_other: false
|
||||
use_separator: false
|
||||
sep_style: purple
|
||||
```
|
||||
|
@ -0,0 +1,51 @@
|
||||
# Decade Language Default Metadata File
|
||||
|
||||
The `- pmm: decade` Metadata File is used to dynamically create collections based on the decades available in your library, sorted by critic rating to create a "best of <decade>"
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
![](../images/decade.png)
|
||||
|
||||
The below YAML in your config.yml will create the actor collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: decade
|
||||
```
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
Below are the available variables which can be used to customize the file.
|
||||
|
||||
|
||||
| Variable | Usage | Default Value | Values |
|
||||
|:-------------------|:-----------------------------------------------------------------------------------------------------|------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| sort_by | Controls the sort method for the collections | `audience_rating.desc` | Any sort method in the [Sorts Options Table](#sort-options) |
|
||||
| collection_section | Controls the sort order of these collections against other default collections | `12` | Any number |
|
||||
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
|
||||
| use_other | Controls whether an "Other" collection is created for any items not included in the initial criteria | `true` | `true` or `false` |
|
||||
| use_separator | Controls whether a separator is created | `true` | `true` or `false` |
|
||||
| sep_style | Sets the theme of the separator | `orig` | `orig`, `blue`, `gray`, `green`, `purple`, `red`, `stb` |
|
||||
| item_radarr_tag | Sonarr Tag for existing items | | list of tag(s) to be applied to existing items |
|
||||
|
||||
The below shows an example config.yml with all the template_variables set away from their defaults:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: decade
|
||||
template_variables:
|
||||
sort_by: title.asc
|
||||
collection_section: 18
|
||||
collection_mode: show_items
|
||||
use_other: false
|
||||
use_separator: false
|
||||
sep_style: purple
|
||||
```
|
||||
|
@ -0,0 +1,56 @@
|
||||
# Director Default Metadata File
|
||||
|
||||
The `- pmm: director` Metadata File is used to dynamically create collections based on the most popular directors in your library.
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
![](images/director1.png)
|
||||
|
||||
The below YAML in your config.yml will create the director collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: director
|
||||
```
|
||||
|
||||
## Rainier Style
|
||||
Below is a screenshot of the alternative `Rainier` style which can be set via template variables
|
||||
|
||||
![](images/director2.png)
|
||||
|
||||
|
||||
## Template Variables
|
||||
Template Variables can be used to manipulate the director 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.
|
||||
|
||||
Below are the available variables which can be used to customize the file.
|
||||
|
||||
|
||||
| Variable | Usage | Default Value | Values |
|
||||
|:-------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| style | Controls the visual theme of the collections created | `bw` | `bw` - Black and white theme or<br/>`rainier` - Rainier theme |
|
||||
| sort_by | Controls the sort method for the collections | `release.desc` | Any sort method in the [Sorts Options Table](#sort-options) |
|
||||
| collection_section | Controls the sort order of these collections against other default collections | `17` | Any number |
|
||||
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
|
||||
| use_separator | Controls whether a separator is created | `true` | `true` or `false` |
|
||||
| sep_style | Sets the theme of the separator | `orig` | `orig`, `blue`, `gray`, `green`, `purple`, `red`, `stb` |
|
||||
| item_radarr_tag | Radarr Tag for existing items | | list of tag(s) to be applied to existing items |
|
||||
|
||||
The below shows an example config.yml with all of the template_variables set away from their defaults:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: director
|
||||
template_variables:
|
||||
style: rainier
|
||||
sort_by: title.asc
|
||||
collection_section: 12
|
||||
collection_mode: show_items
|
||||
use_separator: false
|
||||
sep_style: purple
|
||||
```
|
||||
|
@ -0,0 +1,55 @@
|
||||
# Franchise Language Default Metadata File
|
||||
|
||||
The `- pmm: franchise` Metadata File is used to create collections based on popular Movie franchises
|
||||
|
||||
Unlike most Default Metadata Files, Franchise works by placing collections inline with the main library items if your library allows it. For example, the "Iron Man" franchise collection will appear next to the "Iron Man" movies within your library.
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
![](../images/moviefranchise.png)
|
||||
|
||||
The below YAML in your config.yml will create the actor collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: franchise
|
||||
```
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
Below are the available variables which can be used to customize the file.
|
||||
|
||||
|
||||
| Variable | Usage | Default Value | Values |
|
||||
|:-------------------|:----------------------------------------------|---------------|:----------------------------------------------:|
|
||||
| collection_order | Sets the collection order of the collection | `release` | `release`, `alpha` or `custom` |
|
||||
| sort_title | Sets the sort title | | Desired sort title |
|
||||
| minimum_items | Sets the minimum items of the collection | `2` | Any number |
|
||||
| build_collection | Sets weather to actually build the collection | `true` | `true` or `false` |
|
||||
| radarr_add_missing | Adds missing from the collection to radarr | `false` | `true` or `false` |
|
||||
| radarr_folder | Radarr Folder to add to | | Folder to add missing items to |
|
||||
| radarr_tag | Radarr Tag for added missing | | list of tag(s) to be applied to existing items |
|
||||
| item_radarr_tag | Radarr Tag for existing items | | list of tag(s) to be applied to existing items |
|
||||
|
||||
The below shows an example config.yml with all the template_variables set away from their defaults:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: franchise
|
||||
template_variables:
|
||||
collection_order: alpha
|
||||
sort_title: "!10_<<collection_name>>"
|
||||
build_collection: false
|
||||
radarr_add_missing: true
|
||||
radarr_folder: /mnt/local/Media/TV
|
||||
radarr_tag: <<collection_name>>
|
||||
item_radarr_tag: <<collection_name>>
|
||||
```
|
||||
|
@ -0,0 +1,51 @@
|
||||
# Network Language Default Metadata File
|
||||
|
||||
The `- pmm: network` Metadata File is used to dynamically create collections based on the counties available in your library.
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
![](../images/network.png)
|
||||
|
||||
The below YAML in your config.yml will create the actor collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: network
|
||||
```
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
Below are the available variables which can be used to customize the file.
|
||||
|
||||
|
||||
| Variable | Usage | Default Value | Values |
|
||||
|:-------------------|:-----------------------------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| sort_by | Controls the sort method for the collections | `release.desc` | Any sort method in the [Sorts Options Table](#sort-options) |
|
||||
| collection_section | Controls the sort order of these collections against other default collections | `04` | Any number |
|
||||
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
|
||||
| use_other | Controls whether an "Other" collection is created for any items not included in the initial criteria | `true` | `true` or `false` |
|
||||
| use_separator | Controls whether a separator is created | `true` | `true` or `false` |
|
||||
| sep_style | Sets the theme of the separator | `orig` | `orig`, `blue`, `gray`, `green`, `purple`, `red`, `stb` |
|
||||
| item_sonarr_tag | Sonarr Tag for existing items | | list of tag(s) to be applied to existing items |
|
||||
|
||||
The below shows an example config.yml with all the template_variables set away from their defaults:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: network
|
||||
template_variables:
|
||||
sort_by: title.asc
|
||||
collection_section: 07
|
||||
collection_mode: show_items
|
||||
use_other: false
|
||||
use_separator: false
|
||||
sep_style: stb
|
||||
```
|
||||
|
@ -0,0 +1,56 @@
|
||||
# Producer Default Metadata File
|
||||
|
||||
The `- pmm: producer` Metadata File is used to dynamically create collections based on the most popular producers in your library.
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
![](images/producer1.png)
|
||||
|
||||
The below YAML in your config.yml will create the producer collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: producer
|
||||
```
|
||||
|
||||
## Rainier Style
|
||||
Below is a screenshot of the alternative `Rainier` style which can be set via template variables
|
||||
|
||||
![](images/producer2.png)
|
||||
|
||||
|
||||
## Template Variables
|
||||
Template Variables can be used to manipulate the producer 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.
|
||||
|
||||
Below are the available variables which can be used to customize the file.
|
||||
|
||||
|
||||
| Variable | Usage | Default Value | Values |
|
||||
|:-------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| style | Controls the visual theme of the collections created | `bw` | `bw` - Black and white theme or<br/>`rainier` - Rainier theme |
|
||||
| sort_by | Controls the sort method for the collections | `release.desc` | Any sort method in the [Sorts Options Table](#sort-options) |
|
||||
| collection_section | Controls the sort order of these collections against other default collections | `17` | Any number |
|
||||
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
|
||||
| use_separator | Controls whether a separator is created | `true` | `true` or `false` |
|
||||
| sep_style | Sets the theme of the separator | `orig` | `orig`, `blue`, `gray`, `green`, `purple`, `red`, `stb` |
|
||||
| item_radarr_tag | Radarr Tag for existing items | | list of tag(s) to be applied to existing items |
|
||||
|
||||
The below shows an example config.yml with all of the template_variables set away from their defaults:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: producer
|
||||
template_variables:
|
||||
style: rainier
|
||||
sort_by: title.asc
|
||||
collection_section: 12
|
||||
collection_mode: show_items
|
||||
use_separator: false
|
||||
sep_style: purple
|
||||
```
|
||||
|
@ -0,0 +1,54 @@
|
||||
# Universe Language Default Metadata File
|
||||
|
||||
The `- pmm: universe` Metadata File is used to create collections based on popular Movie universes (such as the Marvel Cinematic Universe or Wizarding World)
|
||||
|
||||
This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html)
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
![](../images/universe.png)
|
||||
|
||||
The below YAML in your config.yml will create the actor collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: universe
|
||||
```
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
Below are the available variables which can be used to customize the file.
|
||||
|
||||
|
||||
| Variable | Usage | Default Value | Values |
|
||||
|:-------------------|:---------------------------------------------|---------------|:-------------------------------------------------------:|
|
||||
| collection_order | Sets the collection order of the collection | `alpha` | `release`, `alpha` or `custom` |
|
||||
| radarr_add_missing | Adds missing from the collection to radarr | `false` | `true` or `false` |
|
||||
| radarr_folder | Radarr Folder to add to | | Folder to add missing items to |
|
||||
| radarr_tag | Radarr Tag for added missing | | list of tag(s) to be applied to existing items |
|
||||
| item_radarr_tag | Radarr Tag for existing items | | list of tag(s) to be applied to existing items |
|
||||
| use_separator | Controls whether a separator is created | `true` | `true` or `false` |
|
||||
| sep_style | Sets the theme of the separator | `orig` | `orig`, `blue`, `gray`, `green`, `purple`, `red`, `stb` |
|
||||
|
||||
The below shows an example config.yml with all the template_variables set away from their defaults:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: universe
|
||||
template_variables:
|
||||
collection_order: release
|
||||
radarr_add_missing: true
|
||||
radarr_folder: /mnt/local/Media/TV
|
||||
radarr_tag: <<collection_name>>
|
||||
item_radarr_tag: <<collection_name>>
|
||||
use_separator: false
|
||||
sep_style: gray
|
||||
```
|
||||
|
@ -0,0 +1,56 @@
|
||||
# Writer Default Metadata File
|
||||
|
||||
The `- pmm: writer` Metadata File is used to dynamically create collections based on the most popular writers in your library.
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
![](images/writer1.png)
|
||||
|
||||
The below YAML in your config.yml will create the writer collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: writer
|
||||
```
|
||||
|
||||
## Rainier Style
|
||||
Below is a screenshot of the alternative `Rainier` style which can be set via template variables
|
||||
|
||||
![](images/writer2.png)
|
||||
|
||||
|
||||
## Template Variables
|
||||
Template Variables can be used to manipulate the writer 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.
|
||||
|
||||
Below are the available variables which can be used to customize the file.
|
||||
|
||||
|
||||
| Variable | Usage | Default Value | Values |
|
||||
|:-------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| style | Controls the visual theme of the collections created | `bw` | `bw` - Black and white theme or<br/>`rainier` - Rainier theme |
|
||||
| sort_by | Controls the sort method for the collections | `release.desc` | Any sort method in the [Sorts Options Table](#sort-options) |
|
||||
| collection_section | Controls the sort order of these collections against other default collections | `17` | Any number |
|
||||
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
|
||||
| use_separator | Controls whether a separator is created | `true` | `true` or `false` |
|
||||
| sep_style | Sets the theme of the separator | `orig` | `orig`, `blue`, `gray`, `green`, `purple`, `red`, `stb` |
|
||||
| item_radarr_tag | Radarr Tag for existing items | | list of tag(s) to be applied to existing items |
|
||||
|
||||
The below shows an example config.yml with all of the template_variables set away from their defaults:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: writer
|
||||
template_variables:
|
||||
style: rainier
|
||||
sort_by: title.asc
|
||||
collection_section: 12
|
||||
collection_mode: show_items
|
||||
use_separator: false
|
||||
sep_style: purple
|
||||
```
|
||||
|
@ -0,0 +1,51 @@
|
||||
# Decade Language Default Metadata File
|
||||
|
||||
The `- pmm: decade` Metadata File is used to dynamically create collections based on the decades available in your library, sorted by critic rating to create a "best of <decade>"
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
![](../images/decade.png)
|
||||
|
||||
The below YAML in your config.yml will create the actor collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: decade
|
||||
```
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
Below are the available variables which can be used to customize the file.
|
||||
|
||||
|
||||
| Variable | Usage | Default Value | Values |
|
||||
|:-------------------|:-----------------------------------------------------------------------------------------------------|------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| sort_by | Controls the sort method for the collections | `audience_rating.desc` | Any sort method in the [Sorts Options Table](#sort-options) |
|
||||
| collection_section | Controls the sort order of these collections against other default collections | `12` | Any number |
|
||||
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
|
||||
| use_other | Controls whether an "Other" collection is created for any items not included in the initial criteria | `true` | `true` or `false` |
|
||||
| use_separator | Controls whether a separator is created | `true` | `true` or `false` |
|
||||
| sep_style | Sets the theme of the separator | `orig` | `orig`, `blue`, `gray`, `green`, `purple`, `red`, `stb` |
|
||||
| item_sonarr_tag | Sonarr Tag for existing items | | list of tag(s) to be applied to existing items |
|
||||
|
||||
The below shows an example config.yml with all the template_variables set away from their defaults:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: decade
|
||||
template_variables:
|
||||
sort_by: title.asc
|
||||
collection_section: 18
|
||||
collection_mode: show_items
|
||||
use_other: false
|
||||
use_separator: false
|
||||
sep_style: purple
|
||||
```
|
||||
|
@ -0,0 +1,55 @@
|
||||
# Franchise Language Default Metadata File
|
||||
|
||||
The `- pmm: franchise` Metadata File is used to create collections based on popular TV franchises
|
||||
|
||||
Unlike most Default Metadata Files, Franchise works by placing collections inline with the main library items if your library allows it. For example, the "Pretty Little Liars" franchise collection will appear next to the "Pretty Little Liars" show in your library so that you have easy access to the other shows in the franchise.
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
![](../images/showfranchise.png)
|
||||
|
||||
The below YAML in your config.yml will create the actor collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: franchise
|
||||
```
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
Below are the available variables which can be used to customize the file.
|
||||
|
||||
|
||||
| Variable | Usage | Default Value | Values |
|
||||
|:-------------------|:-------------------------------------------------------------------------------|---------------|:----------------------------------------------:|
|
||||
| collection_order | Sets the collection order of the collection | `release` | `release`, `alpha` or `custom` |
|
||||
| sort_title | Sets the sort title | | Desired sort title |
|
||||
| minimum_items | Sets the minimum items of the collection | `2` | Any number |
|
||||
| build_collection | Sets weather to actually build the collection | `true` | `true` or `false` |
|
||||
| sonarr_add_missing | Adds missing from the collection to sonarr | `false` | `true` or `false` |
|
||||
| sonarr_folder | Sonarr Folder to add to | | Folder to add missing items to |
|
||||
| sonarr_tag | Sonarr Tag for added missing | | list of tag(s) to be applied to existing items |
|
||||
| item_sonarr_tag | Sonarr Tag for existing items | | list of tag(s) to be applied to existing items |
|
||||
|
||||
The below shows an example config.yml with all the template_variables set away from their defaults:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: franchise
|
||||
template_variables:
|
||||
collection_order: alpha
|
||||
sort_title: "!10_<<collection_name>>"
|
||||
build_collection: false
|
||||
sonarr_add_missing: true
|
||||
sonarr_folder: /mnt/local/Media/TV
|
||||
sonarr_tag: <<collection_name>>
|
||||
item_sonarr_tag: <<collection_name>>
|
||||
```
|
||||
|
@ -0,0 +1,51 @@
|
||||
# Network Language Default Metadata File
|
||||
|
||||
The `- pmm: network` Metadata File is used to dynamically create collections based on the counties available in your library.
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
![](../images/network.png)
|
||||
|
||||
The below YAML in your config.yml will create the actor collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: network
|
||||
```
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
Below are the available variables which can be used to customize the file.
|
||||
|
||||
|
||||
| Variable | Usage | Default Value | Values |
|
||||
|:-------------------|:-----------------------------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| sort_by | Controls the sort method for the collections | `release.desc` | Any sort method in the [Sorts Options Table](#sort-options) |
|
||||
| collection_section | Controls the sort order of these collections against other default collections | `04` | Any number |
|
||||
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
|
||||
| use_other | Controls whether an "Other" collection is created for any items not included in the initial criteria | `true` | `true` or `false` |
|
||||
| use_separator | Controls whether a separator is created | `true` | `true` or `false` |
|
||||
| sep_style | Sets the theme of the separator | `orig` | `orig`, `blue`, `gray`, `green`, `purple`, `red`, `stb` |
|
||||
| item_sonarr_tag | Sonarr Tag for existing items | | list of tag(s) to be applied to existing items |
|
||||
|
||||
The below shows an example config.yml with all the template_variables set away from their defaults:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: network
|
||||
template_variables:
|
||||
sort_by: title.asc
|
||||
collection_section: 07
|
||||
collection_mode: show_items
|
||||
use_other: false
|
||||
use_separator: false
|
||||
sep_style: stb
|
||||
```
|
||||
|
Loading…
Reference in new issue