@ -39,33 +39,33 @@ libraries: # This is called out once within
metadata_path:
metadata_path:
- file: config/Movies.yml # This is a local file on the system
- file: config/Movies.yml # This is a local file on the system
- folder: config/Movies/ # This is a local directory 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
- pmm: 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: imdb # This is a file within the https://github.com/meisnate12/Plex-Meta-Manager-Configs Repository
overlay_path:
overlay_path:
- remove_overlays: false # Set this to true to remove all overlays
- remove_overlays: false # Set this to true to remove all overlays
- file: config/Overlays.yml # This is a local file on the system
- 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:
TV Shows:
metadata_path:
metadata_path:
- file: config/TVShows.yml
- file: config/TVShows.yml
- folder: config/TV Shows/
- folder: config/TV Shows/
- git: PMM/chart/basic # 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
- git: PMM/chart/imdb # 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:
overlay_path:
- remove_overlays: false # Set this to true to remove all overlays
- remove_overlays: false # Set this to true to remove all overlays
- file: config/Overlays.yml # This is a local file on the system
- 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:
Anime:
metadata_path:
metadata_path:
- file: config/Anime.yml
- file: config/Anime.yml
- git: PMM/chart/basic # 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
- git: PMM/chart/anilist # 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:
Music:
metadata_path:
metadata_path:
- file: config/Music.yml
- file: config/Music.yml
playlist_files:
playlist_files:
- file: config/playlists.yml
- 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:
settings:
cache: true
cache: true
cache_expiration: 60
cache_expiration: 60
@ -196,8 +196,8 @@ As can be seen in the original config.yml example, there are three metadata_path
metadata_path:
metadata_path:
- file: config/TVShows.yml
- file: config/TVShows.yml
- folder: config/TV Shows/
- folder: config/TV Shows/
- git: PMM/chart/basic
- pmm: basic
- git: PMM/chart/imdb
- pmm: imdb
```
```
These path types are outlined as follows:
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.
* 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
```yaml
TV Shows:
TV Shows:
metadata_path:
metadata_path:
- file: config/TVShows.yml
- file: config/TVShows.yml
- folder: config/TV Shows/
- folder: config/TV Shows/
- file: PMM/chart/basic # <------HERE
- file: pmm: basic # <------HERE
- git: PMM/chart/imdb
- pmm: imdb
```
```
## Playlists (`playlist_files:` mappings)
## Playlists (`playlist_files:` mappings)
@ -232,7 +232,7 @@ Playlists can be seen as an extension of Libraries in that they are both handled
```yaml
```yaml
playlist_files:
playlist_files:
- file: config/playlists.yml
- 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:
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:
By default, when `metadata_path` is missing the script will look within the root PMM directory for a metadata file called `<MAPPING_NAME>.yml`. In this example, Plex Meta Manager will look for a file named `TV Shows.yml`.
By default, when `metadata_path` is missing the script will look within the root PMM directory for a metadata file called `<MAPPING_NAME>.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
@ -26,17 +26,17 @@ You can define [Template Variables](../metadata/templates.md#template-variables)
libraries:
libraries:
TV Shows:
TV Shows:
metadata_path:
metadata_path:
- git: PMM/genre
- pmm: genre
template_variables:
template_variables:
schedule_separator: never
schedule_separator: never
collection_mode: hide
collection_mode: hide
- git: PMM/actor # Notice how the `-` starts this "section"
- pmm: actor # Notice how the `-` starts this "section"
template_variables:
template_variables:
schedule_separator: never
schedule_separator: never
collection_mode: hide
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`.
`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:
metadata_path:
- file: config/Movies.yml
- file: config/Movies.yml
schedule: weekly(friday)
schedule: weekly(friday)
- git: PMM/actors
- pmm: actors
schedule: weekly(saturday)
schedule: weekly(saturday)
overlay_path:
overlay_path:
- git: PMM/overlays/imdb
- pmm: imdb
schedule: weekly(monday)
schedule: weekly(monday)
playlist_files:
playlist_files:
- file: config/Playlists.yml
- file: config/Playlists.yml
@ -74,10 +74,10 @@ libraries:
metadata_path:
metadata_path:
- file: config/Movies.yml
- file: config/Movies.yml
asset_directory: assets/Movies
asset_directory: assets/Movies
- git: PMM/actors
- pmm: actors
asset_directory: assets/people
asset_directory: assets/people
overlay_path:
overlay_path:
- git: PMM/overlays/imdb
- pmm: imdb
playlist_files:
playlist_files:
- file: config/Playlists.yml
- file: config/Playlists.yml
asset_directory:
asset_directory:
@ -103,7 +103,7 @@ libraries:
metadata_path:
metadata_path:
- file: config/TVShows.yml
- file: config/TVShows.yml
- folder: config/TV Shows/
- folder: config/TV Shows/
- git: PMM/chart/tmdb
- pmm: tmdb
- repo: charts
- repo: charts
- url: https://somewhere.com/PopularTV.yml
- 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.
* 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 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`.
* 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`
* Finally, load the metadata file located at `https://somewhere.com/PopularTV.yml`
@ -136,7 +136,7 @@ libraries:
overlay_path:
overlay_path:
- file: config/overlays.yml
- file: config/overlays.yml
- folder: config/overlay configs/
- folder: config/overlay configs/
- git: PMM/overlays/imdb
- pmm: imdb
- repo: overlays
- repo: overlays
- url: https://somewhere.com/Overlays.yml
- 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.
* 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 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`.
* 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`
* 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:
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")
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:
libraries:
Movies:
Movies:
metadata_path:
metadata_path:
- pmm: movie/content_rating_us
- pmm: content_rating_us
```
```
ohhh
ohhh
@ -41,7 +41,7 @@ The below shows an example config.yml with all the template_variables set away f
libraries:
libraries:
Movies:
Movies:
metadata_path:
metadata_path:
- pmm: movie/content_rating_us
- pmm: content_rating_us
template_variables:
template_variables:
sort_by: title.asc
sort_by: title.asc
collection_section: 25
collection_section: 25
@ -51,7 +51,7 @@ libraries:
sep_style: blue
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:
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
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:
Example Collections Created:
@ -11,7 +11,7 @@ The below YAML in your config.yml will create the collections:
libraries:
libraries:
Movies:
Movies:
metadata_path:
metadata_path:
- pmm: movie/country
- pmm: country
```
```
## Color Style
## Color Style
Below is a screenshot of the alternative `color` style which can be set via template variables
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:
libraries:
Movies:
Movies:
metadata_path:
metadata_path:
- pmm: movie/country
- pmm: country
template_variables:
template_variables:
sort_by: title.asc
sort_by: title.asc
collection_section: 8
collection_section: 8
@ -53,7 +53,7 @@ libraries:
sep_style: purple
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:
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
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 <decade>"
The `- pmm: decade` Metadata File is used to dynamically create collections based on the decades available in your library, sorted by critic rating to create a "best of <decade>"
Example Collections Created:
Example Collections Created:
@ -11,7 +11,7 @@ The below YAML in your config.yml will create the collections:
libraries:
libraries:
Movies:
Movies:
metadata_path:
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:
libraries:
Movies:
Movies:
metadata_path:
metadata_path:
- pmm: movie/decade
- pmm: decade
template_variables:
template_variables:
sort_by: title.asc
sort_by: title.asc
collection_section: 18
collection_section: 18
@ -49,7 +49,7 @@ libraries:
sep_style: purple
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 <decade>, the following template variable can be used:
An example of this is; to change the collection titles to "Best Movies of <decade>, 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 <decad
libraries:
libraries:
Movies:
Movies:
metadata_path:
metadata_path:
- pmm: movie/decade
- pmm: decade
template_variables:
template_variables:
title_format: Best <<library_type>>s of <<key_name>>
title_format: Best <<library_type>>s of <<key_name>>
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:
Example Collections Created:
@ -11,7 +11,7 @@ The below YAML in your config.yml will create the director collections:
libraries:
libraries:
Movies:
Movies:
metadata_path:
metadata_path:
- pmm: movie/director
- pmm: director
```
```
## Rainier Style
## Rainier Style
@ -44,7 +44,7 @@ The below shows an example config.yml with all the template_variables set away f
libraries:
libraries:
Movies:
Movies:
metadata_path:
metadata_path:
- pmm: movie/director
- pmm: director
template_variables:
template_variables:
style: rainier
style: rainier
sort_by: title.asc
sort_by: title.asc
@ -54,7 +54,7 @@ libraries:
sep_style: purple
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:
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
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.
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:
libraries:
Movies:
Movies:
metadata_path:
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
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:
Example Collections Created:
@ -11,7 +11,7 @@ The below YAML in your config.yml will create the producer collections:
libraries:
libraries:
Movies:
Movies:
metadata_path:
metadata_path:
- pmm: movie/producer
- pmm: producer
```
```
## Rainier Style
## Rainier Style
@ -44,7 +44,7 @@ The below shows an example config.yml with all the template_variables set away f
libraries:
libraries:
Movies:
Movies:
metadata_path:
metadata_path:
- pmm: movie/producer
- pmm: producer
template_variables:
template_variables:
style: rainier
style: rainier
sort_by: title.asc
sort_by: title.asc
@ -54,7 +54,7 @@ libraries:
sep_style: purple
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:
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
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)
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:
libraries:
Movies:
Movies:
metadata_path:
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
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:
Example Collections Created:
@ -11,7 +11,7 @@ The below YAML in your config.yml will create the writer collections:
libraries:
libraries:
Movies:
Movies:
metadata_path:
metadata_path:
- pmm: movie/writer
- pmm: writer
```
```
## Rainier Style
## Rainier Style
@ -44,7 +44,7 @@ The below shows an example config.yml with all the template_variables set away f
libraries:
libraries:
Movies:
Movies:
metadata_path:
metadata_path:
- pmm: movie/writer
- pmm: writer
template_variables:
template_variables:
style: rainier
style: rainier
sort_by: title.asc
sort_by: title.asc
@ -54,7 +54,7 @@ libraries:
sep_style: purple
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:
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
@ -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**
**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**
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`).
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**
**Note that the little icons cannot be changed and that the numbers next to the little icons are reflected in the poster ratings overlay**
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.
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)
**mass_*_rating_update** sources can be found here: [operations](../../config/operations)
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`)
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`)
@ -327,12 +303,12 @@ This example changes the ratings overlay to work on episodes.
libraries:
libraries:
TV Shows:
TV Shows:
overlay_path:
overlay_path:
- git: PMM/overlays/ratings
- pmm: ratings
template_variables:
template_variables:
overlay_level: episode
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:
@ -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.
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
## Configurations
@ -15,12 +15,12 @@ To run a file in git you can simply add it to your `metadata_path` (For Metadata
libraries:
libraries:
Movies:
Movies:
metadata_path:
metadata_path:
- git: PMM/actor
- pmm: actor
- git: PMM/genre
- pmm: genre
overlay_path:
overlay_path:
- remove_overlays: false
- remove_overlays: false
- git: PMM/overlays/imdb_top_250
- pmm: ribbon
- git: PMM/overlays/ratings
- pmm: ratings
```
```
## Overlays
## Overlays
@ -40,47 +40,37 @@ libraries:
overlay_path:
overlay_path:
- remove_overlays: false
- remove_overlays: false
- reapply_overlay: true
- reapply_overlay: true
- git: PMM/overlays/resolution # 1
- pmm: resolution # 1
- git: PMM/overlays/audio_codec # 2
- pmm: audio_codec # 2
- git: PMM/overlays/mediastinger # 3
- pmm: mediastinger # 3
- git: PMM/overlays/special_release # 4
- pmm: special_release # 4
- git: PMM/overlays/ratings # 5,6,7
- pmm: ratings # 5,6,7
template_variables:
template_variables:
rating1: user # 5 as this is user and mass_user_rating_update: mdb_tomatoes
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_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
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: 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_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
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: 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_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
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
horizontal_position: right # the set of ratings is on the right of the poster
- git: PMM/overlays/streaming # 8
- pmm: streaming # 8
- git: PMM/overlays/video_format # 9
- pmm: video_format # 9
- git: PMM/overlays/audio_language # 10
- pmm: audio_language # 10
- git: PMM/overlays/oscars # 11
- pmm: oscars # 11
template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied
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
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
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
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:
operations:
mass_user_rating_update: mdb_tomatoes # 5 This operation will update the user rating in plex with Rotten Tomatoes ratings information
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
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:
overlay_path:
- remove_overlays: false
- remove_overlays: false
- reapply_overlay: true
- reapply_overlay: true
- git: PMM/overlays/resolution # 1
- pmm: resolution # 1
- git: PMM/overlays/audio_codec # 2
- pmm: audio_codec # 2
- git: PMM/overlays/mediastinger # 3
- pmm: mediastinger # 3
- git: PMM/overlays/ratings # 4,5,6
- pmm: ratings # 4,5,6
template_variables:
template_variables:
rating1: user # 4 as this is user and mass_user_rating_update: mdb_tomatoes
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_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
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: 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_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
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: 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_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
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
horizontal_position: right # the set of ratings is on the right of the poster
- git: PMM/overlays/streaming # 7
- pmm: streaming # 7
- git: PMM/overlays/video_format # 8
- pmm: video_format # 8
- git: PMM/overlays/imdb_top_250 # 9
- pmm: ribbon # 9, #10
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
operations:
operations:
mass_user_rating_update: mdb_tomatoes # 4 This operation will update the user rating in plex with Rotten Tomatoes ratings information
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
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:
overlay_path:
- remove_overlays: false
- remove_overlays: false
- reapply_overlay: true
- reapply_overlay: true
- git: PMM/overlays/resolution # 1
- pmm: resolution # 1
template_variables:
template_variables:
overlay_level: season
overlay_level: season
- git: PMM/overlays/audio_codec # 2
- pmm: audio_codec # 2
template_variables:
template_variables:
overlay_level: season
overlay_level: season
- git: PMM/overlays/video_format # 3
- pmm: video_format # 3
template_variables:
template_variables:
overlay_level: season
overlay_level: season
```
```
@ -179,34 +157,34 @@ libraries:
overlay_path:
overlay_path:
- remove_overlays: false
- remove_overlays: false
- reapply_overlay: true
- reapply_overlay: true
- git: PMM/overlays/resolution # 1
- pmm: resolution # 1
template_variables:
template_variables:
overlay_level: episode
overlay_level: episode
- git: PMM/overlays/audio_codec # 2
- pmm: audio_codec # 2
template_variables:
template_variables:
overlay_level: episode
overlay_level: episode
- git: PMM/overlays/ratings # 3,4
- pmm: ratings # 3,4
template_variables:
template_variables:
rating1: critic # 3 as this is critic and mass_critic_rating_update: imdb
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_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
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: 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_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
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
horizontal_position: right # the set of ratings is on the right of the poster
overlay_level: episode
overlay_level: episode
- git: PMM/overlays/video_format # 5
- pmm: video_format # 5
template_variables:
template_variables:
overlay_level: episode
overlay_level: episode
- git: PMM/overlays/episode_info # 6
- pmm: episode_info # 6
template_variables:
template_variables:
overlay_level: episode
overlay_level: episode
- git: PMM/overlays/runtimes # 7
- pmm: runtimes # 7
template_variables:
template_variables:
overlay_level: episode
overlay_level: episode
@ -225,48 +203,48 @@ For example: `collection_section:01` translates to `sort_title: "!<<collection_s
@ -306,35 +284,11 @@ This example changes the ratings overlay to work on episodes.
libraries:
libraries:
TV Shows:
TV Shows:
overlay_path:
overlay_path:
- git: PMM/overlays/ratings
- pmm: ratings
template_variables:
template_variables:
overlay_level: episode
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:
meisnate12
2 years ago
committed by
GitHub
