mirror of https://github.com/meisnate12/Plex-Meta-Manager synced 2024-11-10 06:54:21 +00:00

History

meisnate12 cd4b7b971c [63] translation update		2022-09-30 11:56:13 -04:00
..
award	[63] translation update	2022-09-30 11:56:13 -04:00
both	[63] translation update	2022-09-30 11:56:13 -04:00
chart	[56] Add PMM defaults	2022-09-27 02:19:29 -04:00
movie	[56] Add PMM defaults	2022-09-27 02:19:29 -04:00
overlays	[58] update resolution overlay	2022-09-27 13:47:49 -04:00
show	[56] Add PMM defaults	2022-09-27 02:19:29 -04:00
translations	[63] translation update	2022-09-30 11:56:13 -04:00
playlist.yml	[56] Add PMM defaults	2022-09-27 02:19:29 -04:00
README.md	Initial push of individual yaml files for defaults	2022-09-27 15:58:17 -04:00
templates.yml	[62] update translations	2022-09-30 08:51:27 -04:00

README.md

Default Collections & Overlays

Plex Meta Manager includes a pre-created set of Metadata Files and Overlay Files which can be found in the "defaults" folder in the root of your Plex Meta Manager installation directory.

These files offer an easy-to-use and customizable set of Collections and Overlays that the user can achieve without having to worry about creating the files that makes the collections and overlays possible.

All Collections come with a matching poster to make a clean, consistent set of collections in your library. These files are stored in the Plex Meta Manager Images Repository and each poster is downloaded straight to your Plex Collection when you run Plex Meta Manager.

It should be noted that users running the on nightly branch of Plex Meta Manager will receive all updates to the PMM Defaults as soon as they are published via GitHub, which may at times involve bugs or implementations that need to be further addressed. Users of the develop and master branches will only receive updated Defaults files when an update to Plex Meta Manager is released - this helps to protect to keep these branches stable and prevent bugs from reaching the wider user-base.

Credits to Bullmoose20 and Yozora for helping drive this entire Default Set of Configs through the concept, design and implementation.

Special thanks to Magic815 for the overlay image inspiration and base template.

Please consider donating towards the project.

Example Collection Configuration

To run a defaults metadata file, you can simply add it to your metadata_path using pmm: like so:

libraries:
  Movies:
    metadata_path:
    - pmm: chart/tmdb
    - pmm: awards/bafta

A full list of the available metadata files can be found [HERE](LINK NEEDED)

Example Overlay Configurations

To run a defaults OVERLAY file, you can simply add it to your overlay_path using pmm: like so:

libraries:
  Movies:
    overlay_path:
    - remove_overlays: false
    - pmm: overlays/imdb_top_250
    - pmm: overlays/ratings

A full list of the available overlay files can be found [HERE](LINK NEEDED)

Example Poster Overlays

Click to expand sample config.yml Movies overlays section:

libraries:
  Movies:
    overlay_path:
    - remove_overlays: false
    - reapply_overlay: true
    - pmm: overlays/resolution                                       # 1
    - pmm: overlays/audio_codec                                      # 2
    - pmm: overlays/mediastinger                                     # 3
    - pmm: overlays/special_release                                  # 4
    - pmm: overlays/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_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_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_size: 70                                            # 7 adjusted font size to fit rating

        horizontal_position: right                                       # the set of ratings is on the right of the poster
    - pmm: overlays/streaming                                        # 8
    - pmm: overlays/video_format                                     # 9
    - pmm: overlays/audio_language                                   # 10
    - pmm: overlays/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
    - 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
    - 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
    - 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
    - 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
      mass_audience_rating_update: tmdb                                  # 7 This operation will update the audience rating in plex with TMDb ratings information

Example TV Shows - Show Overlays

Click to expand sample config.yml TV Shows overlays section for the Show Poster:

libraries:
  TV Shows:
    overlay_path:
    - remove_overlays: false
    - reapply_overlay: true
    - pmm: overlays/resolution                                       # 1
    - pmm: overlays/audio_codec                                      # 2
    - pmm: overlays/mediastinger                                     # 3
    - pmm: overlays/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_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_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_size: 70                                            # 6 adjusted font size to fit rating

        horizontal_position: right                                       # the set of ratings is on the right of the poster
    - pmm: overlays/streaming                                        # 7
    - pmm: overlays/video_format                                     # 8
    - 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
    - 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
    - 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
    - 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                              # 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_audience_rating_update: tmdb                                  # 6 This operation will update the audience rating in plex with TMDb ratings information

Example TV Shows - Season Overlays

Click to expand sample config.yml TV Shows overlays section for the Season Poster:

libraries:
  TV Shows:
    overlay_path:
    - remove_overlays: false
    - reapply_overlay: true
    - pmm: overlays/resolution                                       # 1
      template_variables:
        overlay_level: season
    - pmm: overlays/audio_codec                                      # 2
      template_variables:
        overlay_level: season
    - pmm: overlays/video_format                                     # 3
      template_variables:
        overlay_level: season

