diff --git a/docs/defaults/award/bafta.md b/docs/defaults/award/bafta.md index 1ec790df..72231c47 100644 --- a/docs/defaults/award/bafta.md +++ b/docs/defaults/award/bafta.md @@ -1,8 +1,8 @@ # BAFTA Default Metadata File -The `- pmm: bafta` Metadata File is used to dynamically create collections based on the genres available in your library. +The `- pmm: award/bafta` Metadata File is used to create collections based on the British Academy Film Awards. -This file also merges similarly named genres (such as "Sci-Fi", "SciFi" and "Sci-Fi & Fantasy") into one ("Science Fiction") +This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html) Example Collections Created: @@ -13,7 +13,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: bafta + - pmm: award/bafta ``` @@ -25,26 +25,31 @@ Note that the `templates_variables:` section only needs to be used if you do NOT 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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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` | +| 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 | `10` | Any number | +| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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 of the template_variables set away from their defaults: +The below shows an example config.yml with all the template_variables set away from their defaults: ```yaml libraries: Movies: metadata_path: - - pmm: bafta + - pmm: award/bafta template_variables: - sort_by: title.asc - collection_section: 5 + collection_section: 8 collection_mode: show_items - use_separator: false - sep_style: red + collection_order: alpha + radarr_add_missing: true + radarr_folder: /mnt/local/Media/Movies + radarr_tag: <> + item_radarr_tag: <> ``` diff --git a/docs/defaults/award/cannes.md b/docs/defaults/award/cannes.md new file mode 100644 index 00000000..82283f66 --- /dev/null +++ b/docs/defaults/award/cannes.md @@ -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: + +![](../images/cannes.png) + +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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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: <> + item_radarr_tag: <> +``` + diff --git a/docs/defaults/award/choice.md b/docs/defaults/award/choice.md new file mode 100644 index 00000000..704d38bd --- /dev/null +++ b/docs/defaults/award/choice.md @@ -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: + +![](../images/choice.png) + +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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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: <> + item_radarr_tag: <> + sonarr_add_missing: true + sonarr_folder: /mnt/local/Media/TV + sonarr_tag: <> + item_sonarr_tag: <> +``` + diff --git a/docs/defaults/award/emmy.md b/docs/defaults/award/emmy.md new file mode 100644 index 00000000..39ff8c07 --- /dev/null +++ b/docs/defaults/award/emmy.md @@ -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: + +![](../images/emmy.png) + +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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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: <> + item_radarr_tag: <> + sonarr_add_missing: true + sonarr_folder: /mnt/local/Media/TV + sonarr_tag: <> + item_sonarr_tag: <> +``` + diff --git a/docs/defaults/award/golden.md b/docs/defaults/award/golden.md new file mode 100644 index 00000000..2958d6bc --- /dev/null +++ b/docs/defaults/award/golden.md @@ -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: + +![](../images/golden.png) + +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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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: <> + item_radarr_tag: <> + sonarr_add_missing: true + sonarr_folder: /mnt/local/Media/TV + sonarr_tag: <> + item_sonarr_tag: <> +``` + diff --git a/docs/defaults/award/oscars.md b/docs/defaults/award/oscars.md new file mode 100644 index 00000000..944f085e --- /dev/null +++ b/docs/defaults/award/oscars.md @@ -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: + +![](../images/oscars.png) + +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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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: <> + item_radarr_tag: <> +``` + diff --git a/docs/defaults/award/other.md b/docs/defaults/award/other.md new file mode 100644 index 00000000..71246936 --- /dev/null +++ b/docs/defaults/award/other.md @@ -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: + +![](../images/awardother.png) + +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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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: <> + item_radarr_tag: <> +``` + diff --git a/docs/defaults/award/spirit.md b/docs/defaults/award/spirit.md new file mode 100644 index 00000000..af6faa7e --- /dev/null +++ b/docs/defaults/award/spirit.md @@ -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: + +![](../images/spirit.png) + +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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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: <> + item_radarr_tag: <> +``` + diff --git a/docs/defaults/award/sundance.md b/docs/defaults/award/sundance.md new file mode 100644 index 00000000..d475e2df --- /dev/null +++ b/docs/defaults/award/sundance.md @@ -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: + +![](../images/sundance.png) + +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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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: <> + item_radarr_tag: <> +``` + diff --git a/docs/defaults/actor.md b/docs/defaults/both/actor.md similarity index 82% rename from docs/defaults/actor.md rename to docs/defaults/both/actor.md index 8d573bd6..a86cb6dc 100644 --- a/docs/defaults/actor.md +++ b/docs/defaults/both/actor.md @@ -39,7 +39,7 @@ Below are the available variables which can be used to customize the actor file. | 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: +The below shows an example config.yml with all the template_variables set away from their defaults: ```yaml libraries: @@ -55,3 +55,18 @@ libraries: sep_style: purple ``` +Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `actor` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/both/actor.yml) + +An example of this is; To amend the maximum amount of collections that are created (default is 25), the following template variable can be used: + +```yaml +libraries: + Movies: + metadata_path: + - pmm: actor + template_variables: + data: + limit: 10 +``` + +Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs) \ No newline at end of file diff --git a/docs/defaults/audio_language.md b/docs/defaults/both/audio_language.md similarity index 83% rename from docs/defaults/audio_language.md rename to docs/defaults/both/audio_language.md index b1d3a4ce..306116db 100644 --- a/docs/defaults/audio_language.md +++ b/docs/defaults/both/audio_language.md @@ -34,7 +34,7 @@ Below are the available variables which can be used to customize the file. | 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: +The below shows an example config.yml with all the template_variables set away from their defaults: ```yaml libraries: @@ -49,4 +49,18 @@ libraries: use_separator: false sep_style: purple ``` +Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `audio_language` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/both/audio_language.yml) +An example of this is; to exclude the English Audio collection, the following template variable can be used: + +```yaml +libraries: + Movies: + metadata_path: + - pmm: audio_language + template_variables: + exclude: + -en +``` + +Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs) diff --git a/docs/defaults/content_rating_uk.md b/docs/defaults/both/content_rating_uk.md similarity index 83% rename from docs/defaults/content_rating_uk.md rename to docs/defaults/both/content_rating_uk.md index 530ce9e5..30dd378b 100644 --- a/docs/defaults/content_rating_uk.md +++ b/docs/defaults/both/content_rating_uk.md @@ -36,7 +36,7 @@ Below are the available variables which can be used to customize the file. | 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: +The below shows an example config.yml with all the template_variables set away from their defaults: ```yaml libraries: @@ -52,3 +52,19 @@ libraries: sep_style: blue ``` +Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `content_rating_uk` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/both/content_rating_uk.yml) + +An example of this is; to map the "de/18" content rating to "18", the following template variable can be used: + +```yaml +libraries: + Movies: + metadata_path: + - pmm: content_rating_uk + template_variables: + addons: + "18": + - "de/18" +``` + +Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs) diff --git a/docs/defaults/both/genre.md b/docs/defaults/both/genre.md new file mode 100644 index 00000000..9be92c16 --- /dev/null +++ b/docs/defaults/both/genre.md @@ -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: + +![](images/genre.png) + +The below YAML in your config.yml will create the collections: +```yaml +libraries: + Movies: + metadata_path: + - pmm: genre +``` + + +## Template Variables +Template Variables can be used to manipulate the file from the default settings which are provided. + +Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. + +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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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: + +![](images/content_rating_uk.png) + +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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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) diff --git a/docs/defaults/resolution.md b/docs/defaults/both/resolution.md similarity index 81% rename from docs/defaults/resolution.md rename to docs/defaults/both/resolution.md index 5272345b..5cf8b360 100644 --- a/docs/defaults/resolution.md +++ b/docs/defaults/both/resolution.md @@ -35,7 +35,7 @@ Below are the available variables which can be used to customize the file. | 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: +The below shows an example config.yml with all the template_variables set away from their defaults: ```yaml libraries: @@ -49,3 +49,19 @@ libraries: use_separator: false sep_style: green ``` +Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `resolution` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/both/resolution.yml) + +An example of this is; to map the "SD" resolution to "480", the following template variable can be used: + +```yaml +libraries: + Movies: + metadata_path: + - pmm: resolution + template_variables: + addons: + "480": + - SD +``` + +Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs) diff --git a/docs/defaults/resolution_standards.md b/docs/defaults/both/resolution_standards.md similarity index 81% rename from docs/defaults/resolution_standards.md rename to docs/defaults/both/resolution_standards.md index 763125cc..42d606f1 100644 --- a/docs/defaults/resolution_standards.md +++ b/docs/defaults/both/resolution_standards.md @@ -37,7 +37,7 @@ Below are the available variables which can be used to customize the file. | 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: +The below shows an example config.yml with all the template_variables set away from their defaults: ```yaml libraries: @@ -51,3 +51,18 @@ libraries: use_separator: false sep_style: stb ``` +Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `resolution_standards` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/both/resolution_standards.yml) + +An example of this is; to map the collection title of the "4k" resolution to "4K Ultra HD", the following template variable can be used: + +```yaml +libraries: + Movies: + metadata_path: + - pmm: resolution_standards + template_variables: + title_override: + 4k: 4K Ultra HD +``` + +Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs) diff --git a/docs/defaults/streaming.md b/docs/defaults/both/streaming.md similarity index 91% rename from docs/defaults/streaming.md rename to docs/defaults/both/streaming.md index 8f12fb7f..167f9bc7 100644 --- a/docs/defaults/streaming.md +++ b/docs/defaults/both/streaming.md @@ -67,7 +67,7 @@ Below are the available variables which can be used to customize the file. Note | 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 of the template_variables set away from their defaults: +The below shows an example config.yml with all the template_variables set away from their defaults: ```yaml libraries: @@ -94,3 +94,18 @@ libraries: use_separator: false sep_style: stb ``` +Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `streaming` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/both/streaming.yml) + +An example of this is; to only run the Disney+ collection against the movie library, the following template variable can be used: + +```yaml +libraries: + Movies: + metadata_path: + - pmm: streaming + template_variables: + use: + disney: movie +``` + +Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs) diff --git a/docs/defaults/studio.md b/docs/defaults/both/studio.md similarity index 79% rename from docs/defaults/studio.md rename to docs/defaults/both/studio.md index 4621898c..b22f0b44 100644 --- a/docs/defaults/studio.md +++ b/docs/defaults/both/studio.md @@ -22,7 +22,7 @@ Template Variables can be used to manipulate the file from the default settings 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.I +Below are the available variables which can be used to customize the file. | Variable | Usage | Default Value | Values | @@ -35,7 +35,7 @@ Below are the available variables which can be used to customize the file.I | 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: +The below shows an example config.yml with all the template_variables set away from their defaults: ```yaml libraries: @@ -50,3 +50,21 @@ libraries: sep_style: gray ``` +Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `studio` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/both/studio.yml) + +An example of this is; to include the "ABC Pictures" studio and map the "ABC News" studio to it, the following template variables can be used: + +```yaml +libraries: + Movies: + metadata_path: + - pmm: studio + template_variables: + include: + - ABC Pictures + addons: + ABC Picture: + - ABC News +``` + +Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs) diff --git a/docs/defaults/subtitle_language.md b/docs/defaults/both/subtitle_language.md similarity index 83% rename from docs/defaults/subtitle_language.md rename to docs/defaults/both/subtitle_language.md index ac9f0e6b..64161b03 100644 --- a/docs/defaults/subtitle_language.md +++ b/docs/defaults/both/subtitle_language.md @@ -34,7 +34,7 @@ Below are the available variables which can be used to customize the file. | 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: +The below shows an example config.yml with all the template_variables set away from their defaults: ```yaml libraries: @@ -50,3 +50,18 @@ libraries: sep_style: purple ``` +Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `subtitle_language` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/both/subtitle_language.yml) + +An example of this is; to exclude the English Subtitles collection, the following template variable can be used: + +```yaml +libraries: + Movies: + metadata_path: + - pmm: subtitle_language + template_variables: + exclude: + -en +``` + +Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs) diff --git a/docs/defaults/year.md b/docs/defaults/both/year.md similarity index 83% rename from docs/defaults/year.md rename to docs/defaults/both/year.md index 03e32a45..f6d0ed3f 100644 --- a/docs/defaults/year.md +++ b/docs/defaults/both/year.md @@ -34,7 +34,7 @@ Below are the available variables which can be used to customize the file. | 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: +The below shows an example config.yml with all the template_variables set away from their defaults: ```yaml libraries: @@ -50,3 +50,18 @@ libraries: sep_style: purple ``` +Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `year` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/both/year.yml) + +An example of this is; to include the previous 20 years (default is 10), the following template variable can be used: + +```yaml +libraries: + Movies: + metadata_path: + - pmm: year + template_variables: + data: + starting: current_year-20 +``` + +Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs) diff --git a/docs/defaults/chart/anilist.md b/docs/defaults/chart/anilist.md new file mode 100644 index 00000000..effcdb38 --- /dev/null +++ b/docs/defaults/chart/anilist.md @@ -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: + +![](../images/anilist.png) + +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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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 +``` diff --git a/docs/defaults/chart/basic.md b/docs/defaults/chart/basic.md new file mode 100644 index 00000000..20a976da --- /dev/null +++ b/docs/defaults/chart/basic.md @@ -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: + +![](../images/basic.png) + +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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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 +``` diff --git a/docs/defaults/chart/imdb.md b/docs/defaults/chart/imdb.md new file mode 100644 index 00000000..67c7e087 --- /dev/null +++ b/docs/defaults/chart/imdb.md @@ -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: + +![](../images/imdb.png) + +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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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 +``` diff --git a/docs/defaults/chart/myanimelist.md b/docs/defaults/chart/myanimelist.md new file mode 100644 index 00000000..7670f81b --- /dev/null +++ b/docs/defaults/chart/myanimelist.md @@ -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: + +![](../images/myanimelist.png) + +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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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 +``` diff --git a/docs/defaults/chart/other.md b/docs/defaults/chart/other.md new file mode 100644 index 00000000..29e54055 --- /dev/null +++ b/docs/defaults/chart/other.md @@ -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: + +![](../images/chartother.png) + +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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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 +``` diff --git a/docs/defaults/chart/tautulli.md b/docs/defaults/chart/tautulli.md new file mode 100644 index 00000000..33ddc157 --- /dev/null +++ b/docs/defaults/chart/tautulli.md @@ -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: + +![](../images/tautulli.png) + +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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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 +``` diff --git a/docs/defaults/chart/tmdb.md b/docs/defaults/chart/tmdb.md new file mode 100644 index 00000000..b411f74d --- /dev/null +++ b/docs/defaults/chart/tmdb.md @@ -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: + +![](../images/tmdb.png) + +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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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 +``` diff --git a/docs/defaults/chart/trakt.md b/docs/defaults/chart/trakt.md new file mode 100644 index 00000000..4a6eb949 --- /dev/null +++ b/docs/defaults/chart/trakt.md @@ -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: + +![](../images/trakt.png) + +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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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 +``` diff --git a/docs/defaults/genre.md b/docs/defaults/genre.md deleted file mode 100644 index ebdb2f7f..00000000 --- a/docs/defaults/genre.md +++ /dev/null @@ -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: - -![](images/genre.png) - -The below YAML in your config.yml will create the collections: -```yaml -libraries: - Movies: - metadata_path: - - pmm: genre -``` - - -## Template Variables -Template Variables can be used to manipulate the file from the default settings which are provided. - -Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. - -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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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 -``` - diff --git a/docs/defaults/images/anilist.png b/docs/defaults/images/anilist.png new file mode 100644 index 00000000..c815f606 Binary files /dev/null and b/docs/defaults/images/anilist.png differ diff --git a/docs/defaults/images/awardother.png b/docs/defaults/images/awardother.png new file mode 100644 index 00000000..c01675dc Binary files /dev/null and b/docs/defaults/images/awardother.png differ diff --git a/docs/defaults/images/basic.png b/docs/defaults/images/basic.png new file mode 100644 index 00000000..331f4400 Binary files /dev/null and b/docs/defaults/images/basic.png differ diff --git a/docs/defaults/images/cannes.png b/docs/defaults/images/cannes.png new file mode 100644 index 00000000..29d47ec2 Binary files /dev/null and b/docs/defaults/images/cannes.png differ diff --git a/docs/defaults/images/chartother.png b/docs/defaults/images/chartother.png new file mode 100644 index 00000000..546110cb Binary files /dev/null and b/docs/defaults/images/chartother.png differ diff --git a/docs/defaults/images/choice.png b/docs/defaults/images/choice.png new file mode 100644 index 00000000..8ee67052 Binary files /dev/null and b/docs/defaults/images/choice.png differ diff --git a/docs/defaults/images/emmy.png b/docs/defaults/images/emmy.png new file mode 100644 index 00000000..a14cdaa2 Binary files /dev/null and b/docs/defaults/images/emmy.png differ diff --git a/docs/defaults/images/golden.png b/docs/defaults/images/golden.png new file mode 100644 index 00000000..9799fea8 Binary files /dev/null and b/docs/defaults/images/golden.png differ diff --git a/docs/defaults/images/imdb.png b/docs/defaults/images/imdb.png new file mode 100644 index 00000000..e6009874 Binary files /dev/null and b/docs/defaults/images/imdb.png differ diff --git a/docs/defaults/images/myanimelist.png b/docs/defaults/images/myanimelist.png new file mode 100644 index 00000000..70575ef0 Binary files /dev/null and b/docs/defaults/images/myanimelist.png differ diff --git a/docs/defaults/images/oscars.png b/docs/defaults/images/oscars.png new file mode 100644 index 00000000..25374728 Binary files /dev/null and b/docs/defaults/images/oscars.png differ diff --git a/docs/defaults/images/spirit.png b/docs/defaults/images/spirit.png new file mode 100644 index 00000000..e1d1f80b Binary files /dev/null and b/docs/defaults/images/spirit.png differ diff --git a/docs/defaults/images/sundance.png b/docs/defaults/images/sundance.png new file mode 100644 index 00000000..13b2dfb9 Binary files /dev/null and b/docs/defaults/images/sundance.png differ diff --git a/docs/defaults/images/tautulli.png b/docs/defaults/images/tautulli.png new file mode 100644 index 00000000..24a9a9e9 Binary files /dev/null and b/docs/defaults/images/tautulli.png differ diff --git a/docs/defaults/images/tmdb.png b/docs/defaults/images/tmdb.png new file mode 100644 index 00000000..b4fe3e70 Binary files /dev/null and b/docs/defaults/images/tmdb.png differ diff --git a/docs/defaults/images/trakt.png b/docs/defaults/images/trakt.png new file mode 100644 index 00000000..fa5aee41 Binary files /dev/null and b/docs/defaults/images/trakt.png differ diff --git a/docs/defaults/movie/content_rating_us.md b/docs/defaults/movie/content_rating_us.md index 034f4b74..c836cdb5 100644 --- a/docs/defaults/movie/content_rating_us.md +++ b/docs/defaults/movie/content_rating_us.md @@ -1,6 +1,6 @@ # 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. +The `- pmm: movie/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") @@ -13,7 +13,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: content_rating_us + - pmm: movie/content_rating_us ``` ohhh @@ -41,7 +41,7 @@ The below shows an example config.yml with all the template_variables set away f libraries: Movies: metadata_path: - - pmm: content_rating_us + - pmm: movie/content_rating_us template_variables: sort_by: title.asc collection_section: 25 @@ -51,3 +51,20 @@ libraries: sep_style: blue ``` +Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `content_rating_us` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/movie/content_rating_us.yml) + +An example of this is; to map the "de/18" content rating to "R", the following template variable can be used: + +```yaml +libraries: + Movies: + metadata_path: + - pmm: movie/content_rating_us + template_variables: + addons: + R: + - "de/18" +``` + +Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs) + diff --git a/docs/defaults/movie/country.md b/docs/defaults/movie/country.md index f5b73d11..c247abff 100644 --- a/docs/defaults/movie/country.md +++ b/docs/defaults/movie/country.md @@ -1,6 +1,6 @@ # country Language Default Metadata File -The `- pmm: country` Metadata File is used to dynamically create collections based on the countries available in your library. +The `- pmm: movie/country` Metadata File is used to dynamically create collections based on the countries available in your library. Example Collections Created: @@ -11,7 +11,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: country + - pmm: movie/country ``` ## Color Style Below is a screenshot of the alternative `color` style which can be set via template variables @@ -43,7 +43,7 @@ The below shows an example config.yml with all the template_variables set away f libraries: Movies: metadata_path: - - pmm: country + - pmm: movie/country template_variables: sort_by: title.asc collection_section: 8 @@ -53,3 +53,19 @@ libraries: sep_style: purple ``` +Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `country` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/movie/country.yml) + +An example of this is; to include Barbados in the collection list, the following template variable can be used: + +```yaml +libraries: + Movies: + metadata_path: + - pmm: movie/country + template_variables: + include: + - Barbados +``` + +Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs) + diff --git a/docs/defaults/movie/decade.md b/docs/defaults/movie/decade.md index 180f1670..b59c17af 100644 --- a/docs/defaults/movie/decade.md +++ b/docs/defaults/movie/decade.md @@ -1,6 +1,6 @@ # 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 " +The `- pmm: movie/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 " Example Collections Created: @@ -11,7 +11,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: decade + - pmm: movie/decade ``` @@ -39,7 +39,7 @@ The below shows an example config.yml with all the template_variables set away f libraries: Movies: metadata_path: - - pmm: decade + - pmm: movie/decade template_variables: sort_by: title.asc collection_section: 18 @@ -49,3 +49,18 @@ libraries: sep_style: purple ``` +Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `decade` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/movie/decade.yml) + +An example of this is; to change the collection titles to "Best Movies of , the following template variable can be used: + +```yaml +libraries: + Movies: + metadata_path: + - pmm: movie/decade + template_variables: + title_format: Best <>s of <> +``` + +Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs) + diff --git a/docs/defaults/movie/director.md b/docs/defaults/movie/director.md index 259c0686..9bec98cc 100644 --- a/docs/defaults/movie/director.md +++ b/docs/defaults/movie/director.md @@ -1,6 +1,6 @@ # Director Default Metadata File -The `- pmm: director` Metadata File is used to dynamically create collections based on the most popular directors in your library. +The `- pmm: movie/director` Metadata File is used to dynamically create collections based on the most popular directors in your library. Example Collections Created: @@ -11,7 +11,7 @@ The below YAML in your config.yml will create the director collections: libraries: Movies: metadata_path: - - pmm: director + - pmm: movie/director ``` ## Rainier Style @@ -38,13 +38,13 @@ Below are the available variables which can be used to customize the file. | 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: +The below shows an example config.yml with all the template_variables set away from their defaults: ```yaml libraries: Movies: metadata_path: - - pmm: director + - pmm: movie/director template_variables: style: rainier sort_by: title.asc @@ -54,3 +54,19 @@ libraries: sep_style: purple ``` +Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `director` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/movie/director.yml) + +An example of this is; To amend the maximum amount of collections that are created (default is 25), the following template variable can be used: + +```yaml +libraries: + Movies: + metadata_path: + - pmm: movie/director + template_variables: + data: + limit: 25 +``` + +Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs) + diff --git a/docs/defaults/movie/franchise.md b/docs/defaults/movie/franchise.md index 5f4438ba..3a766cea 100644 --- a/docs/defaults/movie/franchise.md +++ b/docs/defaults/movie/franchise.md @@ -1,6 +1,6 @@ # Franchise Language Default Metadata File -The `- pmm: franchise` Metadata File is used to create collections based on popular Movie franchises, and can be used as a replacement to the TMDb Collections that Plex creates out-of-the-box. +The `- pmm: movie/franchise` Metadata File is used to create collections based on popular Movie franchises, and can be used as a replacement to the TMDb Collections that Plex creates out-of-the-box. 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. @@ -13,7 +13,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: franchise + - pmm: movie/franchise ``` @@ -42,7 +42,7 @@ The below shows an example config.yml with all the template_variables set away f libraries: Movies: metadata_path: - - pmm: franchise + - pmm: movie/franchise template_variables: collection_order: alpha sort_title: "!10_<>" diff --git a/docs/defaults/movie/network.md b/docs/defaults/movie/network.md deleted file mode 100644 index be61e0a3..00000000 --- a/docs/defaults/movie/network.md +++ /dev/null @@ -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: - -![](../images/network.png) - -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
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`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 -``` - diff --git a/docs/defaults/movie/producer.md b/docs/defaults/movie/producer.md index 9cacdf75..60a6ac46 100644 --- a/docs/defaults/movie/producer.md +++ b/docs/defaults/movie/producer.md @@ -1,6 +1,6 @@ # Producer Default Metadata File -The `- pmm: producer` Metadata File is used to dynamically create collections based on the most popular producers in your library. +The `- pmm: movie/producer` Metadata File is used to dynamically create collections based on the most popular producers in your library. Example Collections Created: @@ -11,7 +11,7 @@ The below YAML in your config.yml will create the producer collections: libraries: Movies: metadata_path: - - pmm: producer + - pmm: movie/producer ``` ## Rainier Style @@ -38,13 +38,13 @@ Below are the available variables which can be used to customize the file. | 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: +The below shows an example config.yml with all the template_variables set away from their defaults: ```yaml libraries: Movies: metadata_path: - - pmm: producer + - pmm: movie/producer template_variables: style: rainier sort_by: title.asc @@ -54,3 +54,19 @@ libraries: sep_style: purple ``` +Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `producer` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/movie/producer.yml) + +An example of this is; To amend the maximum amount of collections that are created (default is 25), the following template variable can be used: + +```yaml +libraries: + Movies: + metadata_path: + - pmm: movie/producer + template_variables: + data: + limit: 25 +``` + +Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs) + diff --git a/docs/defaults/movie/universe.md b/docs/defaults/movie/universe.md index b52a2328..0c87ecaa 100644 --- a/docs/defaults/movie/universe.md +++ b/docs/defaults/movie/universe.md @@ -1,6 +1,6 @@ # 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) +The `- pmm: movie/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) @@ -13,7 +13,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: universe + - pmm: movie/universe ``` @@ -30,9 +30,9 @@ Below are the available variables which can be used to customize the file. | 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 | +| 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 | -| use_separator | Controls whether a separator is created | `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` | The below shows an example config.yml with all the template_variables set away from their defaults: @@ -41,7 +41,7 @@ The below shows an example config.yml with all the template_variables set away f libraries: Movies: metadata_path: - - pmm: universe + - pmm: movie/universe template_variables: collection_order: release radarr_add_missing: true diff --git a/docs/defaults/movie/writer.md b/docs/defaults/movie/writer.md index 77e27c3f..363c617c 100644 --- a/docs/defaults/movie/writer.md +++ b/docs/defaults/movie/writer.md @@ -1,6 +1,6 @@ # Writer Default Metadata File -The `- pmm: writer` Metadata File is used to dynamically create collections based on the most popular writers in your library. +The `- pmm: movie/writer` Metadata File is used to dynamically create collections based on the most popular writers in your library. Example Collections Created: @@ -11,7 +11,7 @@ The below YAML in your config.yml will create the writer collections: libraries: Movies: metadata_path: - - pmm: writer + - pmm: movie/writer ``` ## Rainier Style @@ -38,13 +38,13 @@ Below are the available variables which can be used to customize the file. | 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: +The below shows an example config.yml with all the template_variables set away from their defaults: ```yaml libraries: Movies: metadata_path: - - pmm: writer + - pmm: movie/writer template_variables: style: rainier sort_by: title.asc @@ -54,3 +54,19 @@ libraries: sep_style: purple ``` +Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `writer` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/movie/writer.yml) + +An example of this is; To amend the maximum amount of collections that are created (default is 25), the following template variable can be used: + +```yaml +libraries: + Movies: + metadata_path: + - pmm: movie/writer + template_variables: + data: + limit: 25 +``` + +Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs) + diff --git a/docs/defaults/show/content_rating_us.md b/docs/defaults/show/content_rating_us.md index b9c50581..5402bcdd 100644 --- a/docs/defaults/show/content_rating_us.md +++ b/docs/defaults/show/content_rating_us.md @@ -1,6 +1,6 @@ # 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. +The `- pmm: show/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 "TV-14") @@ -13,7 +13,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: content_rating_us + - pmm: show/content_rating_us ``` ohhh @@ -36,13 +36,13 @@ Below are the available variables which can be used to customize the file. | 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: +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 + - pmm: show/content_rating_us template_variables: sort_by: title.asc collection_section: 25 @@ -52,3 +52,21 @@ libraries: sep_style: blue ``` +Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `content_rating_us` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/show/content_rating_us.yml) + +An example of this is; to map the "de/18" content rating to "TV-MA", the following template variable can be used: + +```yaml +libraries: + Movies: + metadata_path: + - pmm: show/content_rating_us + template_variables: + addons: + TV-MA: + - "de/18" +``` + +Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs) + + diff --git a/docs/defaults/show/country.md b/docs/defaults/show/country.md index 838c4b33..05b750cb 100644 --- a/docs/defaults/show/country.md +++ b/docs/defaults/show/country.md @@ -1,6 +1,6 @@ # country Language Default Metadata File -The `- pmm: country` Metadata File is used to dynamically create collections based on the countries available in your library. +The `- pmm: show/country` Metadata File is used to dynamically create collections based on the countries available in your library. Example Collections Created: @@ -11,7 +11,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: country + - pmm: show/country ``` ## Color Style Below is a screenshot of the alternative `color` style which can be set via template variables @@ -35,16 +35,15 @@ Below are the available variables which can be used to customize the file. | 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 of the template_variables set away from their defaults: +The below shows an example config.yml with all the template_variables set away from their defaults: ```yaml libraries: Movies: metadata_path: - - pmm: country + - pmm: show/country template_variables: sort_by: title.asc collection_section: 8 @@ -54,3 +53,19 @@ libraries: sep_style: purple ``` +Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `country` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/show/country.yml) + +An example of this is; to include Barbados in the collection list, the following template variable can be used: + +```yaml +libraries: + Movies: + metadata_path: + - pmm: show/country + template_variables: + include: + - bb +``` + +Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs) + diff --git a/docs/defaults/show/decade.md b/docs/defaults/show/decade.md index 3e4421a1..d8f8c200 100644 --- a/docs/defaults/show/decade.md +++ b/docs/defaults/show/decade.md @@ -1,6 +1,6 @@ # 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 " +The `- pmm: show/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 " Example Collections Created: @@ -11,7 +11,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: decade + - pmm: show/decade ``` @@ -39,7 +39,7 @@ The below shows an example config.yml with all the template_variables set away f libraries: Movies: metadata_path: - - pmm: decade + - pmm: show/decade template_variables: sort_by: title.asc collection_section: 18 @@ -49,3 +49,18 @@ libraries: sep_style: purple ``` +Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `decade` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/show/decade.yml) + +An example of this is; to change the collection titles to "Best Movies of , the following template variable can be used: + +```yaml +libraries: + Movies: + metadata_path: + - pmm: show/decade + template_variables: + title_format: Best <>s of <> +``` + +Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs) + diff --git a/docs/defaults/show/franchise.md b/docs/defaults/show/franchise.md index a029bb53..47b219e2 100644 --- a/docs/defaults/show/franchise.md +++ b/docs/defaults/show/franchise.md @@ -1,6 +1,6 @@ # Franchise Language Default Metadata File -The `- pmm: franchise` Metadata File is used to create collections based on popular TV franchises +The `- pmm: show/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. @@ -13,7 +13,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: franchise + - pmm: show/franchise ``` @@ -42,7 +42,7 @@ The below shows an example config.yml with all the template_variables set away f libraries: Movies: metadata_path: - - pmm: franchise + - pmm: show/franchise template_variables: collection_order: alpha sort_title: "!10_<>" diff --git a/docs/defaults/show/network.md b/docs/defaults/show/network.md index be61e0a3..7f99f2f2 100644 --- a/docs/defaults/show/network.md +++ b/docs/defaults/show/network.md @@ -1,6 +1,6 @@ # Network Language Default Metadata File -The `- pmm: network` Metadata File is used to dynamically create collections based on the networks available in your library. +The `- pmm: show/network` Metadata File is used to dynamically create collections based on the networks available in your library. Example Collections Created: @@ -11,7 +11,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: network + - pmm: show/network ``` @@ -39,7 +39,7 @@ The below shows an example config.yml with all the template_variables set away f libraries: Movies: metadata_path: - - pmm: network + - pmm: show/show/network template_variables: sort_by: title.asc collection_section: 07 @@ -49,3 +49,18 @@ libraries: sep_style: stb ``` +Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `network` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/show/network.yml) + +An example of this is; to include the "Adult Swim" network, the following template variables can be used: + +```yaml +libraries: + Movies: + metadata_path: + - pmm: show/show/network + template_variables: + include: + - Adult Swim +``` + +Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)