diff --git a/docs/defaults/actor.md b/docs/defaults/both/actor.md similarity index 85% rename from docs/defaults/actor.md rename to docs/defaults/both/actor.md index e8fe48f6..a86cb6dc 100644 --- a/docs/defaults/actor.md +++ b/docs/defaults/both/actor.md @@ -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 85% rename from docs/defaults/audio_language.md rename to docs/defaults/both/audio_language.md index e0b20113..306116db 100644 --- a/docs/defaults/audio_language.md +++ b/docs/defaults/both/audio_language.md @@ -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 85% rename from docs/defaults/content_rating_uk.md rename to docs/defaults/both/content_rating_uk.md index 47ffcc55..30dd378b 100644 --- a/docs/defaults/content_rating_uk.md +++ b/docs/defaults/both/content_rating_uk.md @@ -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 83% rename from docs/defaults/resolution.md rename to docs/defaults/both/resolution.md index 97f4d071..5cf8b360 100644 --- a/docs/defaults/resolution.md +++ b/docs/defaults/both/resolution.md @@ -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 83% rename from docs/defaults/resolution_standards.md rename to docs/defaults/both/resolution_standards.md index ce9c383f..42d606f1 100644 --- a/docs/defaults/resolution_standards.md +++ b/docs/defaults/both/resolution_standards.md @@ -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 92% rename from docs/defaults/streaming.md rename to docs/defaults/both/streaming.md index f2c04faa..167f9bc7 100644 --- a/docs/defaults/streaming.md +++ b/docs/defaults/both/streaming.md @@ -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 82% rename from docs/defaults/studio.md rename to docs/defaults/both/studio.md index cf6e1885..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 | @@ -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 85% rename from docs/defaults/subtitle_language.md rename to docs/defaults/both/subtitle_language.md index 86b49278..64161b03 100644 --- a/docs/defaults/subtitle_language.md +++ b/docs/defaults/both/subtitle_language.md @@ -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 85% rename from docs/defaults/year.md rename to docs/defaults/both/year.md index 64ea718f..f6d0ed3f 100644 --- a/docs/defaults/year.md +++ b/docs/defaults/both/year.md @@ -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/basic.md b/docs/defaults/chart/basic.md index 0cee9140..20a976da 100644 --- a/docs/defaults/chart/basic.md +++ b/docs/defaults/chart/basic.md @@ -1,6 +1,6 @@ # Basic Chart Default Metadata File -The `- pmm: chart/basic` Metadata File is used to dynamically create collections based on recently released media in your library. +The `- pmm: chart/basic` Metadata File is used to create collections based on recently released media in your library. Example Collections Created: diff --git a/docs/defaults/chart/imdb.md b/docs/defaults/chart/imdb.md index fe18dd7e..67c7e087 100644 --- a/docs/defaults/chart/imdb.md +++ b/docs/defaults/chart/imdb.md @@ -1,6 +1,6 @@ # IMDb Chart Default Metadata File -The `- pmm: chart/imdb` Metadata File is used to dynamically create collections based on IMDb Charts. +The `- pmm: chart/imdb` Metadata File is used to create collections based on IMDb Charts. Example Collections Created: diff --git a/docs/defaults/chart/myanimelist.md b/docs/defaults/chart/myanimelist.md index 1d3bbd2d..7670f81b 100644 --- a/docs/defaults/chart/myanimelist.md +++ b/docs/defaults/chart/myanimelist.md @@ -1,6 +1,6 @@ # MyAnimeList Chart Default Metadata File -The `- pmm: chart/myanimelist` Metadata File is used to dynamically create collections based on MyAnimeList Charts. +The `- pmm: chart/myanimelist` Metadata File is used to create collections based on MyAnimeList Charts. Example Collections Created: diff --git a/docs/defaults/chart/other.md b/docs/defaults/chart/other.md index 318e7eea..29e54055 100644 --- a/docs/defaults/chart/other.md +++ b/docs/defaults/chart/other.md @@ -1,6 +1,6 @@ # Other Chart Default Metadata File -The `- pmm: chart/other` Metadata File is used to dynamically create collections based on other Charts. +The `- pmm: chart/other` Metadata File is used to create collections based on other Charts. Example Collections Created: diff --git a/docs/defaults/chart/tautulli.md b/docs/defaults/chart/tautulli.md index 8d8b0738..33ddc157 100644 --- a/docs/defaults/chart/tautulli.md +++ b/docs/defaults/chart/tautulli.md @@ -1,6 +1,6 @@ # Tautulli Chart Default Metadata File -The `- pmm: chart/tautulli` Metadata File is used to dynamically create collections based on Tautulli/Plex Charts. +The `- pmm: chart/tautulli` Metadata File is used to create collections based on Tautulli/Plex Charts. Example Collections Created: diff --git a/docs/defaults/chart/tmdb.md b/docs/defaults/chart/tmdb.md index 105ad35f..b411f74d 100644 --- a/docs/defaults/chart/tmdb.md +++ b/docs/defaults/chart/tmdb.md @@ -1,6 +1,6 @@ # TMDb Chart Default Metadata File -The `- pmm: chart/tmdb` Metadata File is used to dynamically create collections based on TMDb Charts. +The `- pmm: chart/tmdb` Metadata File is used to create collections based on TMDb Charts. Example Collections Created: diff --git a/docs/defaults/chart/trakt.md b/docs/defaults/chart/trakt.md index 355eae5f..4a6eb949 100644 --- a/docs/defaults/chart/trakt.md +++ b/docs/defaults/chart/trakt.md @@ -1,6 +1,6 @@ # Trakt Chart Default Metadata File -The `- pmm: chart/trakt` Metadata File is used to dynamically create collections based on Trakt Charts. +The `- pmm: chart/trakt` Metadata File is used to create collections based on Trakt Charts. Example Collections Created: diff --git a/docs/defaults/genre.md b/docs/defaults/genre.md deleted file mode 100644 index 6904b23b..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 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/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 ce5b3311..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 @@ -44,7 +44,7 @@ The below shows an example config.yml with all the template_variables set away f 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 9ee6a5e8..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 @@ -44,7 +44,7 @@ The below shows an example config.yml with all the template_variables set away f 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 b8a77548..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 ``` @@ -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 dfeda4df..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 @@ -44,7 +44,7 @@ The below shows an example config.yml with all the template_variables set away f 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 02292f28..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 @@ -42,7 +42,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: 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 022ded40..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 @@ -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: show/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/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)