Merge pull request #1062 from YozoraXCII/defaults
Add default wiki pages for award and chart filespull/1064/head
meisnate12
2 years ago
committed by
GitHub
commit
a823b7f0be
@ -0,0 +1,55 @@
|
||||
# Cannes Default Metadata File
|
||||
|
||||
The `- pmm: award/cannes` Metadata File is used to create collections based on the Cannes Film Awards.
|
||||
|
||||
This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html)
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: award/cannes
|
||||
```
|
||||
|
||||
|
||||
## 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 |
|
||||
|:---------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| use_year_collections | Turn the individual year collections on/off | `true` | `true` or `false` |
|
||||
| collection_section | Controls the sort order of these collections against other default collections | `16` | 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 |
|
||||
| collection_order | Sets the collection order of the collection | `custom` | `alpha`, `release` 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 missing 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: award/cannes
|
||||
template_variables:
|
||||
collection_section: 9
|
||||
collection_mode: show_items
|
||||
collection_order: alpha
|
||||
radarr_add_missing: true
|
||||
radarr_folder: /mnt/local/Media/Movies
|
||||
radarr_tag: <<collection_name>>
|
||||
item_radarr_tag: <<collection_name>>
|
||||
```
|
||||
|
||||
@ -0,0 +1,64 @@
|
||||
# choice Default Metadata File
|
||||
|
||||
The `- pmm: award/choice` Metadata File is used to create collections based on the Critics Choice Awards.
|
||||
|
||||
This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html)
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: award/choice
|
||||
```
|
||||
|
||||
|
||||
## 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 |
|
||||
|:---------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| use_year_collections | Turn the individual year collections on/off | `true` | `true` or `false` |
|
||||
| collection_section | Controls the sort order of these collections against other default collections | `16` | 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 |
|
||||
| collection_order | Sets the collection order of the collection | `custom` | `alpha`, `release` 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 missing items |
|
||||
| item_radarr_tag | Radarr Tag for existing items | | list of tag(s) to be applied to existing items |
|
||||
| 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 |
|
||||
| sonrr_tag | Sonarr Tag for added missing | | list of tag(s) to be applied to missing 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: award/choice
|
||||
template_variables:
|
||||
collection_section: 9
|
||||
collection_mode: show_items
|
||||
collection_order: alpha
|
||||
radarr_add_missing: true
|
||||
radarr_folder: /mnt/local/Media/Movies
|
||||
radarr_tag: <<collection_name>>
|
||||
item_radarr_tag: <<collection_name>>
|
||||
sonarr_add_missing: true
|
||||
sonarr_folder: /mnt/local/Media/TV
|
||||
sonarr_tag: <<collection_name>>
|
||||
item_sonarr_tag: <<collection_name>>
|
||||
```
|
||||
|
||||
@ -0,0 +1,64 @@
|
||||
# Emmys Default Metadata File
|
||||
|
||||
The `- pmm: award/emmy` Metadata File is used to create collections based on the Emmy Awards.
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: award/emmy
|
||||
```
|
||||
|
||||
|
||||
## 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 |
|
||||
|:---------------------|:-------------------------------------------------------------------------------|--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| use_year_collections | Turn the individual year collections on/off | `true` | `true` or `false` |0
|
||||
| imdb_sort | Sets the sort of the IMDb Search | `moviemeter,desc ` | Any IMDb Search Sort Option |0
|
||||
| collection_section | Controls the sort order of these collections against other default collections | `16` | 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 |
|
||||
| collection_order | Sets the collection order of the collection | `custom` | `alpha`, `release` 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 missing items |
|
||||
| item_radarr_tag | Radarr Tag for existing items | | list of tag(s) to be applied to existing items |
|
||||
| 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 |
|
||||
| sonrr_tag | Sonarr Tag for added missing | | list of tag(s) to be applied to missing 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: award/emmy
|
||||
template_variables:
|
||||
collection_section: 9
|
||||
collection_mode: show_items
|
||||
collection_order: alpha
|
||||
imdb_sort: moviemeter,asc
|
||||
radarr_add_missing: true
|
||||
radarr_folder: /mnt/local/Media/Movies
|
||||
radarr_tag: <<collection_name>>
|
||||
item_radarr_tag: <<collection_name>>
|
||||
sonarr_add_missing: true
|
||||
sonarr_folder: /mnt/local/Media/TV
|
||||
sonarr_tag: <<collection_name>>
|
||||
item_sonarr_tag: <<collection_name>>
|
||||
```
|
||||
|
||||
@ -0,0 +1,64 @@
|
||||
# Golden Globes Default Metadata File
|
||||
|
||||
The `- pmm: award/golden` Metadata File is used to create collections based on the Golden Globe Awards.
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: award/golden
|
||||
```
|
||||
|
||||
|
||||
## 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 |
|
||||
|:---------------------|:-------------------------------------------------------------------------------|--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| use_year_collections | Turn the individual year collections on/off | `true` | `true` or `false` |0
|
||||
| imdb_sort | Sets the sort of the IMDb Search | `moviemeter,desc ` | Any IMDb Search Sort Option |0
|
||||
| collection_section | Controls the sort order of these collections against other default collections | `16` | 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 |
|
||||
| collection_order | Sets the collection order of the collection | `custom` | `alpha`, `release` 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 missing items |
|
||||
| item_radarr_tag | Radarr Tag for existing items | | list of tag(s) to be applied to existing items |
|
||||
| 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 |
|
||||
| sonrr_tag | Sonarr Tag for added missing | | list of tag(s) to be applied to missing 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: award/golden
|
||||
template_variables:
|
||||
collection_section: 9
|
||||
collection_mode: show_items
|
||||
collection_order: alpha
|
||||
imdb_sort: moviemeter,asc
|
||||
radarr_add_missing: true
|
||||
radarr_folder: /mnt/local/Media/Movies
|
||||
radarr_tag: <<collection_name>>
|
||||
item_radarr_tag: <<collection_name>>
|
||||
sonarr_add_missing: true
|
||||
sonarr_folder: /mnt/local/Media/TV
|
||||
sonarr_tag: <<collection_name>>
|
||||
item_sonarr_tag: <<collection_name>>
|
||||
```
|
||||
|
||||
@ -0,0 +1,55 @@
|
||||
# Oscars Default Metadata File
|
||||
|
||||
The `- pmm: award/oscars` Metadata File is used to create collections based on the Oscars Awards.
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: award/oscars
|
||||
```
|
||||
|
||||
|
||||
## 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 |
|
||||
|:---------------------|:-------------------------------------------------------------------------------|--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| use_year_collections | Turn the individual year collections on/off | `true` | `true` or `false` |0
|
||||
| imdb_sort | Sets the sort of the IMDb Search | `moviemeter,desc ` | Any IMDb Search Sort Option |0
|
||||
| collection_section | Controls the sort order of these collections against other default collections | `16` | 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 |
|
||||
| collection_order | Sets the collection order of the collection | `custom` | `alpha`, `release` 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 missing 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: award/oscars
|
||||
template_variables:
|
||||
collection_section: 9
|
||||
collection_mode: show_items
|
||||
collection_order: alpha
|
||||
imdb_sort: moviemeter,asc
|
||||
radarr_add_missing: true
|
||||
radarr_folder: /mnt/local/Media/Movies
|
||||
radarr_tag: <<collection_name>>
|
||||
item_radarr_tag: <<collection_name>>
|
||||
```
|
||||
|
||||
@ -0,0 +1,54 @@
|
||||
# Other Awards Default Metadata File
|
||||
|
||||
The `- pmm: award/other` Metadata File is used to create collections based on numerous other awards.
|
||||
|
||||
This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html)
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: award/other
|
||||
```
|
||||
|
||||
|
||||
## 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_section | Controls the sort order of these collections against other default collections | `16` | 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 |
|
||||
| collection_order | Sets the collection order of the collection | `custom` | `alpha`, `release` 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 missing 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: award/other
|
||||
template_variables:
|
||||
collection_section: 9
|
||||
collection_mode: show_items
|
||||
collection_order: alpha
|
||||
radarr_add_missing: true
|
||||
radarr_folder: /mnt/local/Media/Movies
|
||||
radarr_tag: <<collection_name>>
|
||||
item_radarr_tag: <<collection_name>>
|
||||
```
|
||||
|
||||
@ -0,0 +1,55 @@
|
||||
# Independent Spirit Awards Default Metadata File
|
||||
|
||||
The `- pmm: award/spirit` Metadata File is used to create collections based on the Independent Spirit Awards.
|
||||
|
||||
This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html)
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: award/spirit
|
||||
```
|
||||
|
||||
|
||||
## 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 |
|
||||
|:---------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| use_year_collections | Turn the individual year collections on/off | `true` | `true` or `false` |
|
||||
| collection_section | Controls the sort order of these collections against other default collections | `16` | 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 |
|
||||
| collection_order | Sets the collection order of the collection | `custom` | `alpha`, `release` 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 missing 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: award/spirit
|
||||
template_variables:
|
||||
collection_section: 9
|
||||
collection_mode: show_items
|
||||
collection_order: alpha
|
||||
radarr_add_missing: true
|
||||
radarr_folder: /mnt/local/Media/Movies
|
||||
radarr_tag: <<collection_name>>
|
||||
item_radarr_tag: <<collection_name>>
|
||||
```
|
||||
|
||||
@ -0,0 +1,55 @@
|
||||
# Sundance Film Festival Awards Default Metadata File
|
||||
|
||||
The `- pmm: award/sundance` Metadata File is used to create collections based on the Sundance Film Festival Awards.
|
||||
|
||||
This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html)
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: award/sundance
|
||||
```
|
||||
|
||||
|
||||
## 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 |
|
||||
|:---------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| use_year_collections | Turn the individual year collections on/off | `true` | `true` or `false` |
|
||||
| collection_section | Controls the sort order of these collections against other default collections | `16` | 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 |
|
||||
| collection_order | Sets the collection order of the collection | `custom` | `alpha`, `release` 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 missing 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: award/sundance
|
||||
template_variables:
|
||||
collection_section: 9
|
||||
collection_mode: show_items
|
||||
collection_order: alpha
|
||||
radarr_add_missing: true
|
||||
radarr_folder: /mnt/local/Media/Movies
|
||||
radarr_tag: <<collection_name>>
|
||||
item_radarr_tag: <<collection_name>>
|
||||
```
|
||||
|
||||
@ -0,0 +1,122 @@
|
||||
# Genre Default Metadata File
|
||||
|
||||
The `- pmm: 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:
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
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 | `10` | 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 |
|
||||
| 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: genre
|
||||
template_variables:
|
||||
sort_by: title.asc
|
||||
collection_section: 5
|
||||
collection_mode: show_items
|
||||
use_separator: false
|
||||
sep_style: red
|
||||
```
|
||||
|
||||
# UK Content Rating Default Metadata File
|
||||
|
||||
The `- pmm: content_rating_uk` 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:
|
||||
|
||||
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: content_rating_uk
|
||||
```
|
||||
|
||||
|
||||
## 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 | `10` | 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 |
|
||||
| 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: content_rating_uk
|
||||
template_variables:
|
||||
sort_by: title.asc
|
||||
collection_section: 21
|
||||
collection_mode: show_items
|
||||
use_other: false
|
||||
use_separator: false
|
||||
sep_style: blue
|
||||
```
|
||||
|
||||
Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `genre` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/both/genre.yml)
|
||||
|
||||
An example of this is; to map the "Children" genre to "Family", the following template variable can be used:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: genre
|
||||
template_variables:
|
||||
addons:
|
||||
Family:
|
||||
- Children
|
||||
```
|
||||
|
||||
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)
|
||||
@ -0,0 +1,85 @@
|
||||
# Anilist Chart Default Metadata File
|
||||
|
||||
The `- pmm: chart/anilist` Metadata File is used to create collections based on Anilist charts
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: chart/anilist
|
||||
```
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
As this file is more complex than others, a key system is used to control each collection that is created by the file. Each key refers to one Anilist chart and is used to control multiple template variables.
|
||||
|
||||
Below are the keys and what they refer to:
|
||||
|
||||
| Key | Anilist Chart |
|
||||
|:----------|:------------------|
|
||||
| popular | AniList Popular |
|
||||
| season | AniList Season |
|
||||
| top | AniList Top Rated |
|
||||
| trending | AniList Trending |
|
||||
|
||||
|
||||
|
||||
Below are the available variables which can be used to customize the file. Note that any use of `key` within the variable should be replaced with the `key` from the above table (i.e. `use_top` instead of `use_key`, `order_popular` instead of `order_key`)
|
||||
|
||||
|
||||
| Variable | Usage | Default Value | Values |
|
||||
|:-----------------------|:-------------------------------------------------------------------------------|--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| use_key | Turn the collection on/off | `true` | `true` or `false` |
|
||||
| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_popular` to put popular first in the list of anilist charts) |
|
||||
| summary_key | Determines summary of collection | | Any summary text |
|
||||
| limit_key | Determines limit of collection | `100` | Any number |
|
||||
| collection_order_key | Determines collection order of the collection | | |
|
||||
| visible_library_key | Set visible_library for the collection | `false` | `true` or `false` |
|
||||
| visible_home_key | Set visible_home for the collection | `false` | `true` or `false` |
|
||||
| visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` |
|
||||
| sonarr_add_missing_key | Adds missing from the collection to sonarr | `false` | `true` or `false` |
|
||||
| sonarr_folder_key | Sonarr Folder to add to | | Folder to add missing items to |
|
||||
| sonarr_tag_key | Sonarr Tag for added missing | | Tag(s) to add to missing items |
|
||||
| item_sonarr_tag_key | Sonarr Tag for existing items | `false` | Tag(s) to add to existing items |
|
||||
| radarr_add_missing_key | Adds missing from the collection to radarr | | `true` or `false` |
|
||||
| radarr_folder_key | Radarr Folder to add to | | Folder to add missing items to |
|
||||
| radarr_tag_key | Radarr Tag for added missing | | Tag(s) to add to missing items |
|
||||
| item_radarr_tag_key | Radarr Tag for existing items | | Tag(s) to add to existing items |
|
||||
| collection_section | Controls the sort order of these collections against other default collections | `01` | 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 |
|
||||
|
||||
The below shows an example config.yml with all the template_variables set away from their defaults:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: anilist
|
||||
template_variables:
|
||||
use_top: false
|
||||
order_top: 01
|
||||
summary_top: "Top 10 Rated movies on AniList"
|
||||
limit_top: 10
|
||||
visible_library_popular: true
|
||||
visible_home_popular: true
|
||||
visible_shared_popular: true
|
||||
sonarr_add_missing_trending: true
|
||||
sonarr_folder_trending: /mnt/local/Media/TV/
|
||||
sonarr_tag_trending: trending Shows
|
||||
item_sonarr_tag_trending: trending Shows
|
||||
radarr_add_missing_season: true
|
||||
sonarr_folder_season: /mnt/local/Media/TV/Prime Video Shows/
|
||||
sonarr_tag_season: Prime Video Shows
|
||||
item_sonarr_tag_season: Prime Video Shows
|
||||
collection_section: 09
|
||||
collection_mode: show_items
|
||||
```
|
||||
@ -0,0 +1,71 @@
|
||||
# Basic Chart Default Metadata File
|
||||
|
||||
The `- pmm: chart/basic` Metadata File is used to create collections based on recently released media in your library.
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: chart/basic
|
||||
```
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
As this file is more complex than others, a key system is used to control each collection that is created by the file. Each key refers to one chart and is used to control multiple template variables.
|
||||
|
||||
Below are the keys and what they refer to:
|
||||
|
||||
| Key | Chart |
|
||||
|:---------|:---------------|
|
||||
| released | Newly Released |
|
||||
| episodes | New Episodes |
|
||||
|
||||
|
||||
|
||||
Below are the available variables which can be used to customize the file. Note that any use of `key` within the variable should be replaced with the `key` from the above table (i.e. `use_episodes` instead of `use_key`, `order_released` instead of `order_key`)
|
||||
|
||||
|
||||
| Variable | Usage | Default Value | Values |
|
||||
|:-----------------------|:-------------------------------------------------------------------------------|--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| use_key | Turn the collection on/off | `true` | `true` or `false` |
|
||||
| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_released` to put released first in the list of charts) |
|
||||
| summary_key | Determines summary of collection | | Any summary text |
|
||||
| limit_key | Determines limit of collection | `100` | Any number |
|
||||
| collection_order_key | Determines collection order of the collection | | |
|
||||
| visible_library_key | Set visible_library for the collection | `false` | `true` or `false` |
|
||||
| visible_home_key | Set visible_home for the collection | `false` | `true` or `false` |
|
||||
| visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` |
|
||||
| item_sonarr_tag_key | Sonarr Tag for existing items | `false` | Tag(s) to add to existing items |
|
||||
| item_radarr_tag_key | Radarr Tag for existing items | | Tag(s) to add to existing items |
|
||||
| collection_section | Controls the sort order of these collections against other default collections | `01` | 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 |
|
||||
|
||||
The below shows an example config.yml with all the template_variables set away from their defaults:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: basic
|
||||
template_variables:
|
||||
use_released: false
|
||||
order_released: 01
|
||||
summary_released: "Newly Released items"
|
||||
limit_released: 10
|
||||
visible_library_released: true
|
||||
visible_home_released: true
|
||||
visible_shared_released: true
|
||||
item_sonarr_tag_released: New Episodes
|
||||
item_radarr_tag_season: Newly Released
|
||||
collection_section: 09
|
||||
collection_mode: show_items
|
||||
```
|
||||
@ -0,0 +1,78 @@
|
||||
# IMDb Chart Default Metadata File
|
||||
|
||||
The `- pmm: chart/imdb` Metadata File is used to create collections based on IMDb Charts.
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: chart/imdb
|
||||
```
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
As this file is more complex than others, a key system is used to control each collection that is created by the file. Each key refers to one imdb chart and is used to control multiple template variables.
|
||||
|
||||
Below are the keys and what they refer to:
|
||||
|
||||
| Key | Chart |
|
||||
|:--------|:------------------|
|
||||
| popular | IMDb Popular |
|
||||
| top | IMDb Top 250 |
|
||||
| lowest | IMDb Lowest Rated |
|
||||
|
||||
|
||||
|
||||
Below are the available variables which can be used to customize the file. Note that any use of `key` within the variable should be replaced with the `key` from the above table (i.e. `use_top` instead of `use_key`, `order_popular` instead of `order_key`)
|
||||
|
||||
|
||||
| Variable | Usage | Default Value | Values |
|
||||
|:-----------------------|:-------------------------------------------------------------------------------|--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| use_key | Turn the collection on/off | `true` | `true` or `false` |
|
||||
| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_popular` to put popular first in the list of imdb charts) |
|
||||
| summary_key | Determines summary of collection | | Any summary text |
|
||||
| limit_key | Determines limit of collection | `100` | Any number |
|
||||
| collection_order_key | Determines collection order of the collection | | |
|
||||
| visible_library_key | Set visible_library for the collection | `false` | `true` or `false` |
|
||||
| visible_home_key | Set visible_home for the collection | `false` | `true` or `false` |
|
||||
| visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` |
|
||||
| sonarr_add_missing_key | Adds missing from the collection to sonarr | `false` | `true` or `false` |
|
||||
| sonarr_folder_key | Sonarr Folder to add to | | Folder to add missing items to |
|
||||
| sonarr_tag_key | Sonarr Tag for added missing | | Tag(s) to add to missing items |
|
||||
| item_sonarr_tag_key | Sonarr Tag for existing items | `false` | Tag(s) to add to existing items |
|
||||
| radarr_add_missing_key | Adds missing from the collection to radarr | | `true` or `false` |
|
||||
| radarr_folder_key | Radarr Folder to add to | | Folder to add missing items to |
|
||||
| radarr_tag_key | Radarr Tag for added missing | | Tag(s) to add to missing items |
|
||||
| item_radarr_tag_key | Radarr Tag for existing items | | Tag(s) to add to existing items |
|
||||
| collection_section | Controls the sort order of these collections against other default collections | `01` | 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 |
|
||||
|
||||
The below shows an example config.yml with all the template_variables set away from their defaults:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: imdb
|
||||
template_variables:
|
||||
use_popular: false
|
||||
order_popular: 01
|
||||
summary_popular: "Popular movies on IMDb right now"
|
||||
limit_popular: 10
|
||||
visible_library_popular: true
|
||||
visible_home_popular: true
|
||||
visible_shared_popular: true
|
||||
item_sonarr_tag_popular: New Episodes
|
||||
item_radarr_tag_season: Newly popular
|
||||
collection_section: 09
|
||||
collection_mode: show_items
|
||||
```
|
||||
@ -0,0 +1,80 @@
|
||||
# MyAnimeList Chart Default Metadata File
|
||||
|
||||
The `- pmm: chart/myanimelist` Metadata File is used to create collections based on MyAnimeList Charts.
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: chart/myanimelist
|
||||
```
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
As this file is more complex than others, a key system is used to control each collection that is created by the file. Each key refers to one MyAnimeList chart and is used to control multiple template variables.
|
||||
|
||||
Below are the keys and what they refer to:
|
||||
|
||||
| Key | Chart |
|
||||
|:----------|:-----------------------|
|
||||
| airing | MyAnimeList Top Airing |
|
||||
| favorited | MyAnimeList Favorited |
|
||||
| popular | MyAnimeList Popular |
|
||||
| season | MyAnimeList Season |
|
||||
| top | MyAnimeList Top Rated |
|
||||
|
||||
|
||||
|
||||
Below are the available variables which can be used to customize the file. Note that any use of `key` within the variable should be replaced with the `key` from the above table (i.e. `use_season` instead of `use_key`, `order_popular` instead of `order_key`)
|
||||
|
||||
|
||||
| Variable | Usage | Default Value | Values |
|
||||
|:-----------------------|:-------------------------------------------------------------------------------|--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| use_key | Turn the collection on/off | `true` | `true` or `false` |
|
||||
| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_popular` to put popular first in the list of myanimelist charts) |
|
||||
| summary_key | Determines summary of collection | | Any summary text |
|
||||
| limit_key | Determines limit of collection | `100` | Any number |
|
||||
| collection_order_key | Determines collection order of the collection | | |
|
||||
| visible_library_key | Set visible_library for the collection | `false` | `true` or `false` |
|
||||
| visible_home_key | Set visible_home for the collection | `false` | `true` or `false` |
|
||||
| visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` |
|
||||
| sonarr_add_missing_key | Adds missing from the collection to sonarr | `false` | `true` or `false` |
|
||||
| sonarr_folder_key | Sonarr Folder to add to | | Folder to add missing items to |
|
||||
| sonarr_tag_key | Sonarr Tag for added missing | | Tag(s) to add to missing items |
|
||||
| item_sonarr_tag_key | Sonarr Tag for existing items | `false` | Tag(s) to add to existing items |
|
||||
| radarr_add_missing_key | Adds missing from the collection to radarr | | `true` or `false` |
|
||||
| radarr_folder_key | Radarr Folder to add to | | Folder to add missing items to |
|
||||
| radarr_tag_key | Radarr Tag for added missing | | Tag(s) to add to missing items |
|
||||
| item_radarr_tag_key | Radarr Tag for existing items | | Tag(s) to add to existing items |
|
||||
| collection_section | Controls the sort order of these collections against other default collections | `01` | 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 |
|
||||
|
||||
The below shows an example config.yml with all the template_variables set away from their defaults:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: myanimelist
|
||||
template_variables:
|
||||
use_popular: false
|
||||
order_popular: 01
|
||||
summary_popular: "Popular movies on myanimelist right now"
|
||||
limit_popular: 10
|
||||
visible_library_popular: true
|
||||
visible_home_popular: true
|
||||
visible_shared_popular: true
|
||||
item_sonarr_tag_popular: New Episodes
|
||||
item_radarr_tag_season: Newly popular
|
||||
collection_section: 09
|
||||
collection_mode: show_items
|
||||
```
|
||||
@ -0,0 +1,74 @@
|
||||
# Other Chart Default Metadata File
|
||||
|
||||
The `- pmm: chart/other` Metadata File is used to create collections based on other Charts.
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: chart/other
|
||||
```
|
||||
|
||||
## 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.
|
||||
|
||||
As this file is more complex than others, a key system is used to control each collection that is created by the file. Each key refers to one chart and is used to control multiple template variables.
|
||||
|
||||
Below are the keys and what they refer to:
|
||||
|
||||
| Key | Chart |
|
||||
|:------------|:--------------------------|
|
||||
| anidb | AniDB Popular |
|
||||
| commonsense | Common Sense Selection |
|
||||
| stevenlu | StevenLu's Popular Movies |
|
||||
| pirated | Top 10 Pirated Movies |
|
||||
|
||||
Below are the available variables which can be used to customize the file. Note that any use of `key` within the variable should be replaced with the `key` from the above table (i.e. `use_commonsense` instead of `use_key`, `order_anidb` instead of `order_key`)
|
||||
|
||||
|
||||
| Variable | Usage | Default Value | Values |
|
||||
|:-----------------------|:-------------------------------------------------------------------------------|--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| use_key | Turn the collection on/off | `true` | `true` or `false` |
|
||||
| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_commonsense` to put commonsense first in the list of other charts) |
|
||||
| summary_key | Determines summary of collection | | Any summary text |
|
||||
| collection_order_key | Determines collection order of the collection | | |
|
||||
| visible_library_key | Set visible_library for the collection | `false` | `true` or `false` |
|
||||
| visible_home_key | Set visible_home for the collection | `false` | `true` or `false` |
|
||||
| visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` |
|
||||
| sonarr_add_missing_key | Adds missing from the collection to sonarr | `false` | `true` or `false` |
|
||||
| sonarr_folder_key | Sonarr Folder to add to | | Folder to add missing items to |
|
||||
| sonarr_tag_key | Sonarr Tag for added missing | | Tag(s) to add to missing items |
|
||||
| item_sonarr_tag_key | Sonarr Tag for existing items | `false` | Tag(s) to add to existing items |
|
||||
| radarr_add_missing_key | Adds missing from the collection to radarr | | `true` or `false` |
|
||||
| radarr_folder_key | Radarr Folder to add to | | Folder to add missing items to |
|
||||
| radarr_tag_key | Radarr Tag for added missing | | Tag(s) to add to missing items |
|
||||
| item_radarr_tag_key | Radarr Tag for existing items | | Tag(s) to add to existing items |
|
||||
| collection_section | Controls the sort order of these collections against other default collections | `01` | 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 |
|
||||
|
||||
The below shows an example config.yml with all the template_variables set away from their defaults:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: other
|
||||
template_variables:
|
||||
use_commonsense: false
|
||||
order_commonsense: 01
|
||||
summary_commonsense: "Common Sense Selection"
|
||||
visible_library_commonsense: true
|
||||
visible_home_commonsense: true
|
||||
visible_shared_commonsense: true
|
||||
item_sonarr_tag_commonsense: New Episodes
|
||||
item_radarr_tag_season: Newly commonsense
|
||||
collection_section: 09
|
||||
collection_mode: show_items
|
||||
```
|
||||
@ -0,0 +1,72 @@
|
||||
# Tautulli Chart Default Metadata File
|
||||
|
||||
The `- pmm: chart/tautulli` Metadata File is used to create collections based on Tautulli/Plex Charts.
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: chart/tautulli
|
||||
```
|
||||
|
||||
## 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.
|
||||
|
||||
As this file is more complex than tautullis, a key system is used to control each collection that is created by the file. Each key refers to one chart and is used to control multiple template variables.
|
||||
|
||||
Below are the keys and what they refer to:
|
||||
|
||||
| Key | Chart |
|
||||
|:---------|:-------------|
|
||||
| popular | Plex Popular |
|
||||
| watched | Plex Watched |
|
||||
|
||||
|
||||
Below are the available variables which can be used to customize the file. Note that any use of `key` within the variable should be replaced with the `key` from the above table (i.e. `use_watched` instead of `use_key`, `order_watched` instead of `order_key`)
|
||||
|
||||
|
||||
| Variable | Usage | Default Value | Values |
|
||||
|:-----------------------|:----------------------------------------------------------------------------------|--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| use_key | Turn the collection on/off | `true` | `true` or `false` |
|
||||
| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_watched` to put watched first in the list of tautulli charts) |
|
||||
| summary_key | Determines summary of collection | | Any summary text |
|
||||
| limit_key | Determines limit of collection | `100` | Any number |
|
||||
| list_days_key | Set list_days for the collection | `30` | Any number |
|
||||
| list_size_key | Set list_size for the collection | `20` | Any number |
|
||||
| collection_order_key | Determines collection order of the collection | | |
|
||||
| visible_library_key | Set visible_library for the collection | `false` | `true` or `false` |
|
||||
| visible_home_key | Set visible_home for the collection | `false` | `true` or `false` |
|
||||
| visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` |
|
||||
| item_sonarr_tag_key | Sonarr Tag for existing items | `false` | Tag(s) to add to existing items |
|
||||
| item_radarr_tag_key | Radarr Tag for existing items | | Tag(s) to add to existing items |
|
||||
| collection_section | Controls the sort order of these collections against tautulli default collections | `01` | 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 |
|
||||
|
||||
The below shows an example config.yml with all the template_variables set away from their defaults:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: tautulli
|
||||
template_variables:
|
||||
use_watched: false
|
||||
order_watched: 01
|
||||
summary_watched: "Things that have been watched on Plex in the past 7 days"
|
||||
list_days_watched: 7
|
||||
list_size_watched: 10
|
||||
visible_library_watched: true
|
||||
visible_home_watched: true
|
||||
visible_shared_watched: true
|
||||
item_sonarr_tag_watched: Plex Watched
|
||||
item_radarr_tag_season: Plex Watched
|
||||
collection_section: 09
|
||||
collection_mode: show_items
|
||||
```
|
||||
@ -0,0 +1,80 @@
|
||||
# TMDb Chart Default Metadata File
|
||||
|
||||
The `- pmm: chart/tmdb` Metadata File is used to create collections based on TMDb Charts.
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: chart/tmdb
|
||||
```
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
As this file is more complex than others, a key system is used to control each collection that is created by the file. Each key refers to one tmdb chart and is used to control multiple template variables.
|
||||
|
||||
Below are the keys and what they refer to:
|
||||
|
||||
| Key | Chart |
|
||||
|:---------|:------------------|
|
||||
| air | TMDb On The Air |
|
||||
| airing | TMDb Airing Today |
|
||||
| popular | TMDb Popular |
|
||||
| top | TMDb Top Rated |
|
||||
| trending | TMDb Trending |
|
||||
|
||||
|
||||
|
||||
Below are the available variables which can be used to customize the file. Note that any use of `key` within the variable should be replaced with the `key` from the above table (i.e. `use_top` instead of `use_key`, `order_popular` instead of `order_key`)
|
||||
|
||||
|
||||
| Variable | Usage | Default Value | Values |
|
||||
|:-----------------------|:-------------------------------------------------------------------------------|--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| use_key | Turn the collection on/off | `true` | `true` or `false` |
|
||||
| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_popular` to put popular first in the list of tmdb charts) |
|
||||
| summary_key | Determines summary of collection | | Any summary text |
|
||||
| limit_key | Determines limit of collection | `100` | Any number |
|
||||
| collection_order_key | Determines collection order of the collection | | |
|
||||
| visible_library_key | Set visible_library for the collection | `false` | `true` or `false` |
|
||||
| visible_home_key | Set visible_home for the collection | `false` | `true` or `false` |
|
||||
| visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` |
|
||||
| sonarr_add_missing_key | Adds missing from the collection to sonarr | `false` | `true` or `false` |
|
||||
| sonarr_folder_key | Sonarr Folder to add to | | Folder to add missing items to |
|
||||
| sonarr_tag_key | Sonarr Tag for added missing | | Tag(s) to add to missing items |
|
||||
| item_sonarr_tag_key | Sonarr Tag for existing items | `false` | Tag(s) to add to existing items |
|
||||
| radarr_add_missing_key | Adds missing from the collection to radarr | | `true` or `false` |
|
||||
| radarr_folder_key | Radarr Folder to add to | | Folder to add missing items to |
|
||||
| radarr_tag_key | Radarr Tag for added missing | | Tag(s) to add to missing items |
|
||||
| item_radarr_tag_key | Radarr Tag for existing items | | Tag(s) to add to existing items |
|
||||
| collection_section | Controls the sort order of these collections against other default collections | `01` | 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 |
|
||||
|
||||
The below shows an example config.yml with all the template_variables set away from their defaults:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: tmdb
|
||||
template_variables:
|
||||
use_popular: false
|
||||
order_popular: 01
|
||||
summary_popular: "Popular movies on TMDb right now"
|
||||
limit_popular: 10
|
||||
visible_library_popular: true
|
||||
visible_home_popular: true
|
||||
visible_shared_popular: true
|
||||
item_sonarr_tag_popular: New Episodes
|
||||
item_radarr_tag_season: Newly popular
|
||||
collection_section: 09
|
||||
collection_mode: show_items
|
||||
```
|
||||
@ -0,0 +1,80 @@
|
||||
# Trakt Chart Default Metadata File
|
||||
|
||||
The `- pmm: chart/trakt` Metadata File is used to create collections based on Trakt Charts.
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: chart/trakt
|
||||
```
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
As this file is more complex than others, a key system is used to control each collection that is created by the file. Each key refers to one trakt chart and is used to control multiple template variables.
|
||||
|
||||
Below are the keys and what they refer to:
|
||||
|
||||
| Key | Chart |
|
||||
|:------------|:------------------|
|
||||
| collected | Trakt Collected |
|
||||
| popular | Trakt Popular |
|
||||
| recommended | Trakt Recommended |
|
||||
| trending | Trakt Trending |
|
||||
| watched | Trakt Watched |
|
||||
|
||||
|
||||
|
||||
Below are the available variables which can be used to customize the file. Note that any use of `key` within the variable should be replaced with the `key` from the above table (i.e. `use_watched` instead of `use_key`, `order_popular` instead of `order_key`)
|
||||
|
||||
|
||||
| Variable | Usage | Default Value | Values |
|
||||
|:-----------------------|:-------------------------------------------------------------------------------|--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| use_key | Turn the collection on/off | `true` | `true` or `false` |
|
||||
| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_popular` to put popular first in the list of trakt charts) |
|
||||
| summary_key | Determines summary of collection | | Any summary text |
|
||||
| limit_key | Determines limit of collection | `100` | Any number |
|
||||
| collection_order_key | Determines collection order of the collection | | |
|
||||
| visible_library_key | Set visible_library for the collection | `false` | `true` or `false` |
|
||||
| visible_home_key | Set visible_home for the collection | `false` | `true` or `false` |
|
||||
| visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` |
|
||||
| sonarr_add_missing_key | Adds missing from the collection to sonarr | `false` | `true` or `false` |
|
||||
| sonarr_folder_key | Sonarr Folder to add to | | Folder to add missing items to |
|
||||
| sonarr_tag_key | Sonarr Tag for added missing | | Tag(s) to add to missing items |
|
||||
| item_sonarr_tag_key | Sonarr Tag for existing items | `false` | Tag(s) to add to existing items |
|
||||
| radarr_add_missing_key | Adds missing from the collection to radarr | | `true` or `false` |
|
||||
| radarr_folder_key | Radarr Folder to add to | | Folder to add missing items to |
|
||||
| radarr_tag_key | Radarr Tag for added missing | | Tag(s) to add to missing items |
|
||||
| item_radarr_tag_key | Radarr Tag for existing items | | Tag(s) to add to existing items |
|
||||
| collection_section | Controls the sort order of these collections against other default collections | `01` | 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 |
|
||||
|
||||
The below shows an example config.yml with all the template_variables set away from their defaults:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: trakt
|
||||
template_variables:
|
||||
use_popular: false
|
||||
order_popular: 01
|
||||
summary_popular: "Popular movies on Trakt right now"
|
||||
limit_popular: 10
|
||||
visible_library_popular: true
|
||||
visible_home_popular: true
|
||||
visible_shared_popular: true
|
||||
item_sonarr_tag_popular: New Episodes
|
||||
item_radarr_tag_season: Newly popular
|
||||
collection_section: 09
|
||||
collection_mode: show_items
|
||||
```
|
||||
@ -1,52 +0,0 @@
|
||||
# Genre Default Metadata File
|
||||
|
||||
The `- pmm: 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:
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
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 | `10` | 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 |
|
||||
| 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 of the template_variables set away from their defaults:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: genre
|
||||
template_variables:
|
||||
sort_by: title.asc
|
||||
collection_section: 5
|
||||
collection_mode: show_items
|
||||
use_separator: false
|
||||
sep_style: red
|
||||
```
|
||||
|
||||
|
After Width: | Height: | Size: 45 KiB |
|
After Width: | Height: | Size: 115 KiB |
|
After Width: | Height: | Size: 63 KiB |
|
After Width: | Height: | Size: 62 KiB |
|
After Width: | Height: | Size: 102 KiB |
|
After Width: | Height: | Size: 54 KiB |
|
After Width: | Height: | Size: 62 KiB |
|
After Width: | Height: | Size: 78 KiB |
|
After Width: | Height: | Size: 73 KiB |
|
After Width: | Height: | Size: 58 KiB |
|
After Width: | Height: | Size: 113 KiB |
|
After Width: | Height: | Size: 56 KiB |
|
After Width: | Height: | Size: 64 KiB |
|
After Width: | Height: | Size: 55 KiB |
|
After Width: | Height: | Size: 53 KiB |
|
After Width: | Height: | Size: 64 KiB |
@ -1,51 +0,0 @@
|
||||
# Network Language Default Metadata File
|
||||
|
||||
The `- pmm: network` Metadata File is used to dynamically create collections based on the networks available in your library.
|
||||
|
||||
Example Collections Created:
|
||||
|
||||
|
||||
|
||||
The below YAML in your config.yml will create the 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