diff --git a/docs/conf.py b/docs/conf.py index 4413f627..3716be6a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -239,7 +239,8 @@ html_theme_options = { ("Subtitle Language Collections", "defaults/both/subtitle_language"), ("Year Collections", "defaults/both/year"), ]), - ("Playlists", "defaults/playlists"), + ("Playlists", "defaults/files.html#playlists"), + ("Separators", "defaults/separators"), ("_menu", "Overlays", [ ("Default Overlays", "defaults/overlays/readme"), ("Audio Codec Overlay", "defaults/overlays/audio_codec"), diff --git a/docs/config/configuration.md b/docs/config/configuration.md index 345fc66a..a64261e9 100644 --- a/docs/config/configuration.md +++ b/docs/config/configuration.md @@ -39,33 +39,33 @@ libraries: # This is called out once within metadata_path: - file: config/Movies.yml # This is a local file on the system - folder: config/Movies/ # This is a local directory on the system - - git: PMM/chart/basic # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository - - git: PMM/chart/imdb # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository + - pmm: basic # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository + - pmm: imdb # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository overlay_path: - remove_overlays: false # Set this to true to remove all overlays - file: config/Overlays.yml # This is a local file on the system - - git: PMM/overlays/imdb_top_250 # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository + - pmm: ribbon # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository TV Shows: metadata_path: - file: config/TVShows.yml - folder: config/TV Shows/ - - git: PMM/chart/basic # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository - - git: PMM/chart/imdb # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository + - pmm: basic # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository + - pmm: imdb # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository overlay_path: - remove_overlays: false # Set this to true to remove all overlays - file: config/Overlays.yml # This is a local file on the system - - git: PMM/overlays/imdb_top_250 # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository + - pmm: ribbon # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository Anime: metadata_path: - file: config/Anime.yml - - git: PMM/chart/basic # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository - - git: PMM/chart/anilist # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository + - pmm: basic # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository + - pmm: anilist # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository Music: metadata_path: - file: config/Music.yml playlist_files: - file: config/playlists.yml - - git: PMM/playlist # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository + - pmm: playlist # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository settings: cache: true cache_expiration: 60 @@ -196,8 +196,8 @@ As can be seen in the original config.yml example, there are three metadata_path metadata_path: - file: config/TVShows.yml - folder: config/TV Shows/ - - git: PMM/chart/basic - - git: PMM/chart/imdb + - pmm: basic + - pmm: imdb ``` These path types are outlined as follows: @@ -212,18 +212,18 @@ Within the above example, PMM will: * Then, look within the root of the PMM directory (also known as `config/`) for a directory called `TV Shows`, and then load any metadata/YAML files within that directory. -* After that, look at the [PMM/chart folder](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/PMM/chart) within the GitHub Configs Repo for a file called `basic.yml` which it finds [here](https://github.com/meisnate12/Plex-Meta-Manager-Configs/blob/master/PMM/chart/basic.yml). +* After that, look at the [PMM/chart folder](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/PMM/chart) within the GitHub Configs Repo for a file called `basic.yml` which it finds [here](https://github.com/meisnate12/Plex-Meta-Manager-Configs/blob/master/PMM/basic.yml). -* Finally, look at the [PMM/chart folder](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/PMM/chart) within the GitHub Configs Repo for a file called `imdb.yml` which it finds [here](https://github.com/meisnate12/Plex-Meta-Manager-Configs/blob/master/PMM/chart/imdb.yml). +* Finally, look at the [PMM/chart folder](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/PMM/chart) within the GitHub Configs Repo for a file called `imdb.yml` which it finds [here](https://github.com/meisnate12/Plex-Meta-Manager-Configs/blob/master/PMM/imdb.yml). -It should be noted that whilst the user should be able to edit any metadata files which are `- file:` or `- folder:` based, they have little to no control over `- git:` metadata files **unless a copy of the YAML file is downloaded and ran locally**. In the above example, if the user downloaded the [basic.yml file](https://github.com/meisnate12/Plex-Meta-Manager-Configs/blob/master/PMM/chart/basic.yml) from the [GitHub Configs Repo](https://github.com/meisnate12/Plex-Meta-Manager-Configs) and placed it in the root directory of PMM (`config/`), then the metadata_path mapping would be updated to reflect this as follows: +It should be noted that whilst the user should be able to edit any metadata files which are `- file:` or `- folder:` based, they have little to no control over `- git:` metadata files **unless a copy of the YAML file is downloaded and ran locally**. In the above example, if the user downloaded the [basic.yml file](https://github.com/meisnate12/Plex-Meta-Manager-Configs/blob/master/pmm: basic.yml) from the [GitHub Configs Repo](https://github.com/meisnate12/Plex-Meta-Manager-Configs) and placed it in the root directory of PMM (`config/`), then the metadata_path mapping would be updated to reflect this as follows: ```yaml TV Shows: metadata_path: - file: config/TVShows.yml - folder: config/TV Shows/ - - file: PMM/chart/basic # <------ HERE - - git: PMM/chart/imdb + - file: pmm: basic # <------ HERE + - pmm: imdb ``` ## Playlists (`playlist_files:` mappings) @@ -232,7 +232,7 @@ Playlists can be seen as an extension of Libraries in that they are both handled ```yaml playlist_files: - file: config/playlists.yml - - git: PMM/playlists + - pmm: playlists ``` As with `libraries:`, YAML files are defined to create the Playlists. It should be noted that whilst in `libraries:` when working with `playlist_files:` you call out the libraries being connected to within the Metadata/YAML file as Playlists can combine media from multiple libraries. You can view an example playlists.yml file as follows: diff --git a/docs/config/libraries.md b/docs/config/libraries.md index c6f507db..a70de15c 100644 --- a/docs/config/libraries.md +++ b/docs/config/libraries.md @@ -23,18 +23,18 @@ libraries: Movies: metadata_path: - file: config/Movies.yml - - git: PMM/chart/imdb - - git: PMM/studio - - git: PMM/genre - - git: PMM/actor + - pmm: imdb + - pmm: studio + - pmm: genre + - pmm: actor operations: mass_critic_rating_update: tmdb split_duplicates: true TV Shows: metadata_path: - file: config/TV Shows.yml - - git: PMM/chart/tmdb - - git: PMM/show/network + - pmm: tmdb + - pmm: network overlay_path: - remove_overlays: false - file: config/Overlays.yml @@ -45,12 +45,12 @@ libraries: token: #################### metadata_path: - file: config/TV Shows.yml - - git: PMM/chart/tmdb - - git: PMM/show/network + - pmm: tmdb + - pmm: network Anime: metadata_path: - file: config/Anime.yml - - git: PMM/chart/myanimelist + - pmm: myanimelist radarr: url: http://192.168.1.45:7878 token: ################################ @@ -128,8 +128,8 @@ libraries: TV Shows: metadata_path: - file: config/TV Shows.yml - - git: PMM/chart/tmdb - - git: PMM/show/network + - pmm: tmdb + - pmm: network ``` By default, when `metadata_path` is missing the script will look within the root PMM directory for a metadata file called `.yml`. In this example, Plex Meta Manager will look for a file named `TV Shows.yml`. @@ -236,5 +236,5 @@ You can define Playlist Files by using `playlist_files` mapper by specifying the ```yaml playlist_files: - file: config/playlists.yml - - git: PMM/playlist + - pmm: playlist ``` diff --git a/docs/config/operations.md b/docs/config/operations.md index 8cda5739..b9b7ca7f 100644 --- a/docs/config/operations.md +++ b/docs/config/operations.md @@ -8,7 +8,7 @@ Within each library, operations can be defined by using the `operations` attribu libraries: Movies: metadata_path: - - git: PMM/chart/imdb + - pmm: imdb operations: mass_critic_rating_update: tmdb split_duplicates: true diff --git a/docs/config/paths.md b/docs/config/paths.md index 601ae94d..c6685154 100644 --- a/docs/config/paths.md +++ b/docs/config/paths.md @@ -26,17 +26,17 @@ You can define [Template Variables](../metadata/templates.md#template-variables) libraries: TV Shows: metadata_path: - - git: PMM/genre + - pmm: genre template_variables: schedule_separator: never collection_mode: hide - - git: PMM/actor # Notice how the `-` starts this "section" + - pmm: actor # Notice how the `-` starts this "section" template_variables: schedule_separator: never collection_mode: hide ``` -In this example there will be two template variables added to every template in the git file PMM/genre. +In this example there will be two template variables added to every template in the git file pmm: genre. `schedule_separator` is set to `never` to not show a separator in this section and `collection_mode` is set to `hide`. @@ -54,10 +54,10 @@ libraries: metadata_path: - file: config/Movies.yml schedule: weekly(friday) - - git: PMM/actors + - pmm: actors schedule: weekly(saturday) overlay_path: - - git: PMM/overlays/imdb + - pmm: imdb schedule: weekly(monday) playlist_files: - file: config/Playlists.yml @@ -74,10 +74,10 @@ libraries: metadata_path: - file: config/Movies.yml asset_directory: assets/Movies - - git: PMM/actors + - pmm: actors asset_directory: assets/people overlay_path: - - git: PMM/overlays/imdb + - pmm: imdb playlist_files: - file: config/Playlists.yml asset_directory: @@ -103,7 +103,7 @@ libraries: metadata_path: - file: config/TVShows.yml - folder: config/TV Shows/ - - git: PMM/chart/tmdb + - pmm: tmdb - repo: charts - url: https://somewhere.com/PopularTV.yml ``` @@ -112,7 +112,7 @@ Within the above example, PMM will: * First, look within the root of the PMM directory (also known as `config/`) for a metadata file named `TVShows.yml`. If this file does not exist, PMM will skip the entry and move to the next one in the list. * Then, look within the root of the PMM directory (also known as `config/`) for a directory called `TV Shows`, and then load any metadata files within that directory. -* Then, look at the [meisnate12 folder](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/meisnate12) within the GitHub Configs Repo for a file called `MovieCharts.yml` which it finds [here](https://github.com/meisnate12/Plex-Meta-Manager-Configs/blob/master/PMM/chart/imdb.yml). +* Then, look at the [meisnate12 folder](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/meisnate12) within the GitHub Configs Repo for a file called `MovieCharts.yml` which it finds [here](https://github.com/meisnate12/Plex-Meta-Manager-Configs/blob/master/PMM/imdb.yml). * Then, look at the within the Custom Defined Repo for a file called `charts.yml`. * Finally, load the metadata file located at `https://somewhere.com/PopularTV.yml` @@ -136,7 +136,7 @@ libraries: overlay_path: - file: config/overlays.yml - folder: config/overlay configs/ - - git: PMM/overlays/imdb + - pmm: imdb - repo: overlays - url: https://somewhere.com/Overlays.yml ``` @@ -145,7 +145,7 @@ Within the above example, PMM will: * First, look within the root of the PMM directory (also known as `config/`) for a metadata file named `overlays.yml`. If this file does not exist, PMM will skip the entry and move to the next one in the list. * Then, look within the root of the PMM directory (also known as `config/`) for a directory called `overlay configs`, and then load any metadata files within that directory. -* Then, look at the [meisnate12 folder](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/meisnate12) within the GitHub Configs Repo for a file called `PMM/overlays/imdb.yml` which it finds [here](https://github.com/meisnate12/Plex-Meta-Manager-Configs/blob/master/PMM/overlays/imdb.yml). +* Then, look at the [meisnate12 folder](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/meisnate12) within the GitHub Configs Repo for a file called `pmm: imdb.yml` which it finds [here](https://github.com/meisnate12/Plex-Meta-Manager-Configs/blob/master/PMM/overlays/imdb.yml). * Then, look at the within the Custom Defined Repo for a file called `overlays.yml`. * Finally, load the metadata file located at `https://somewhere.com/Overlays.yml` @@ -167,7 +167,7 @@ In this example, multiple `playlist_files` attribute path types are defined: playlist_files: - file: config/playlists.yml - folder: config/Playlists/ - - git: PMM/playlist + - pmm: playlist - repo: playlists - url: https://somewhere.com/Playlists.yml ``` @@ -199,7 +199,7 @@ external_templates: - file: config/templates.yml - folder: config/templates/ - url: https://somewhere.com/templates.yml - - git: PMM/templates + - pmm: templates - repo: templates ``` diff --git a/docs/defaults/award/bafta.md b/docs/defaults/award/bafta.md index 72231c47..6a38294d 100644 --- a/docs/defaults/award/bafta.md +++ b/docs/defaults/award/bafta.md @@ -1,6 +1,6 @@ # BAFTA Default Metadata File -The `- pmm: award/bafta` Metadata File is used to create collections based on the British Academy Film Awards. +The `- pmm: bafta` Metadata File is used to create collections based on the British Academy Film Awards. 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: award/bafta + - pmm: bafta ``` @@ -42,7 +42,7 @@ The below shows an example config.yml with all the template_variables set away f libraries: Movies: metadata_path: - - pmm: award/bafta + - pmm: bafta template_variables: collection_section: 8 collection_mode: show_items diff --git a/docs/defaults/award/cannes.md b/docs/defaults/award/cannes.md index 82283f66..9fba7e7c 100644 --- a/docs/defaults/award/cannes.md +++ b/docs/defaults/award/cannes.md @@ -1,6 +1,6 @@ # Cannes Default Metadata File -The `- pmm: award/cannes` Metadata File is used to create collections based on the Cannes Film Awards. +The `- pmm: 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) @@ -13,7 +13,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: award/cannes + - pmm: cannes ``` @@ -42,7 +42,7 @@ The below shows an example config.yml with all the template_variables set away f libraries: Movies: metadata_path: - - pmm: award/cannes + - pmm: cannes template_variables: collection_section: 9 collection_mode: show_items diff --git a/docs/defaults/award/choice.md b/docs/defaults/award/choice.md index 704d38bd..eb7bc95d 100644 --- a/docs/defaults/award/choice.md +++ b/docs/defaults/award/choice.md @@ -1,6 +1,6 @@ # choice Default Metadata File -The `- pmm: award/choice` Metadata File is used to create collections based on the Critics Choice Awards. +The `- pmm: 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) @@ -13,7 +13,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: award/choice + - pmm: choice ``` @@ -47,7 +47,7 @@ The below shows an example config.yml with all the template_variables set away f libraries: Movies: metadata_path: - - pmm: award/choice + - pmm: choice template_variables: collection_section: 9 collection_mode: show_items diff --git a/docs/defaults/award/emmy.md b/docs/defaults/award/emmy.md index 39ff8c07..3a8045fd 100644 --- a/docs/defaults/award/emmy.md +++ b/docs/defaults/award/emmy.md @@ -1,6 +1,6 @@ # Emmys Default Metadata File -The `- pmm: award/emmy` Metadata File is used to create collections based on the Emmy Awards. +The `- pmm: emmy` Metadata File is used to create collections based on the Emmy Awards. Example Collections Created: @@ -11,7 +11,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: award/emmy + - pmm: emmy ``` @@ -46,7 +46,7 @@ The below shows an example config.yml with all the template_variables set away f libraries: Movies: metadata_path: - - pmm: award/emmy + - pmm: emmy template_variables: collection_section: 9 collection_mode: show_items diff --git a/docs/defaults/award/golden.md b/docs/defaults/award/golden.md index 2958d6bc..ced998b7 100644 --- a/docs/defaults/award/golden.md +++ b/docs/defaults/award/golden.md @@ -1,6 +1,6 @@ # Golden Globes Default Metadata File -The `- pmm: award/golden` Metadata File is used to create collections based on the Golden Globe Awards. +The `- pmm: golden` Metadata File is used to create collections based on the Golden Globe Awards. Example Collections Created: @@ -11,7 +11,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: award/golden + - pmm: golden ``` @@ -46,7 +46,7 @@ The below shows an example config.yml with all the template_variables set away f libraries: Movies: metadata_path: - - pmm: award/golden + - pmm: golden template_variables: collection_section: 9 collection_mode: show_items diff --git a/docs/defaults/award/oscars.md b/docs/defaults/award/oscars.md index 944f085e..7ea0a997 100644 --- a/docs/defaults/award/oscars.md +++ b/docs/defaults/award/oscars.md @@ -1,6 +1,6 @@ # Oscars Default Metadata File -The `- pmm: award/oscars` Metadata File is used to create collections based on the Oscars Awards. +The `- pmm: oscars` Metadata File is used to create collections based on the Oscars Awards. Example Collections Created: @@ -11,7 +11,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: award/oscars + - pmm: oscars ``` @@ -41,7 +41,7 @@ The below shows an example config.yml with all the template_variables set away f libraries: Movies: metadata_path: - - pmm: award/oscars + - pmm: oscars template_variables: collection_section: 9 collection_mode: show_items diff --git a/docs/defaults/award/other.md b/docs/defaults/award/other.md index 71246936..cc1d1cc0 100644 --- a/docs/defaults/award/other.md +++ b/docs/defaults/award/other.md @@ -1,6 +1,6 @@ # Other Awards Default Metadata File -The `- pmm: award/other` Metadata File is used to create collections based on numerous other awards. +The `- pmm: 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) @@ -13,7 +13,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: award/other + - pmm: other ``` @@ -41,7 +41,7 @@ The below shows an example config.yml with all the template_variables set away f libraries: Movies: metadata_path: - - pmm: award/other + - pmm: other template_variables: collection_section: 9 collection_mode: show_items diff --git a/docs/defaults/award/spirit.md b/docs/defaults/award/spirit.md index af6faa7e..a92d6efe 100644 --- a/docs/defaults/award/spirit.md +++ b/docs/defaults/award/spirit.md @@ -1,6 +1,6 @@ # Independent Spirit Awards Default Metadata File -The `- pmm: award/spirit` Metadata File is used to create collections based on the Independent Spirit Awards. +The `- pmm: 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) @@ -13,7 +13,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: award/spirit + - pmm: spirit ``` @@ -42,7 +42,7 @@ The below shows an example config.yml with all the template_variables set away f libraries: Movies: metadata_path: - - pmm: award/spirit + - pmm: spirit template_variables: collection_section: 9 collection_mode: show_items diff --git a/docs/defaults/award/sundance.md b/docs/defaults/award/sundance.md index d475e2df..5c1ab29b 100644 --- a/docs/defaults/award/sundance.md +++ b/docs/defaults/award/sundance.md @@ -1,6 +1,6 @@ # 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. +The `- pmm: 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) @@ -13,7 +13,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: award/sundance + - pmm: sundance ``` @@ -42,7 +42,7 @@ The below shows an example config.yml with all the template_variables set away f libraries: Movies: metadata_path: - - pmm: award/sundance + - pmm: sundance template_variables: collection_section: 9 collection_mode: show_items diff --git a/docs/defaults/chart/anilist.md b/docs/defaults/chart/anilist.md index effcdb38..1c1a6345 100644 --- a/docs/defaults/chart/anilist.md +++ b/docs/defaults/chart/anilist.md @@ -1,6 +1,6 @@ # Anilist Chart Default Metadata File -The `- pmm: chart/anilist` Metadata File is used to create collections based on Anilist charts +The `- pmm: pmm: anilist` Metadata File is used to create collections based on Anilist charts Example Collections Created: @@ -11,7 +11,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: chart/anilist + - pmm: pmm: anilist ``` diff --git a/docs/defaults/chart/basic.md b/docs/defaults/chart/basic.md index 20a976da..68e29d6c 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 create collections based on recently released media in your library. +The `- pmm: pmm: basic` Metadata File is used to create collections based on recently released media 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: chart/basic + - pmm: pmm: basic ``` diff --git a/docs/defaults/chart/imdb.md b/docs/defaults/chart/imdb.md index 67c7e087..42ae4174 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 create collections based on IMDb Charts. +The `- pmm: pmm: imdb` Metadata File is used to create collections based on IMDb Charts. Example Collections Created: @@ -11,7 +11,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: chart/imdb + - pmm: pmm: imdb ``` diff --git a/docs/defaults/chart/myanimelist.md b/docs/defaults/chart/myanimelist.md index 7670f81b..28db61b2 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 create collections based on MyAnimeList Charts. +The `- pmm: pmm: myanimelist` Metadata File is used to create collections based on MyAnimeList Charts. Example Collections Created: @@ -11,7 +11,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: chart/myanimelist + - pmm: pmm: myanimelist ``` diff --git a/docs/defaults/chart/other.md b/docs/defaults/chart/other.md index 29e54055..56ce59cc 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 create collections based on other Charts. +The `- pmm: other_chart` Metadata File is used to create collections based on other Charts. Example Collections Created: @@ -11,7 +11,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: chart/other + - pmm: other_chart ``` ## Template Variables @@ -59,7 +59,7 @@ The below shows an example config.yml with all the template_variables set away f libraries: Movies: metadata_path: - - pmm: other + - pmm: other_chart template_variables: use_commonsense: false order_commonsense: 01 diff --git a/docs/defaults/chart/tautulli.md b/docs/defaults/chart/tautulli.md index 33ddc157..2c2973d4 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 create collections based on Tautulli/Plex Charts. +The `- pmm: pmm: tautulli` Metadata File is used to create collections based on Tautulli/Plex Charts. Example Collections Created: @@ -11,7 +11,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: chart/tautulli + - pmm: pmm: tautulli ``` ## Template Variables diff --git a/docs/defaults/chart/tmdb.md b/docs/defaults/chart/tmdb.md index b411f74d..7c4eeb0f 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 create collections based on TMDb Charts. +The `- pmm: pmm: tmdb` Metadata File is used to create collections based on TMDb Charts. Example Collections Created: @@ -11,7 +11,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: chart/tmdb + - pmm: pmm: tmdb ``` diff --git a/docs/defaults/chart/trakt.md b/docs/defaults/chart/trakt.md index 4a6eb949..438991f7 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 create collections based on Trakt Charts. +The `- pmm: pmm: trakt` Metadata File is used to create collections based on Trakt Charts. Example Collections Created: @@ -11,7 +11,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: chart/trakt + - pmm: pmm: trakt ``` diff --git a/docs/defaults/files.md b/docs/defaults/files.md index b1441862..e89bf847 100644 --- a/docs/defaults/files.md +++ b/docs/defaults/files.md @@ -36,28 +36,28 @@ These collections are applied by calling the below paths into the `metadata_path | Award Show | config.yml entry | Example Collections Created | Works with Movies | Works with Shows | |:---------------|:-----------------|----------------------------------|:-----------------:|:----------------:| -| BAFTA | `award/bafta` | BAFTA Best Films, BAFTA 2021 | ✅ | ❌ | -| Cannes | `award/cannes` | Cannes - Palme d'or, Cannes 2018 | ✅ | ❌ | -| Critics Choice | `award/choice` | Critics Choice Awards 2020 | ✅ | ✅ | -| Emmys | `award/emmy` | Emmys 2021 | ✅ | ✅ | -| Golden Globes | `award/golden` | Best Motion Pictures | ✅ | ✅ | -| Oscars | `award/oscars` | Best Picture Winners | ✅ | ✅ | -| Spirit | `award/spirit` | Independent Spirit Awards 2021 | ✅ | ❌ | -| Sundance | `award/sundance` | Sundance Grand Jury Winners | ✅ | ✅ | +| BAFTA | `bafta` | BAFTA Best Films, BAFTA 2021 | ✅ | ❌ | +| Cannes | `cannes` | Cannes - Palme d'or, Cannes 2018 | ✅ | ❌ | +| Critics Choice | `choice` | Critics Choice Awards 2020 | ✅ | ✅ | +| Emmys | `emmy` | Emmys 2021 | ✅ | ✅ | +| Golden Globes | `golden` | Best Motion Pictures | ✅ | ✅ | +| Oscars | `oscars` | Best Picture Winners | ✅ | ✅ | +| Spirit | `spirit` | Independent Spirit Awards 2021 | ✅ | ❌ | +| Sundance | `sundance` | Sundance Grand Jury Winners | ✅ | ✅ | ### Chart Collections | Source | config.yml entry | Example Collections Created | Works with Movies | Works with Shows | |:------------|:--------------------|---------------------------------------------|:-----------------:|:----------------:| -| AniList | `chart/anilist` | AniList Popular, AniList Season | ✅ | ✅ | -| Basic | `chart/basic` | Newly Released, New Episodes | ✅ | ✅ | -| IMDb | `chart/imdb` | IMDb Popular, IMDb Top 250 | ✅ | ✅ | -| MyAnimeList | `chart/myanimelist` | MyAnimeList Popular, MyAnimeList Top Rated | ✅ | ✅ | -| Other | `chart/other` | AniDB Popular, Common Sense Selection | ✅ | ✅ | -| Tautulli | `chart/tautulli` | Plex Popular, Plex Watched | ✅ | ✅ | -| TMDb | `chart/tmdb` | TMDb Popular, TMDb Airing Today | ✅ | ✅ | -| Trakt | `chart/trakt` | Trakt Popular, Trakt Trending | ✅ | ✅ | +| AniList | `pmm: anilist` | AniList Popular, AniList Season | ✅ | ✅ | +| Basic | `pmm: basic` | Newly Released, New Episodes | ✅ | ✅ | +| IMDb | `pmm: imdb` | IMDb Popular, IMDb Top 250 | ✅ | ✅ | +| MyAnimeList | `pmm: myanimelist` | MyAnimeList Popular, MyAnimeList Top Rated | ✅ | ✅ | +| Other | `pmm: other` | AniDB Popular, Common Sense Selection | ✅ | ✅ | +| Tautulli | `pmm: tautulli` | Plex Popular, Plex Watched | ✅ | ✅ | +| TMDb | `pmm: tmdb` | TMDb Popular, TMDb Airing Today | ✅ | ✅ | +| Trakt | `pmm: trakt` | Trakt Popular, Trakt Trending | ✅ | ✅ | ## Overlays @@ -73,21 +73,21 @@ These overlays are applied by calling the below paths into the `overlay_path:` s | Theme | path | Example Overlays | Movies | Shows | Seasons | Episodes | |:-----------------------|:---------------------------|------------------------------------------------|:--------:|:---------:|:---------:|:--------:| -| Audio Codec | `overlays/audio_codec` | Dolby Atmos logo, DTS logo | ✅ | ✅ | ✅ | ✅ | -| Audio Language | `overlays/audio_language` | French Audio, Korean Audio | ✅ | ✅ | ✅ | ✅ | -| CommonSense Age Rating | `overlays/commonsense` | "3+", "16+" | ✅ | ✅ | ❗ | ❗ | -| Direct Play | `overlays/direct_play` | "Direct Play Only" | ✅ | ❗ | ❗ | ✅ | -| Editions | `overlays/editions` | Director's Cut logo, IMAX logo | ✅ | ❌ | ❌ | ❌ | -| Episode Info | `overlays/episode_info` | "S01E01", "S02E09" | ❌ | ❌ | ❌ | ✅ | -| Mediastinger | `overlays/mediastinger` | Mediastinger logo | ✅ | ✅ | ❌ | ❌ | -| Ratings | `overlays/ratings` | IMDb Audience Rating, Metacritic Critic Rating | ✅ | ✅ | ❌ | ✅ | -| Resolution | `overlays/resolution` | 4K Dolby Vision logo, 720P logo | ✅ | ✅ | ❌ | ✅ | -| Ribbon | `overlays/ribbon` | IMDb Top 250 Ribbon, RT Fresh Ribbon | ✅ | ✅ | ❌ | ❌ | -| Runtimes | `overlays/runtimes` | "Runtime: 1h 30m" | ✅ | ✅ | ❌ | ❌ | -| Special Releases | `overlays/special_release` | "Director's Cut", "Criterion Collection" | ✅ | ✅ | ❗ | ❗ | -| Streaming | `overlays/streaming` | Netflix logo, Hulu logo | ✅ | ✅ | ❌ | ❌ | -| Versions | `overlays/versions` | Multiple Versions logo | ✅ | ✅ | ✅ | ✅ | -| Video Format | `overlays/video_format` | "REMUX", "HDTV" | ✅ | ❗ | ❗ | ✅ | +| Audio Codec | `pmm: audio_codec` | Dolby Atmos logo, DTS logo | ✅ | ✅ | ✅ | ✅ | +| Audio Language | `pmm: audio_language` | French Audio, Korean Audio | ✅ | ✅ | ✅ | ✅ | +| CommonSense Age Rating | `pmm: commonsense` | "3+", "16+" | ✅ | ✅ | ❗ | ❗ | +| Direct Play | `pmm: direct_play` | "Direct Play Only" | ✅ | ❗ | ❗ | ✅ | +| Editions | `pmm: editions` | Director's Cut logo, IMAX logo | ✅ | ❌ | ❌ | ❌ | +| Episode Info | `pmm: episode_info` | "S01E01", "S02E09" | ❌ | ❌ | ❌ | ✅ | +| Mediastinger | `pmm: mediastinger` | Mediastinger logo | ✅ | ✅ | ❌ | ❌ | +| Ratings | `pmm: ratings` | IMDb Audience Rating, Metacritic Critic Rating | ✅ | ✅ | ❌ | ✅ | +| Resolution | `pmm: resolution` | 4K Dolby Vision logo, 720P logo | ✅ | ✅ | ❌ | ✅ | +| Ribbon | `pmm: ribbon` | IMDb Top 250 Ribbon, RT Fresh Ribbon | ✅ | ✅ | ❌ | ❌ | +| Runtimes | `pmm: runtimes` | "Runtime: 1h 30m" | ✅ | ✅ | ❌ | ❌ | +| Special Releases | `pmm: special_release` | "Director's Cut", "Criterion Collection" | ✅ | ✅ | ❗ | ❗ | +| Streaming | `pmm: streaming` | Netflix logo, Hulu logo | ✅ | ✅ | ❌ | ❌ | +| Versions | `pmm: versions` | Multiple Versions logo | ✅ | ✅ | ✅ | ✅ | +| Video Format | `pmm: video_format` | "REMUX", "HDTV" | ✅ | ❗ | ❗ | ✅ | ## Playlists diff --git a/docs/defaults/images/movie-overlays1-annotated.png b/docs/defaults/images/movie-overlays1-annotated.png new file mode 100644 index 00000000..cde942d4 Binary files /dev/null and b/docs/defaults/images/movie-overlays1-annotated.png differ diff --git a/docs/defaults/images/ratings_operations.png b/docs/defaults/images/ratings_operations.png new file mode 100644 index 00000000..fe541c97 Binary files /dev/null and b/docs/defaults/images/ratings_operations.png differ diff --git a/docs/defaults/images/ratings_overlay_path.png b/docs/defaults/images/ratings_overlay_path.png new file mode 100644 index 00000000..2ade4248 Binary files /dev/null and b/docs/defaults/images/ratings_overlay_path.png differ diff --git a/docs/defaults/images/ratings_source.png b/docs/defaults/images/ratings_source.png new file mode 100644 index 00000000..0e84e4ec Binary files /dev/null and b/docs/defaults/images/ratings_source.png differ diff --git a/docs/defaults/images/ratings_spot.png b/docs/defaults/images/ratings_spot.png new file mode 100644 index 00000000..dc3c0cea Binary files /dev/null and b/docs/defaults/images/ratings_spot.png differ diff --git a/docs/defaults/images/tvshow-poster-annotated.png b/docs/defaults/images/tvshow-poster-annotated.png new file mode 100644 index 00000000..e74602a0 Binary files /dev/null and b/docs/defaults/images/tvshow-poster-annotated.png differ diff --git a/docs/defaults/images/tvshow-poster-episode-annotated.png b/docs/defaults/images/tvshow-poster-episode-annotated.png new file mode 100644 index 00000000..fed5cb6f Binary files /dev/null and b/docs/defaults/images/tvshow-poster-episode-annotated.png differ diff --git a/docs/defaults/images/tvshow-poster-season-annotated.png b/docs/defaults/images/tvshow-poster-season-annotated.png new file mode 100644 index 00000000..33db33de Binary files /dev/null and b/docs/defaults/images/tvshow-poster-season-annotated.png differ diff --git a/docs/defaults/movie/content_rating_us.md b/docs/defaults/movie/content_rating_us.md index c836cdb5..e34874de 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: movie/content_rating_us` Metadata File is used to dynamically create collections based on the content ratings available in your library. +The `- pmm: content_rating_us` Metadata File is used to dynamically create collections based on the content ratings available in your library. If you do not use the US-based rating system within Plex, this file will attempt to match the international ratings (such as "gb/12A") to the respective US rating system (such as "PG-13") @@ -13,7 +13,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: movie/content_rating_us + - pmm: 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: movie/content_rating_us + - pmm: content_rating_us template_variables: sort_by: title.asc collection_section: 25 @@ -51,7 +51,7 @@ 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) +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/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: @@ -59,7 +59,7 @@ An example of this is; to map the "de/18" content rating to "R", the following t libraries: Movies: metadata_path: - - pmm: movie/content_rating_us + - pmm: content_rating_us template_variables: addons: R: diff --git a/docs/defaults/movie/country.md b/docs/defaults/movie/country.md index ff785948..fa34b787 100644 --- a/docs/defaults/movie/country.md +++ b/docs/defaults/movie/country.md @@ -1,6 +1,6 @@ # Country Default Metadata File -The `- pmm: movie/country` Metadata File is used to dynamically create collections based on the countries available in your library. +The `- pmm: 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: movie/country + - pmm: 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: movie/country + - pmm: country template_variables: sort_by: title.asc collection_section: 8 @@ -53,7 +53,7 @@ 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) +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/country.yml) An example of this is; to override the exclude list to only exclude Barbados from the collection list, the following template variable can be used: @@ -61,7 +61,7 @@ An example of this is; to override the exclude list to only exclude Barbados fro libraries: Movies: metadata_path: - - pmm: movie/country + - pmm: country template_variables: exclude: - Barbados diff --git a/docs/defaults/movie/decade.md b/docs/defaults/movie/decade.md index 8d026c66..b6b6e921 100644 --- a/docs/defaults/movie/decade.md +++ b/docs/defaults/movie/decade.md @@ -1,6 +1,6 @@ # Decade Default Metadata File -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 " +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 " Example Collections Created: @@ -11,7 +11,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: movie/decade + - pmm: 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: movie/decade + - pmm: decade template_variables: sort_by: title.asc collection_section: 18 @@ -49,7 +49,7 @@ 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) +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/decade.yml) An example of this is; to change the collection titles to "Best Movies of , the following template variable can be used: @@ -57,7 +57,7 @@ An example of this is; to change the collection titles to "Best Movies of >s of <> ``` diff --git a/docs/defaults/movie/director.md b/docs/defaults/movie/director.md index 9bec98cc..861f43f0 100644 --- a/docs/defaults/movie/director.md +++ b/docs/defaults/movie/director.md @@ -1,6 +1,6 @@ # Director Default Metadata File -The `- pmm: movie/director` Metadata File is used to dynamically create collections based on the most popular directors in your library. +The `- pmm: 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: movie/director + - pmm: 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: movie/director + - pmm: director template_variables: style: rainier sort_by: title.asc @@ -54,7 +54,7 @@ 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) +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/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: @@ -62,7 +62,7 @@ An example of this is; To amend the maximum amount of collections that are creat libraries: Movies: metadata_path: - - pmm: movie/director + - pmm: director template_variables: data: limit: 25 diff --git a/docs/defaults/movie/franchise.md b/docs/defaults/movie/franchise.md index a255a863..21297e6c 100644 --- a/docs/defaults/movie/franchise.md +++ b/docs/defaults/movie/franchise.md @@ -1,6 +1,6 @@ # Franchise Default Metadata File -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. +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. 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: movie/franchise + - pmm: 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: movie/franchise + - pmm: franchise template_variables: collection_order: alpha sort_title: "!10_<>" diff --git a/docs/defaults/movie/producer.md b/docs/defaults/movie/producer.md index 60a6ac46..aceab953 100644 --- a/docs/defaults/movie/producer.md +++ b/docs/defaults/movie/producer.md @@ -1,6 +1,6 @@ # Producer Default Metadata File -The `- pmm: movie/producer` Metadata File is used to dynamically create collections based on the most popular producers in your library. +The `- pmm: 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: movie/producer + - pmm: 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: movie/producer + - pmm: producer template_variables: style: rainier sort_by: title.asc @@ -54,7 +54,7 @@ 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) +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/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: @@ -62,7 +62,7 @@ An example of this is; To amend the maximum amount of collections that are creat libraries: Movies: metadata_path: - - pmm: movie/producer + - pmm: producer template_variables: data: limit: 25 diff --git a/docs/defaults/movie/universe.md b/docs/defaults/movie/universe.md index b05c08a5..6c2b8d36 100644 --- a/docs/defaults/movie/universe.md +++ b/docs/defaults/movie/universe.md @@ -1,6 +1,6 @@ # Universe Default Metadata File -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) +The `- pmm: universe` Metadata File is used to create collections based on popular Movie universes (such as the Marvel Cinematic Universe or Wizarding World) This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html) @@ -13,7 +13,7 @@ The below YAML in your config.yml will create the collections: libraries: Movies: metadata_path: - - pmm: movie/universe + - pmm: 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: movie/universe + - pmm: 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 363c617c..f6fb45ce 100644 --- a/docs/defaults/movie/writer.md +++ b/docs/defaults/movie/writer.md @@ -1,6 +1,6 @@ # Writer Default Metadata File -The `- pmm: movie/writer` Metadata File is used to dynamically create collections based on the most popular writers in your library. +The `- pmm: 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: movie/writer + - pmm: 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: movie/writer + - pmm: writer template_variables: style: rainier sort_by: title.asc @@ -54,7 +54,7 @@ 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) +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/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: @@ -62,7 +62,7 @@ An example of this is; To amend the maximum amount of collections that are creat libraries: Movies: metadata_path: - - pmm: movie/writer + - pmm: writer template_variables: data: limit: 25 diff --git a/docs/defaults/readme.md b/docs/defaults/readme.md index b1db9bcb..e8e07516 100644 --- a/docs/defaults/readme.md +++ b/docs/defaults/readme.md @@ -23,12 +23,12 @@ To run a file in git you can simply add it to your `metadata_path` (For Metadata libraries: Movies: metadata_path: - - git: PMM/actor - - git: PMM/genre + - pmm: actor + - pmm: genre overlay_path: - remove_overlays: false - - git: PMM/overlays/imdb_top_250 - - git: PMM/overlays/ratings + - pmm: ribbon + - pmm: ratings ``` ## Overlays @@ -37,8 +37,8 @@ The default set of overlays are a combination of Positional Overlays and Text Ov ### Example Poster Overlays -![](movie-overlays1-annotated.png) -![](movie-overlays2-annotated.png) +![](images/movie-overlays1-annotated.png) +![](images/movie-overlays2-annotated.png)
Click to expand sample config.yml Movies overlays section: @@ -48,47 +48,35 @@ libraries: overlay_path: - remove_overlays: false - reapply_overlay: true - - git: PMM/overlays/resolution # 1 - - git: PMM/overlays/audio_codec # 2 - - git: PMM/overlays/mediastinger # 3 - - git: PMM/overlays/special_release # 4 - - git: PMM/overlays/ratings # 5,6,7 + - pmm: resolution # 1 + - pmm: audio_codec # 2 + - pmm: mediastinger # 3 + - pmm: special_release # 4 + - pmm: ratings # 5,6,7 template_variables: rating1: user # 5 as this is user and mass_user_rating_update: mdb_tomatoes rating1_image: rt_tomato # 5 as this is user and mass_user_rating_update: mdb_tomatoes - rating1_font: config/metadata/overlays/fonts/Adlib.ttf # 5 local font accessible to PMM + rating1_font: config/metadata/pmm: fonts/Adlib.ttf # 5 local font accessible to PMM rating1_font_size: 63 # 5 adjusted font size to fit rating rating2: critic # 6 as this is critic and mass_critic_rating_update: imdb rating2_image: imdb # 6 as this is critic and mass_critic_rating_update: imdb - rating2_font: config/metadata/overlays/fonts/Impact.ttf # 6 local font accessible to PMM + rating2_font: config/metadata/pmm: fonts/Impact.ttf # 6 local font accessible to PMM rating2_font_size: 70 # 6 adjusted font size to fit rating rating3: audience # 7 as this is audience and mass_audience_rating_update: tmdb rating3_image: tmdb # 7 as this is audience and mass_audience_rating_update: tmdb - rating3_font: config/metadata/overlays/fonts/Avenir_95_Black.ttf # 7 local font accessible to PMM + rating3_font: config/metadata/pmm: fonts/Avenir_95_Black.ttf # 7 local font accessible to PMM rating3_font_size: 70 # 7 adjusted font size to fit rating horizontal_position: right # the set of ratings is on the right of the poster - - git: PMM/overlays/streaming # 8 - - git: PMM/overlays/video_format # 9 - - git: PMM/overlays/audio_language # 10 - - git: PMM/overlays/oscars # 11 + - pmm: streaming # 8 + - pmm: video_format # 9 + - pmm: audio_language # 10 + - pmm: oscars # 11 template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied weight: 40 # Weight of 40 applies if more than 1 sash is applied in bottom right - - git: PMM/overlays/imdb_top_250 # 12 - template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied - weight: 30 # Weight of 30 applies if more than 1 sash is applied in bottom right - - git: PMM/overlays/rt_cert_fresh # 13 - template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied - weight: 20 # Weight of 20 applies if more than 1 sash is applied in bottom right - - git: PMM/overlays/mc_must_see # NOT SHOWN, however would apply the "MetaCritic Must See" sash in the bottom right - template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied - weight: 10 # Weight of 10 applies if more than 1 sash is applied in bottom right - - git: PMM/overlays/commonsense_selection # NOT SHOWN, however would apply the "Commonsense Selected Families" sash in the bottom right - template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied - weight: 5 # Weight of 5 applies if more than 1 sash is applied in bottom right - + - pmm: ribbon # 12 & #13 operations: mass_user_rating_update: mdb_tomatoes # 5 This operation will update the user rating in plex with Rotten Tomatoes ratings information mass_critic_rating_update: imdb # 6 This operation will update the critic rating in plex with IMDb ratings information @@ -98,7 +86,7 @@ libraries: ### Example TV Shows - Show Overlays -![](tvshow-poster-annotated.png) +![](images/tvshow-poster-annotated.png)
Click to expand sample config.yml TV Shows overlays section for the Show Poster: @@ -108,42 +96,30 @@ libraries: overlay_path: - remove_overlays: false - reapply_overlay: true - - git: PMM/overlays/resolution # 1 - - git: PMM/overlays/audio_codec # 2 - - git: PMM/overlays/mediastinger # 3 - - git: PMM/overlays/ratings # 4,5,6 + - pmm: resolution # 1 + - pmm: audio_codec # 2 + - pmm: mediastinger # 3 + - pmm: ratings # 4,5,6 template_variables: rating1: user # 4 as this is user and mass_user_rating_update: mdb_tomatoes rating1_image: rt_tomato # 4 as this is user and mass_user_rating_update: mdb_tomatoes - rating1_font: config/metadata/overlays/fonts/Adlib.ttf # 4 local font accessible to PMM + rating1_font: config/metadata/pmm: fonts/Adlib.ttf # 4 local font accessible to PMM rating1_font_size: 63 # 4 adjusted font size to fit rating rating2: critic # 5 as this is critic and mass_critic_rating_update: imdb rating2_image: imdb # 5 as this is critic and mass_critic_rating_update: imdb - rating2_font: config/metadata/overlays/fonts/Impact.ttf # 5 local font accessible to PMM + rating2_font: config/metadata/pmm: fonts/Impact.ttf # 5 local font accessible to PMM rating2_font_size: 70 # 5 adjusted font size to fit rating rating3: audience # 6 as this is audience and mass_audience_rating_update: tmdb rating3_image: tmdb # 6 as this is audience and mass_audience_rating_update: tmdb - rating3_font: config/metadata/overlays/fonts/Avenir_95_Black.ttf # 6 local font accessible to PMM + rating3_font: config/metadata/pmm: fonts/Avenir_95_Black.ttf # 6 local font accessible to PMM rating3_font_size: 70 # 6 adjusted font size to fit rating horizontal_position: right # the set of ratings is on the right of the poster - - git: PMM/overlays/streaming # 7 - - git: PMM/overlays/video_format # 8 - - git: PMM/overlays/imdb_top_250 # 9 - template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied - weight: 30 # Weight of 30 applies if more than 1 sash is applied in bottom right - - git: PMM/overlays/rt_cert_fresh # 10 - template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied - weight: 20 # Weight of 20 applies if more than 1 sash is applied in bottom right - - git: PMM/overlays/mc_must_see # NOT SHOWN, however would apply the "MetaCritic Must See" sash in the bottom right - template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied - weight: 10 # Weight of 10 applies if more than 1 sash is applied in bottom right - - git: PMM/overlays/commonsense_selection # NOT SHOWN, however would apply the "Commonsense Selected Families" sash in the bottom right - template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied - weight: 5 # Weight of 5 applies if more than 1 sash is applied in bottom right - + - pmm: streaming # 7 + - pmm: video_format # 8 + - pmm: ribbon # 9, #10 operations: mass_user_rating_update: mdb_tomatoes # 4 This operation will update the user rating in plex with Rotten Tomatoes ratings information mass_critic_rating_update: imdb # 5 This operation will update the critic rating in plex with IMDb ratings information @@ -153,7 +129,7 @@ libraries: ### Example TV Shows - Season Overlays -![](tvshow-poster-season-annotated.png) +![](images/tvshow-poster-season-annotated.png)
Click to expand sample config.yml TV Shows overlays section for the Season Poster: @@ -163,13 +139,13 @@ libraries: overlay_path: - remove_overlays: false - reapply_overlay: true - - git: PMM/overlays/resolution # 1 + - pmm: resolution # 1 template_variables: overlay_level: season - - git: PMM/overlays/audio_codec # 2 + - pmm: audio_codec # 2 template_variables: overlay_level: season - - git: PMM/overlays/video_format # 3 + - pmm: video_format # 3 template_variables: overlay_level: season ``` @@ -177,7 +153,7 @@ libraries: ### Example TV Shows - Episode Overlays -![](tvshow-poster-episode-annotated.png) +![](images/tvshow-poster-episode-annotated.png)
Click to expand sample config.yml TV Shows overlays section for the Episode Poster: @@ -187,34 +163,34 @@ libraries: overlay_path: - remove_overlays: false - reapply_overlay: true - - git: PMM/overlays/resolution # 1 + - pmm: resolution # 1 template_variables: overlay_level: episode - - git: PMM/overlays/audio_codec # 2 + - pmm: audio_codec # 2 template_variables: overlay_level: episode - - git: PMM/overlays/ratings # 3,4 + - pmm: ratings # 3,4 template_variables: rating1: critic # 3 as this is critic and mass_critic_rating_update: imdb rating1_image: imdb # 3 as this is critic and mass_critic_rating_update: imdb - rating1_font: config/metadata/overlays/fonts/Impact.ttf # 3 local font accessible to PMM + rating1_font: config/metadata/pmm: fonts/Impact.ttf # 3 local font accessible to PMM rating1_font_size: 70 # 3 adjusted font size to fit rating rating2: audience # 4 as this is audience and mass_audience_rating_update: tmdb rating2_image: tmdb # 4 as this is audience and mass_audience_rating_update: tmdb - rating2_font: config/metadata/overlays/fonts/Avenir_95_Black.ttf # 4 local font accessible to PMM + rating2_font: config/metadata/pmm: fonts/Avenir_95_Black.ttf # 4 local font accessible to PMM rating2_font_size: 70 # 4 adjusted font size to fit rating horizontal_position: right # the set of ratings is on the right of the poster overlay_level: episode - - git: PMM/overlays/video_format # 5 + - pmm: video_format # 5 template_variables: overlay_level: episode - - git: PMM/overlays/episode_info # 6 + - pmm: episode_info # 6 template_variables: overlay_level: episode - - git: PMM/overlays/runtimes # 7 + - pmm: runtimes # 7 template_variables: overlay_level: episode @@ -231,7 +207,7 @@ By default, most metadata files use separators to denote different sections of c
Click to expand to see an example of Separators. - ![](separators.jpg) + ![](images/separators.jpg)
@@ -247,47 +223,47 @@ This is the default PMM collection ordering: | Collection | Order | -|:-------------------------------------|------------------------| -| `PMM/movie/seasonal.yml` | collection_section: 00 | -| `PMM/chart/anilist.yml` | collection_section: 01 | -| `PMM/chart/basic.yml` | collection_section: 01 | -| `PMM/chart/imdb.yml` | collection_section: 01 | -| `PMM/chart/myanimelist.yml` | collection_section: 01 | -| `PMM/chart/other.yml` | collection_section: 01 | -| `PMM/chart/tautulli.yml` | collection_section: 01 | -| `PMM/chart/tmdb.yml` | collection_section: 01 | -| `PMM/chart/trakt.yml` | collection_section: 01 | -| `PMM/movie/universe.yml` | collection_section: 02 | -| `PMM/streaming.yml` | collection_section: 03 | -| `PMM/show/network.yml` | collection_section: 04 | -| `PMM/genre.yml` | collection_section: 06 | -| `PMM/studio.yml` | collection_section: 07 | -| `PMM/movie/country.yml` | collection_section: 09 | -| `PMM/show/country.yml` | collection_section: 09 | -| `PMM/audio_language.yml` | collection_section: 10 | -| `PMM/subtitle_language.yml` | collection_section: 11 | -| `PMM/movie/decade.yml` | collection_section: 12 | -| `PMM/show/decade.yml` | collection_section: 12 | -| `PMM/year.yml` | collection_section: 13 | -| `PMM/content_rating_uk.yml` | collection_section: 14 | -| `PMM/movie/content_rating_us.yml` | collection_section: 14 | -| `PMM/show/content_rating_us.yml` | collection_section: 14 | -| `PMM/resolution.yml` | collection_section: 15 | -| `PMM/resolution_standards.yml` | collection_section: 15 | -| `PMM/award/bafta.yml` | collection_section: 16 | -| `PMM/award/cannes.yml` | collection_section: 16 | -| `PMM/award/choice.yml` | collection_section: 16 | -| `PMM/award/emmy.yml` | collection_section: 16 | -| `PMM/award/golden.yml` | collection_section: 16 | -| `PMM/award/oscars.yml` | collection_section: 16 | -| `PMM/award/other.yml` | collection_section: 16 | -| `PMM/award/separator.yml` | collection_section: 16 | -| `PMM/award/spirit.yml` | collection_section: 16 | -| `PMM/award/sundance.yml` | collection_section: 16 | -| `PMM/actor.yml` | collection_section: 17 | -| `PMM/movie/director.yml` | collection_section: 18 | -| `PMM/movie/producer.yml` | collection_section: 19 | -| `PMM/movie/writer.yml` | collection_section: 20 | +|:----------------------------------|:-----------------------| +| `seasonal.yml` | collection_section: 00 | +| `anilist.yml` | collection_section: 01 | +| `basic.yml` | collection_section: 01 | +| `imdb.yml` | collection_section: 01 | +| `myanimelist.yml` | collection_section: 01 | +| `other_chart.yml` | collection_section: 01 | +| `tautulli.yml` | collection_section: 01 | +| `tmdb.yml` | collection_section: 01 | +| `trakt.yml` | collection_section: 01 | +| `universe.yml` | collection_section: 02 | +| `streaming.yml` | collection_section: 03 | +| `network.yml` | collection_section: 04 | +| `genre.yml` | collection_section: 06 | +| `studio.yml` | collection_section: 07 | +| `country.yml` | collection_section: 09 | +| `country.yml` | collection_section: 09 | +| `audio_language.yml` | collection_section: 10 | +| `subtitle_language.yml` | collection_section: 11 | +| `decade.yml` | collection_section: 12 | +| `decade.yml` | collection_section: 12 | +| `year.yml` | collection_section: 13 | +| `content_rating_uk.yml` | collection_section: 14 | +| `content_rating_us.yml` | collection_section: 14 | +| `content_rating_us.yml` | collection_section: 14 | +| `resolution.yml` | collection_section: 15 | +| `resolution_standards.yml` | collection_section: 15 | +| `bafta.yml` | collection_section: 16 | +| `cannes.yml` | collection_section: 16 | +| `choice.yml` | collection_section: 16 | +| `emmy.yml` | collection_section: 16 | +| `golden.yml` | collection_section: 16 | +| `oscars.yml` | collection_section: 16 | +| `other_awart.yml` | collection_section: 16 | +| `separator.yml` | collection_section: 16 | +| `spirit.yml` | collection_section: 16 | +| `sundance.yml` | collection_section: 16 | +| `pmm: actor.yml` | collection_section: 17 | +| `director.yml` | collection_section: 18 | +| `producer.yml` | collection_section: 19 | +| `writer.yml` | collection_section: 20 | ## Ratings Overlays @@ -295,23 +271,23 @@ By default for Movies in Plex, the `Ratings Source` dropdown (`#3`) below, can c **Plex Meta Manager can insert up to three ratings of your choice into the three spots regardless of what you choose in the `Advanced` tab of that Plex library** -![](ratings_source.png) +![](images/ratings_source.png) Plex has three available spots in the Plex DB to store ratings and thus Plex Meta Manager can be used to insert ratings sources of your choice into those spots. They are known as the User Rating (`#1`), Critic Rating (`#2`), and Audience Rating (`#3`). **Note that the little icons cannot be changed and that the numbers next to the little icons are reflected in the poster ratings overlay** -![](ratings_spot.png) +![](images/ratings_spot.png) To be able to insert the ratings you want, Plex Meta Manager operations need to be defined. In this example below, User ratings (`#1`) are being filled with Rotten Tomatoes Critics Ratings. Critic ratings (`#2`) are filled with IMDb, and Audience ratings (`#3`) are filled with TMDb. **mass_*_rating_update** sources can be found here: [operations](../../config/operations) -![](ratings_operations.png) +![](images/ratings_operations.png) Finally, to show the ratings on the poster, the following was added to the `overlay_path` section in the `config.yml` file to post Rotten Tomatoes Critics Ratings in (`#1`), IMDb ratings in (`#2`), and TMDb ratings in (`#3`) -![](ratings_overlay_path.png) +![](images/ratings_overlay_path.png) @@ -327,12 +303,12 @@ This example changes the ratings overlay to work on episodes. libraries: TV Shows: overlay_path: - - git: PMM/overlays/ratings + - pmm: ratings template_variables: overlay_level: episode ``` -Each file has a comment block at the top showing the available `template_variables` for each file. For example the [`PMM/genre`](https://github.com/meisnate12/Plex-Meta-Manager-Configs/blob/master/PMM/genre.yml) has this: +Each file has a comment block at the top showing the available `template_variables` for each file. For example the [`pmm: genre`](https://github.com/meisnate12/Plex-Meta-Manager-Configs/blob/master/PMM/genre.yml) has this: ```yaml ############################################################# @@ -343,7 +319,7 @@ Each file has a comment block at the top showing the available `template_variabl # If nothing is specified these are the defaults # # # # metadata_path: # -# - git: PMM/genre # +# - pmm: genre # # template_variables: # # # Turn the separator collection on/off # # use_separator: true # @@ -370,7 +346,7 @@ For example if you want yearly oscar collections that go back 10 years instead o libraries: Movies: metadata_path: - - git: PMM/award/oscars + - pmm: oscars template_variables: radarr_add_missing: true data: @@ -378,13 +354,13 @@ libraries: ending: current_year ``` -Or maybe you want to change the number of actor collections made using PMM/actor. +Or maybe you want to change the number of actor collections made using pmm: actor. ```yaml libraries: Movies: overlay_path: - - git: PMM/actor + - pmm: actor template_variables: collection_mode: hide data: @@ -392,13 +368,13 @@ libraries: limit: 50 ``` -Or maybe you want to change the collection sort order of the genre collections using PMM/genre. +Or maybe you want to change the collection sort order of the genre collections using pmm: genre. ```yaml libraries: Movies: metadata_path: - - git: PMM/genre + - pmm: genre template_variables: collection_section: 11 ``` @@ -419,11 +395,11 @@ Alternatively it can be turned off individually per git file: libraries: LIBRARYNAME: metadata_path: - - git: PMM/ # separator is disabled + - pmm: # separator is disabled template_variables: use_separator: false - - git: PMM/ # separator is enabled by default - - git: PMM/ # separator is disabled + - pmm: # separator is enabled by default + - pmm: # separator is disabled template_variables: use_separator: false ``` @@ -441,197 +417,188 @@ If there are collections being made that have configuration errors or missing po libraries: Movies: metadata_path: - - git: PMM/award/bafta - - git: PMM/award/cannes - - git: PMM/award/choice - - git: PMM/award/golden - - git: PMM/award/oscars - - git: PMM/award/other - - git: PMM/award/spirit - - git: PMM/award/sundance - - git: PMM/chart/anilist - - git: PMM/chart/basic - - git: PMM/chart/imdb - - git: PMM/chart/myanimelist - - git: PMM/chart/other - - git: PMM/chart/tautulli - - git: PMM/chart/tmdb - - git: PMM/chart/trakt - - git: PMM/actor - - git: PMM/audio_language - - git: PMM/movie/content_rating_us # Choose content_rating_uk or content_rating_us - - git: PMM/genre - - git: PMM/resolution_standards # Choose resolution_standards or resolution - - git: PMM/streaming - - git: PMM/studio - - git: PMM/subtitle_language - - git: PMM/year - - git: PMM/movie/country - - git: PMM/movie/decade - - git: PMM/movie/director - - git: PMM/movie/franchise - - git: PMM/movie/universe - - git: PMM/movie/producer - - git: PMM/movie/seasonal - - git: PMM/movie/writer + - pmm: bafta + - pmm: cannes + - pmm: choice + - pmm: golden + - pmm: oscars + - pmm: other_award + - pmm: spirit + - pmm: sundance + - pmm: anilist + - pmm: basic + - pmm: imdb + - pmm: myanimelist + - pmm: other_chart + - pmm: tautulli + - pmm: tmdb + - pmm: trakt + - pmm: actor + - pmm: audio_language + - pmm: content_rating_us # Choose content_rating_uk or content_rating_us + - pmm: genre + - pmm: resolution_standards # Choose resolution_standards or resolution + - pmm: streaming + - pmm: studio + - pmm: subtitle_language + - pmm: year + - pmm: country + - pmm: decade + - pmm: director + - pmm: franchise + - pmm: universe + - pmm: producer + - pmm: seasonal + - pmm: writer overlay_path: - remove_overlays: false - - git: PMM/overlays/audio_codec - - git: PMM/overlays/audio_language - - git: PMM/overlays/commonsense - - git: PMM/overlays/direct_play - - git: PMM/overlays/mediastinger - - git: PMM/overlays/imdb_top_250 - - git: PMM/overlays/mc_must_see - - git: PMM/overlays/rt_cert_fresh - - git: PMM/overlays/commonsense_selection - - git: PMM/overlays/ratings + - pmm: audio_codec + - pmm: audio_language + - pmm: commonsense + - pmm: direct_play + - pmm: edition + - pmm: episode_info + - pmm: flixpatrol + - pmm: mediastinger + - pmm: ratings template_variables: rating1: critic rating1_image: rt_tomato - - git: PMM/overlays/resolution - - git: PMM/overlays/special_release - - git: PMM/overlays/streaming - - git: PMM/overlays/versions - - git: PMM/overlays/video_format + - pmm: resolution + - pmm: ribbon + - pmm: runtimes + - pmm: special_release + - pmm: streaming + - pmm: versions + - pmm: video_format TV Shows: metadata_path: - - git: PMM/award/choice - - git: PMM/award/golden - - git: PMM/award/emmy - - git: PMM/chart/anilist - - git: PMM/chart/basic - - git: PMM/chart/imdb - - git: PMM/chart/myanimelist - - git: PMM/chart/other - - git: PMM/chart/tautulli - - git: PMM/chart/tmdb - - git: PMM/chart/trakt - - git: PMM/actor - - git: PMM/audio_language - - git: PMM/show/content_rating_us # Choose content_rating_uk or content_rating_us - - git: PMM/genre - - git: PMM/resolution_standards # Choose resolution_standards or resolution - - git: PMM/streaming - - git: PMM/studio - - git: PMM/subtitle_language - - git: PMM/year - - git: PMM/show/country - - git: PMM/show/decade - - git: PMM/show/network + - pmm: choice + - pmm: golden + - pmm: emmy + - pmm: anilist + - pmm: basic + - pmm: imdb + - pmm: myanimelist + - pmm: other_chart + - pmm: tautulli + - pmm: tmdb + - pmm: trakt + - pmm: actor + - pmm: audio_language + - pmm: content_rating_us # Choose content_rating_uk or content_rating_us + - pmm: genre + - pmm: resolution_standards # Choose resolution_standards or resolution + - pmm: streaming + - pmm: studio + - pmm: subtitle_language + - pmm: year + - pmm: country + - pmm: decade + - pmm: network overlay_path: - remove_overlays: false - - git: PMM/overlays/audio_codec - - git: PMM/overlays/audio_codec - template_variables: - overlay_level: episode - - git: PMM/overlays/audio_codec - template_variables: - overlay_level: season - - git: PMM/overlays/audio_language - - git: PMM/overlays/audio_language + - pmm: audio_codec + - pmm: audio_codec template_variables: overlay_level: episode - - git: PMM/overlays/audio_language + - pmm: audio_codec template_variables: overlay_level: season - - git: PMM/overlays/commonsense - - git: PMM/overlays/commonsense + - pmm: audio_language + - pmm: audio_language template_variables: overlay_level: episode - - git: PMM/overlays/commonsense + - pmm: audio_language template_variables: overlay_level: season - - git: PMM/overlays/direct_play - - git: PMM/overlays/direct_play + - pmm: commonsense + - pmm: commonsense template_variables: overlay_level: episode - - git: PMM/overlays/direct_play + - pmm: commonsense template_variables: overlay_level: season - - git: PMM/overlays/episode_info - template_variables: - overlay_level: episode - - git: PMM/overlays/mediastinger - - git: PMM/overlays/mediastinger + - pmm: direct_play + - pmm: direct_play template_variables: overlay_level: episode - - git: PMM/overlays/mediastinger + - pmm: direct_play template_variables: overlay_level: season - - git: PMM/overlays/imdb_top_250 - - git: PMM/overlays/imdb_top_250 + - pmm: edition + - pmm: edition template_variables: overlay_level: episode - - git: PMM/overlays/imdb_top_250 - template_variables: - overlay_level: season - - git: PMM/overlays/mc_must_see - - git: PMM/overlays/mc_must_see + - pmm: episode_info template_variables: overlay_level: episode - - git: PMM/overlays/mc_must_see - template_variables: - overlay_level: season - - git: PMM/overlays/rt_cert_fresh - - git: PMM/overlays/rt_cert_fresh + - pmm: flixpatrol + - pmm: flixpatrol template_variables: overlay_level: episode - - git: PMM/overlays/rt_cert_fresh + - pmm: flixpatrol template_variables: overlay_level: season - - git: PMM/overlays/commonsense_selection - - git: PMM/overlays/commonsense_selection + - pmm: mediastinger + - pmm: mediastinger template_variables: overlay_level: episode - - git: PMM/overlays/commonsense_selection + - pmm: mediastinger template_variables: overlay_level: season - - git: PMM/overlays/ratings + - pmm: ratings template_variables: rating2: audience rating2_image: imdb - - git: PMM/overlays/ratings + - pmm: ratings template_variables: rating2: audience rating2_image: imdb overlay_level: episode - - git: PMM/overlays/resolution - - git: PMM/overlays/resolution + - pmm: resolution + - pmm: resolution + template_variables: + overlay_level: episode + - pmm: resolution + template_variables: + overlay_level: season + - pmm: ribbon + - pmm: ribbon template_variables: overlay_level: episode - - git: PMM/overlays/resolution + - pmm: ribbon template_variables: overlay_level: season - - git: PMM/overlays/runtimes + - pmm: runtimes template_variables: overlay_level: episode - - git: PMM/overlays/special_release - - git: PMM/overlays/special_release + - pmm: special_release + - pmm: special_release template_variables: overlay_level: episode - - git: PMM/overlays/special_release + - pmm: special_release template_variables: overlay_level: season - - git: PMM/overlays/streaming - - git: PMM/overlays/versions - - git: PMM/overlays/versions + - pmm: streaming + - pmm: versions + - pmm: versions template_variables: overlay_level: episode - - git: PMM/overlays/versions + - pmm: versions template_variables: overlay_level: season - - git: PMM/overlays/versions + - pmm: versions template_variables: overlay_level: show - - git: PMM/overlays/video_format - - git: PMM/overlays/video_format + - pmm: video_format + - pmm: video_format template_variables: overlay_level: episode - - git: PMM/overlays/video_format + - pmm: video_format template_variables: overlay_level: season playlist_files: -- git: PMM/playlist +- pmm: playlist ```
diff --git a/docs/defaults/separators.md b/docs/defaults/separators.md index 21af36ed..b69058b3 100644 --- a/docs/defaults/separators.md +++ b/docs/defaults/separators.md @@ -37,14 +37,14 @@ Multiple styles are available for Separators, to match Plex's "categories" featu The available styles avaiable are: | Style | Value | -|:----------------|:------:| -| Original | orig | -| Blue | blue | -| Brown | stb | -| Gray | gray | +|:----------------|:-------| +| Original | orig | +| Blue | blue | +| Brown | stb | +| Gray | gray | | Green | green | | Purple | purple | -| Red | red | +| Red | red | This image shows an example separator in each of the above styles diff --git a/docs/home/guides/defaults.md b/docs/home/guides/defaults.md index 652bea53..9c956fc0 100644 --- a/docs/home/guides/defaults.md +++ b/docs/home/guides/defaults.md @@ -4,7 +4,7 @@ There is a default set of Metadata and Overlay Files located in the [PMM Folder] The intention of this directory is to offer easy to use and slightly customizable (using [`template_variables`](../../config/paths.md#template-variables)) Metadata and Overlay Files for a general user who wants nice collections but doesn't want to learn all of Plex Meta Manager. -All posters defined in the Metadata Files are stored in the [Plex Meta Manager Images](https://github.com/meisnate12/Plex-Meta-Manager-Images) Repository and all Overlay images are in the [Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs) Repository at [PMM/overlays/images](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/PMM/overlays/images), which allows for changes to be made in one central location that will deploy to all users of this setup when they next run PMM. +All posters defined in the Metadata Files are stored in the [Plex Meta Manager Images](https://github.com/meisnate12/Plex-Meta-Manager-Images) Repository and all Overlay images are in the [Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs) Repository at [pmm: images](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/PMM/overlays/images), which allows for changes to be made in one central location that will deploy to all users of this setup when they next run PMM. ## Configurations @@ -15,12 +15,12 @@ To run a file in git you can simply add it to your `metadata_path` (For Metadata libraries: Movies: metadata_path: - - git: PMM/actor - - git: PMM/genre + - pmm: actor + - pmm: genre overlay_path: - remove_overlays: false - - git: PMM/overlays/imdb_top_250 - - git: PMM/overlays/ratings + - pmm: ribbon + - pmm: ratings ``` ## Overlays @@ -40,47 +40,37 @@ libraries: overlay_path: - remove_overlays: false - reapply_overlay: true - - git: PMM/overlays/resolution # 1 - - git: PMM/overlays/audio_codec # 2 - - git: PMM/overlays/mediastinger # 3 - - git: PMM/overlays/special_release # 4 - - git: PMM/overlays/ratings # 5,6,7 + - pmm: resolution # 1 + - pmm: audio_codec # 2 + - pmm: mediastinger # 3 + - pmm: special_release # 4 + - pmm: ratings # 5,6,7 template_variables: rating1: user # 5 as this is user and mass_user_rating_update: mdb_tomatoes rating1_image: rt_tomato # 5 as this is user and mass_user_rating_update: mdb_tomatoes - rating1_font: config/metadata/overlays/fonts/Adlib.ttf # 5 local font accessible to PMM + rating1_font: config/metadata/pmm: fonts/Adlib.ttf # 5 local font accessible to PMM rating1_font_size: 63 # 5 adjusted font size to fit rating rating2: critic # 6 as this is critic and mass_critic_rating_update: imdb rating2_image: imdb # 6 as this is critic and mass_critic_rating_update: imdb - rating2_font: config/metadata/overlays/fonts/Impact.ttf # 6 local font accessible to PMM + rating2_font: config/metadata/pmm: fonts/Impact.ttf # 6 local font accessible to PMM rating2_font_size: 70 # 6 adjusted font size to fit rating rating3: audience # 7 as this is audience and mass_audience_rating_update: tmdb rating3_image: tmdb # 7 as this is audience and mass_audience_rating_update: tmdb - rating3_font: config/metadata/overlays/fonts/Avenir_95_Black.ttf # 7 local font accessible to PMM + rating3_font: config/metadata/pmm: fonts/Avenir_95_Black.ttf # 7 local font accessible to PMM rating3_font_size: 70 # 7 adjusted font size to fit rating horizontal_position: right # the set of ratings is on the right of the poster - - git: PMM/overlays/streaming # 8 - - git: PMM/overlays/video_format # 9 - - git: PMM/overlays/audio_language # 10 - - git: PMM/overlays/oscars # 11 + - pmm: streaming # 8 + - pmm: video_format # 9 + - pmm: audio_language # 10 + - pmm: oscars # 11 template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied weight: 40 # Weight of 40 applies if more than 1 sash is applied in bottom right - - git: PMM/overlays/imdb_top_250 # 12 + - pmm: ribbon # 12, #13 template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied weight: 30 # Weight of 30 applies if more than 1 sash is applied in bottom right - - git: PMM/overlays/rt_cert_fresh # 13 - template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied - weight: 20 # Weight of 20 applies if more than 1 sash is applied in bottom right - - git: PMM/overlays/mc_must_see # NOT SHOWN, however would apply the "MetaCritic Must See" sash in the bottom right - template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied - weight: 10 # Weight of 10 applies if more than 1 sash is applied in bottom right - - git: PMM/overlays/commonsense_selection # NOT SHOWN, however would apply the "Commonsense Selected Families" sash in the bottom right - template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied - weight: 5 # Weight of 5 applies if more than 1 sash is applied in bottom right - operations: mass_user_rating_update: mdb_tomatoes # 5 This operation will update the user rating in plex with Rotten Tomatoes ratings information mass_critic_rating_update: imdb # 6 This operation will update the critic rating in plex with IMDb ratings information @@ -100,42 +90,30 @@ libraries: overlay_path: - remove_overlays: false - reapply_overlay: true - - git: PMM/overlays/resolution # 1 - - git: PMM/overlays/audio_codec # 2 - - git: PMM/overlays/mediastinger # 3 - - git: PMM/overlays/ratings # 4,5,6 + - pmm: resolution # 1 + - pmm: audio_codec # 2 + - pmm: mediastinger # 3 + - pmm: ratings # 4,5,6 template_variables: rating1: user # 4 as this is user and mass_user_rating_update: mdb_tomatoes rating1_image: rt_tomato # 4 as this is user and mass_user_rating_update: mdb_tomatoes - rating1_font: config/metadata/overlays/fonts/Adlib.ttf # 4 local font accessible to PMM + rating1_font: config/metadata/pmm: fonts/Adlib.ttf # 4 local font accessible to PMM rating1_font_size: 63 # 4 adjusted font size to fit rating rating2: critic # 5 as this is critic and mass_critic_rating_update: imdb rating2_image: imdb # 5 as this is critic and mass_critic_rating_update: imdb - rating2_font: config/metadata/overlays/fonts/Impact.ttf # 5 local font accessible to PMM + rating2_font: config/metadata/pmm: fonts/Impact.ttf # 5 local font accessible to PMM rating2_font_size: 70 # 5 adjusted font size to fit rating rating3: audience # 6 as this is audience and mass_audience_rating_update: tmdb rating3_image: tmdb # 6 as this is audience and mass_audience_rating_update: tmdb - rating3_font: config/metadata/overlays/fonts/Avenir_95_Black.ttf # 6 local font accessible to PMM + rating3_font: config/metadata/pmm: fonts/Avenir_95_Black.ttf # 6 local font accessible to PMM rating3_font_size: 70 # 6 adjusted font size to fit rating horizontal_position: right # the set of ratings is on the right of the poster - - git: PMM/overlays/streaming # 7 - - git: PMM/overlays/video_format # 8 - - git: PMM/overlays/imdb_top_250 # 9 - template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied - weight: 30 # Weight of 30 applies if more than 1 sash is applied in bottom right - - git: PMM/overlays/rt_cert_fresh # 10 - template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied - weight: 20 # Weight of 20 applies if more than 1 sash is applied in bottom right - - git: PMM/overlays/mc_must_see # NOT SHOWN, however would apply the "MetaCritic Must See" sash in the bottom right - template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied - weight: 10 # Weight of 10 applies if more than 1 sash is applied in bottom right - - git: PMM/overlays/commonsense_selection # NOT SHOWN, however would apply the "Commonsense Selected Families" sash in the bottom right - template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied - weight: 5 # Weight of 5 applies if more than 1 sash is applied in bottom right - + - pmm: streaming # 7 + - pmm: video_format # 8 + - pmm: ribbon # 9, #10 operations: mass_user_rating_update: mdb_tomatoes # 4 This operation will update the user rating in plex with Rotten Tomatoes ratings information mass_critic_rating_update: imdb # 5 This operation will update the critic rating in plex with IMDb ratings information @@ -155,13 +133,13 @@ libraries: overlay_path: - remove_overlays: false - reapply_overlay: true - - git: PMM/overlays/resolution # 1 + - pmm: resolution # 1 template_variables: overlay_level: season - - git: PMM/overlays/audio_codec # 2 + - pmm: audio_codec # 2 template_variables: overlay_level: season - - git: PMM/overlays/video_format # 3 + - pmm: video_format # 3 template_variables: overlay_level: season ``` @@ -179,34 +157,34 @@ libraries: overlay_path: - remove_overlays: false - reapply_overlay: true - - git: PMM/overlays/resolution # 1 + - pmm: resolution # 1 template_variables: overlay_level: episode - - git: PMM/overlays/audio_codec # 2 + - pmm: audio_codec # 2 template_variables: overlay_level: episode - - git: PMM/overlays/ratings # 3,4 + - pmm: ratings # 3,4 template_variables: rating1: critic # 3 as this is critic and mass_critic_rating_update: imdb rating1_image: imdb # 3 as this is critic and mass_critic_rating_update: imdb - rating1_font: config/metadata/overlays/fonts/Impact.ttf # 3 local font accessible to PMM + rating1_font: config/metadata/pmm: fonts/Impact.ttf # 3 local font accessible to PMM rating1_font_size: 70 # 3 adjusted font size to fit rating rating2: audience # 4 as this is audience and mass_audience_rating_update: tmdb rating2_image: tmdb # 4 as this is audience and mass_audience_rating_update: tmdb - rating2_font: config/metadata/overlays/fonts/Avenir_95_Black.ttf # 4 local font accessible to PMM + rating2_font: config/metadata/pmm: fonts/Avenir_95_Black.ttf # 4 local font accessible to PMM rating2_font_size: 70 # 4 adjusted font size to fit rating horizontal_position: right # the set of ratings is on the right of the poster overlay_level: episode - - git: PMM/overlays/video_format # 5 + - pmm: video_format # 5 template_variables: overlay_level: episode - - git: PMM/overlays/episode_info # 6 + - pmm: episode_info # 6 template_variables: overlay_level: episode - - git: PMM/overlays/runtimes # 7 + - pmm: runtimes # 7 template_variables: overlay_level: episode @@ -225,48 +203,48 @@ For example: `collection_section:01` translates to `sort_title: "!< # separator is disabled + - pmm: # separator is disabled template_variables: use_separator: false - - git: PMM/ # separator is enabled by default - - git: PMM/ # separator is disabled + - pmm: # separator is enabled by default + - pmm: # separator is disabled template_variables: use_separator: false ``` @@ -420,197 +374,173 @@ If there are collections being made that have configuration errors or missing po libraries: Movies: metadata_path: - - git: PMM/award/bafta - - git: PMM/award/cannes - - git: PMM/award/choice - - git: PMM/award/golden - - git: PMM/award/oscars - - git: PMM/award/other - - git: PMM/award/spirit - - git: PMM/award/sundance - - git: PMM/chart/anilist - - git: PMM/chart/basic - - git: PMM/chart/imdb - - git: PMM/chart/myanimelist - - git: PMM/chart/other - - git: PMM/chart/tautulli - - git: PMM/chart/tmdb - - git: PMM/chart/trakt - - git: PMM/actor - - git: PMM/audio_language - - git: PMM/movie/content_rating_us # Choose content_rating_uk or content_rating_us - - git: PMM/genre - - git: PMM/resolution_standards # Choose resolution_standards or resolution - - git: PMM/streaming - - git: PMM/studio - - git: PMM/subtitle_language - - git: PMM/year - - git: PMM/movie/country - - git: PMM/movie/decade - - git: PMM/movie/director - - git: PMM/movie/franchise - - git: PMM/movie/universe - - git: PMM/movie/producer - - git: PMM/movie/seasonal - - git: PMM/movie/writer + - pmm: bafta + - pmm: cannes + - pmm: choice + - pmm: golden + - pmm: oscars + - pmm: other_award + - pmm: spirit + - pmm: sundance + - pmm: anilist + - pmm: basic + - pmm: imdb + - pmm: myanimelist + - pmm: other_chart + - pmm: tautulli + - pmm: tmdb + - pmm: trakt + - pmm: actor + - pmm: audio_language + - pmm: content_rating_us # Choose content_rating_uk or content_rating_us + - pmm: genre + - pmm: resolution_standards # Choose resolution_standards or resolution + - pmm: streaming + - pmm: studio + - pmm: subtitle_language + - pmm: year + - pmm: country + - pmm: decade + - pmm: director + - pmm: franchise + - pmm: universe + - pmm: producer + - pmm: seasonal + - pmm: writer overlay_path: - remove_overlays: false - - git: PMM/overlays/audio_codec - - git: PMM/overlays/audio_language - - git: PMM/overlays/commonsense - - git: PMM/overlays/direct_play - - git: PMM/overlays/mediastinger - - git: PMM/overlays/imdb_top_250 - - git: PMM/overlays/mc_must_see - - git: PMM/overlays/rt_cert_fresh - - git: PMM/overlays/commonsense_selection - - git: PMM/overlays/ratings + - pmm: audio_codec + - pmm: audio_language + - pmm: commonsense + - pmm: direct_play + - pmm: mediastinger + - pmm: ribbon + - pmm: ratings template_variables: rating1: critic rating1_image: rt_tomato - - git: PMM/overlays/resolution - - git: PMM/overlays/special_release - - git: PMM/overlays/streaming - - git: PMM/overlays/versions - - git: PMM/overlays/video_format + - pmm: resolution + - pmm: special_release + - pmm: streaming + - pmm: versions + - pmm: video_format TV Shows: metadata_path: - - git: PMM/award/choice - - git: PMM/award/golden - - git: PMM/award/emmy - - git: PMM/chart/anilist - - git: PMM/chart/basic - - git: PMM/chart/imdb - - git: PMM/chart/myanimelist - - git: PMM/chart/other - - git: PMM/chart/tautulli - - git: PMM/chart/tmdb - - git: PMM/chart/trakt - - git: PMM/actor - - git: PMM/audio_language - - git: PMM/show/content_rating_us # Choose content_rating_uk or content_rating_us - - git: PMM/genre - - git: PMM/resolution_standards # Choose resolution_standards or resolution - - git: PMM/streaming - - git: PMM/studio - - git: PMM/subtitle_language - - git: PMM/year - - git: PMM/show/country - - git: PMM/show/decade - - git: PMM/show/network + - pmm: choice + - pmm: golden + - pmm: emmy + - pmm: anilist + - pmm: basic + - pmm: imdb + - pmm: myanimelist + - pmm: other_chart + - pmm: tautulli + - pmm: tmdb + - pmm: trakt + - pmm: actor + - pmm: audio_language + - pmm: content_rating_us # Choose content_rating_uk or content_rating_us + - pmm: genre + - pmm: resolution_standards # Choose resolution_standards or resolution + - pmm: streaming + - pmm: studio + - pmm: subtitle_language + - pmm: year + - pmm: country + - pmm: decade + - pmm: network overlay_path: - remove_overlays: false - - git: PMM/overlays/audio_codec - - git: PMM/overlays/audio_codec + - pmm: audio_codec + - pmm: audio_codec template_variables: overlay_level: episode - - git: PMM/overlays/audio_codec + - pmm: audio_codec template_variables: overlay_level: season - - git: PMM/overlays/audio_language - - git: PMM/overlays/audio_language + - pmm: audio_language + - pmm: audio_language template_variables: overlay_level: episode - - git: PMM/overlays/audio_language + - pmm: audio_language template_variables: overlay_level: season - - git: PMM/overlays/commonsense - - git: PMM/overlays/commonsense + - pmm: commonsense + - pmm: commonsense template_variables: overlay_level: episode - - git: PMM/overlays/commonsense + - pmm: commonsense template_variables: overlay_level: season - - git: PMM/overlays/direct_play - - git: PMM/overlays/direct_play + - pmm: direct_play + - pmm: direct_play template_variables: overlay_level: episode - - git: PMM/overlays/direct_play + - pmm: direct_play template_variables: overlay_level: season - - git: PMM/overlays/episode_info + - pmm: episode_info template_variables: overlay_level: episode - - git: PMM/overlays/mediastinger - - git: PMM/overlays/mediastinger - template_variables: - overlay_level: episode - - git: PMM/overlays/mediastinger - template_variables: - overlay_level: season - - git: PMM/overlays/imdb_top_250 - - git: PMM/overlays/imdb_top_250 - template_variables: - overlay_level: episode - - git: PMM/overlays/imdb_top_250 - template_variables: - overlay_level: season - - git: PMM/overlays/mc_must_see - - git: PMM/overlays/mc_must_see - template_variables: - overlay_level: episode - - git: PMM/overlays/mc_must_see - template_variables: - overlay_level: season - - git: PMM/overlays/rt_cert_fresh - - git: PMM/overlays/rt_cert_fresh + - pmm: mediastinger + - pmm: mediastinger template_variables: overlay_level: episode - - git: PMM/overlays/rt_cert_fresh + - pmm: mediastinger template_variables: overlay_level: season - - git: PMM/overlays/commonsense_selection - - git: PMM/overlays/commonsense_selection + - pmm: ribbon + - pmm: ribbon template_variables: overlay_level: episode - - git: PMM/overlays/commonsense_selection + - pmm: ribbon template_variables: overlay_level: season - - git: PMM/overlays/ratings + - pmm: ratings template_variables: rating2: audience rating2_image: imdb - - git: PMM/overlays/ratings + - pmm: ratings template_variables: rating2: audience rating2_image: imdb overlay_level: episode - - git: PMM/overlays/resolution - - git: PMM/overlays/resolution + - pmm: resolution + - pmm: resolution template_variables: overlay_level: episode - - git: PMM/overlays/resolution + - pmm: resolution template_variables: overlay_level: season - - git: PMM/overlays/runtimes + - pmm: runtimes template_variables: overlay_level: episode - - git: PMM/overlays/special_release - - git: PMM/overlays/special_release + - pmm: special_release + - pmm: special_release template_variables: overlay_level: episode - - git: PMM/overlays/special_release + - pmm: special_release template_variables: overlay_level: season - - git: PMM/overlays/streaming - - git: PMM/overlays/versions - - git: PMM/overlays/versions + - pmm: streaming + - pmm: versions + - pmm: versions template_variables: overlay_level: episode - - git: PMM/overlays/versions + - pmm: versions template_variables: overlay_level: season - - git: PMM/overlays/versions + - pmm: versions template_variables: overlay_level: show - - git: PMM/overlays/video_format - - git: PMM/overlays/video_format + - pmm: video_format + - pmm: video_format template_variables: overlay_level: episode - - git: PMM/overlays/video_format + - pmm: video_format template_variables: overlay_level: season playlist_files: -- git: PMM/playlist +- pmm: playlist ```
diff --git a/docs/home/guides/wt/wt-02.md b/docs/home/guides/wt/wt-02.md index 575fc52e..cdd51067 100644 --- a/docs/home/guides/wt/wt-02.md +++ b/docs/home/guides/wt/wt-02.md @@ -26,27 +26,27 @@ libraries: # This is called out once within metadata_path: - file: config/Movies.yml # This is a local file on the system - folder: config/Movies/ # This is a local directory on the system - - git: PMM/chart/basic # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository - - git: PMM/chart/imdb # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository + - pmm: basic # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository + - pmm: imdb # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository overlay_path: - remove_overlays: false # Set this to true to remove all overlays - file: config/Overlays.yml # This is a local file on the system - - git: PMM/overlays/imdb_top_250 # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository + - pmm: ribbon # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository TV Shows: metadata_path: - file: config/TVShows.yml - folder: config/TV Shows/ - - git: PMM/chart/basic # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository - - git: PMM/chart/imdb # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository + - pmm: basic # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository + - pmm: imdb # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository overlay_path: - remove_overlays: false # Set this to true to remove all overlays - file: config/Overlays.yml # This is a local file on the system - - git: PMM/overlays/imdb_top_250 # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository + - pmm: imdb_top_250 # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository Anime: metadata_path: - file: config/Anime.yml - - git: PMM/chart/basic # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository - - git: PMM/chart/anilist # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository + - pmm: basic # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository + - pmm: anilist # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository Music: metadata_path: - file: config/Music.yml @@ -62,12 +62,12 @@ libraries: metadata_path: - file: config/Movies.yml # This is a local file on the system - folder: config/Movies/ # This is a local directory on the system - - git: PMM/chart/basic # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository - - git: PMM/chart/imdb # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository + - pmm: basic # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository + - pmm: imdb # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository overlay_path: - remove_overlays: false # Set this to true to remove all overlays - file: config/Overlays.yml # This is a local file on the system - - git: PMM/overlays/imdb_top_250 # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository + - pmm: imdb_top_250 # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository ``` This is intended to cause an error for illustration that you will then fix. diff --git a/docs/metadata/details/schedule.md b/docs/metadata/details/schedule.md index 9edda7a5..7b266bb9 100644 --- a/docs/metadata/details/schedule.md +++ b/docs/metadata/details/schedule.md @@ -9,10 +9,10 @@ libraries: schedule: weekly(sunday) metadata_path: - file: config/Movies.yml - - git: PMM/chart/imdb - - git: PMM/studio - - git: PMM/genre - - git: PMM/actor + - pmm: imdb + - pmm: studio + - pmm: genre + - pmm: actor operations: mass_critic_rating_update: tmdb ``` @@ -24,16 +24,16 @@ libraries: metadata_path: - file: config/Movies.yml schedule: weekly(monday) - - git: PMM/chart/imdb + - pmm: imdb schedule: weekly(tuesday) - - git: PMM/studio + - pmm: studio schedule: weekly(wednesday) - - git: PMM/genre + - pmm: genre schedule: weekly(thursday) - - git: PMM/actor + - pmm: actor schedule: weekly(friday) overlay_path: - - git: PMM/overlays/imdb + - pmm: imdb schedule: weekly(saturday) operations: mass_critic_rating_update: tmdb diff --git a/docs/metadata/overlay.md b/docs/metadata/overlay.md index 9811081b..619d1765 100644 --- a/docs/metadata/overlay.md +++ b/docs/metadata/overlay.md @@ -116,7 +116,7 @@ overlays: imdb_chart: top_movies overlay: name: IMDB-Top-250 - git: PMM/overlays/images/IMDB-Top-250 + pmm: images/IMDB-Top-250 horizontal_offset: 0 horizontal_align: right vertical_offset: 0 @@ -291,7 +291,7 @@ overlays: back_radius: 30 back_width: 300 back_height: 105 - git: PMM/overlays/images/raw/IMDB_Rating + pmm: images/raw/IMDB_Rating addon_position: left addon_offset: 25 ``` @@ -307,7 +307,7 @@ overlays: Dual-Audio: overlay: name: Dual-Audio - git: PMM/overlays/images/Dual-Audio + pmm: images/Dual-Audio group: audio_language weight: 10 horizontal_offset: 0 @@ -320,7 +320,7 @@ overlays: Multi-Audio: overlay: name: Multi-Audio - git: PMM/overlays/images/Multi-Audio + pmm: images/Multi-Audio group: audio_language weight: 20 horizontal_offset: 0 @@ -455,7 +455,7 @@ overlays: HDR: overlay: name: HDR - git: PMM/overlays/HDR + pmm: HDR plex_search: all: hdr: true diff --git a/docs/metadata/templates.md b/docs/metadata/templates.md index 05e30ea1..8b0195f6 100644 --- a/docs/metadata/templates.md +++ b/docs/metadata/templates.md @@ -237,5 +237,5 @@ To load external templates located in another file you can use the `external_tem ```yaml external_templates: - file: config/templates.yml - - git: PMM/templates + - pmm: templates ```