Example TV Shows - Episode Overlays

Click to expand sample config.yml TV Shows overlays section for the Episode Poster:

libraries:
  TV Shows:
    overlay_path:
    - remove_overlays: false
    - reapply_overlay: true
    - pmm: overlays/resolution                                       # 1
      template_variables:
        overlay_level: episode
    - pmm: overlays/audio_codec                                      # 2
      template_variables:
        overlay_level: episode
    - pmm: overlays/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_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_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
    - pmm: overlays/video_format                                     # 5
      template_variables:
        overlay_level: episode
    - pmm: overlays/episode_info                                     # 6
      template_variables:
        overlay_level: episode
    - pmm: overlays/runtimes                                         # 7
      template_variables:
        overlay_level: episode

    operations:
      mass_episode_critic_rating_update: imdb                            # 3 This operation will update the episodes critic rating in plex with IMDb ratings information
      mass_episode_audience_rating_update: tmdb                          # 4 This operation will update the episodes audience rating in plex with TMDb ratings information

Separators

By default, most metadata files use separators to denote different sections of collection like actor collections vs studio collections.

Click to expand to see an example of Separators.

Can be turned off by customizing your config

Collection Section Order

Almost every default metadata file has a collection_section attribute. These attributes determine the order of the various sections and can be set by customizing your config.

For example: collection_section:01 translates to sort_title: "!<<collection_section>><<pre>><<order_<<key>>>><<sort>>" and so for genre.yml if you have a Fantasy collection, plex is going to show !06_Fantasy

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

Ratings Overlays

By default for Movies in Plex, the Ratings Source dropdown (#3) below, can come from Rotten Tomatoes (and includes Critic Ratings and Audience Ratings) or IMDb (Audience Ratings). This only changes the tiny icons displayed and where Plex will retrieve the ratings from upon initial scan and import of the media metadata.

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).

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.

mass_*_rating_update sources can be found here: 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)

Customizing Configs

Configs can be customized using the template_variables attribute when calling the file. These template_variables will be given to every template call in the file which allows them to affect how that file runs.

This example changes the ratings overlay to work on episodes.

libraries:
  TV Shows:
    overlay_path:
    - pmm: overlays/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 has this:

#############################################################
#                 Dynamic Genre Collections                 #
#         Created by Yozora, Bullmoose20, & Sohjiro         #
#############################################################
#  Call this from your config.yml (Movie or Show)           #
#  If nothing is specified these are the defaults           #
#                                                           #
#    metadata_path:                                         #
#      - pmm: genre                                     #
#        template_variables:                                #
#          # Turn the separator collection on/off           #
#          use_separator: true                              #
#          # Sets how the collection is sorted              #
#          sort_by: release.desc                            #
#          # Sets the collection mode of the collection     #
#          collection_mode:                                 #
#          # Sets the value at the start of the sort title  #
#          collection_section: "06"                         #
#############################################################

Each of these when passed will change how the collection runs slightly.

use_separator Turn the separator collection on/off
sort_by Sets how the collection is sorted
collection_mode Sets the collection mode of the collection
collection_section Sets the value at the start of the sort title

In addition to the defined template_variables each file in the PMM Folder has access to the radarr_add_missing and sonarr_add_missing template variables and for dynamic collections most attributes can be passed as template variables

For example if you want yearly oscar collections that go back 10 years instead of 5 all of which gets sent to radarr use the data and radarr_add_missing template variables.

libraries:
  Movies:
    metadata_path:
    - pmm: award/oscars
      template_variables:
        radarr_add_missing: true
        data:
          starting: current_year-10
          ending: current_year

Or maybe you want to change the number of actor collections made using PMM/actor.

libraries:
  Movies:
    overlay_path:
    - pmm: actor
      template_variables:
        collection_mode: hide
        data:
          depth: 5
          limit: 50

Or maybe you want to change the collection sort order of the genre collections using PMM/genre.

libraries:
  Movies:
    metadata_path:
    - pmm: genre
      template_variables:
        collection_section: 11

Or maybe you want to disable separators globally per library.

libraries:
  LIBRARYNAME:
    template_variables:
      use_separator: false
    metadata_path:

Alternatively it can be turned off individually per git file:

libraries:
  LIBRARYNAME:
    metadata_path:
      - pmm: <file1>    # separator is disabled
        template_variables:
          use_separator: false
      - pmm: <file2>    # separator is enabled by default
      - pmm: <file3>    # separator is disabled
        template_variables:
          use_separator: false

Errors

If there are collections being made that have configuration errors or missing posters please either bring it up in our Discord or raise an Issue on the Configs Repo.

Example Configuration File

Click to expand sample config.yml file:

libraries:
  Movies:
    metadata_path:
    - pmm: award/bafta
    - pmm: award/cannes
    - pmm: award/choice
    - pmm: award/golden
    - pmm: award/oscars
    - pmm: award/other
    - pmm: award/spirit
    - pmm: award/sundance
    - pmm: chart/anilist
    - pmm: chart/basic
    - pmm: chart/imdb
    - pmm: chart/myanimelist
    - pmm: chart/other
    - pmm: chart/tautulli
    - pmm: chart/tmdb
    - pmm: chart/trakt
    - pmm: actor
    - pmm: audio_language
    - pmm: movie/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: movie/country
    - pmm: movie/decade
    - pmm: movie/director
    - pmm: movie/franchise
    - pmm: movie/universe
    - pmm: movie/producer
    - pmm: movie/seasonal
    - pmm: movie/writer
    overlay_path:
    - remove_overlays: false
    - pmm: overlays/audio_codec
    - pmm: overlays/audio_language
    - pmm: overlays/commonsense
    - pmm: overlays/direct_play
    - pmm: overlays/mediastinger
    - pmm: overlays/imdb_top_250
    - pmm: overlays/mc_must_see
    - pmm: overlays/rt_cert_fresh
    - pmm: overlays/commonsense_selection
    - pmm: overlays/ratings
      template_variables:
        rating1: critic
        rating1_image: rt_tomato
    - pmm: overlays/resolution
    - pmm: overlays/special_release
    - pmm: overlays/streaming
    - pmm: overlays/versions
    - pmm: overlays/video_format
  TV Shows:
    metadata_path:
    - pmm: award/choice
    - pmm: award/golden
    - pmm: award/emmy
    - pmm: chart/anilist
    - pmm: chart/basic
    - pmm: chart/imdb
    - pmm: chart/myanimelist
    - pmm: chart/other
    - pmm: chart/tautulli
    - pmm: chart/tmdb
    - pmm: chart/trakt
    - pmm: actor
    - pmm: audio_language
    - pmm: show/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: show/country
    - pmm: show/decade
    - pmm: show/network
    overlay_path:
    - remove_overlays: false
    - pmm: overlays/audio_codec
    - pmm: overlays/audio_codec
      template_variables:
        overlay_level: episode
    - pmm: overlays/audio_codec
      template_variables:
        overlay_level: season
    - pmm: overlays/audio_language
    - pmm: overlays/audio_language
      template_variables:
        overlay_level: episode
    - pmm: overlays/audio_language
      template_variables:
        overlay_level: season
    - pmm: overlays/commonsense
    - pmm: overlays/commonsense
      template_variables:
        overlay_level: episode
    - pmm: overlays/commonsense
      template_variables:
        overlay_level: season
    - pmm: overlays/direct_play
    - pmm: overlays/direct_play
      template_variables:
        overlay_level: episode
    - pmm: overlays/direct_play
      template_variables:
        overlay_level: season
    - pmm: overlays/episode_info
      template_variables:
        overlay_level: episode
    - pmm: overlays/mediastinger
    - pmm: overlays/mediastinger
      template_variables:
        overlay_level: episode
    - pmm: overlays/mediastinger
      template_variables:
        overlay_level: season
    - pmm: overlays/imdb_top_250
    - pmm: overlays/imdb_top_250
      template_variables:
        overlay_level: episode
    - pmm: overlays/imdb_top_250
      template_variables:
        overlay_level: season
    - pmm: overlays/mc_must_see
    - pmm: overlays/mc_must_see
      template_variables:
        overlay_level: episode
    - pmm: overlays/mc_must_see
      template_variables:
        overlay_level: season
    - pmm: overlays/rt_cert_fresh
    - pmm: overlays/rt_cert_fresh
      template_variables:
        overlay_level: episode
    - pmm: overlays/rt_cert_fresh
      template_variables:
        overlay_level: season
    - pmm: overlays/commonsense_selection
    - pmm: overlays/commonsense_selection
      template_variables:
        overlay_level: episode
    - pmm: overlays/commonsense_selection
      template_variables:
        overlay_level: season
    - pmm: overlays/ratings
      template_variables:
        rating2: audience
        rating2_image: imdb
    - pmm: overlays/ratings
      template_variables:
        rating2: audience
        rating2_image: imdb
        overlay_level: episode
    - pmm: overlays/resolution
    - pmm: overlays/resolution
      template_variables:
        overlay_level: episode
    - pmm: overlays/resolution
      template_variables:
        overlay_level: season
    - pmm: overlays/runtimes
      template_variables:
        overlay_level: episode
    - pmm: overlays/special_release
    - pmm: overlays/special_release
      template_variables:
        overlay_level: episode
    - pmm: overlays/special_release
      template_variables:
        overlay_level: season
    - pmm: overlays/streaming
    - pmm: overlays/versions
    - pmm: overlays/versions
      template_variables:
        overlay_level: episode
    - pmm: overlays/versions
      template_variables:
        overlay_level: season
    - pmm: overlays/versions
      template_variables:
        overlay_level: show
    - pmm: overlays/video_format
    - pmm: overlays/video_format
      template_variables:
        overlay_level: episode
    - pmm: overlays/video_format
      template_variables:
        overlay_level: season
playlist_files:
- pmm: playlist