Plex-Meta-Manager

7 Operations Attributes

There are multiple different Library Operations you can have preformed on each of your libraries.

You can define which operations you want to run under the operations attribute you can define per library.

A simple example of using some operations is below:

libraries:
  Movies:
    metadata_path:
      - git: meisnate12/MovieCharts
    operations:
      mass_critic_rating_update: tmdb
      split_duplicates: true

The available operations attributes for each library are as follows

Name	Attribute	Description	Allowed Values
TMDb Collections	`tmdb_collections`	Builds Collections for every movie in your library based on TMDb Collections	`tmdb_collections` mapping details
Genre Collections	`genre_collections`	Builds Collections for every genre in your library	`genre_collections` mapping details
Genre Mapper	`genre_mapper`	Will check every item in your library and changed mapped genres	`genre_mapper` mapping details
Image Assets For All	`assets_for_all`	Search in assets for images for every item in your library	`true` or `false`
Delete Collections With Less	`delete_collections_with_less`	Deletes every collection with less then the given number	number greater then 0
Delete Unmanaged Collections	`delete_unmanaged_collections`	Deletes every unmanaged collection	`true` or `false`
Mass Genre Update	`mass_genre_update`	Updates every item's genres in the library to the chosen site's genres	`tmdb`: Use TMDb for Genres `tvdb`: Use TVDb for Genres `omdb`: Use IMDb through OMDb for Genres
Mass Audience Rating Update	`mass_audience_rating_update`	Updates every item's audience rating in the library to the chosen site's rating	`tmdb`: Use TMDb for Rating `omdb`: Use IMDb through OMDb for Rating
Mass Critic Rating Update	`mass_critic_rating_update`	Updates every item's critic rating in the library to the chosen site's rating	`tmdb`: Use TMDb for Rating `omdb`: Use IMDb through OMDb for Rating
Mass Trakt Rating Update	`mass_trakt_rating_update`	Updates every movie/show's user rating in the library to match your custom rating on Trakt if there is one	`true` or `false`
Mass Collection Mode	`mass_collection_mode`	Updates every Collection in your library to the specified Collection Mode	`default`: Library default `hide`: Hide Collection `hide_items`: Hide Items in this Collection `show_items`: Show this Collection and its Items
Split Duplicates	`split_duplicates`	Splits all duplicate movies/shows found in this library	`true` or `false`
Radarr Add All	`radarr_add_all`	Adds every item in the library to Radarr	`true` or `false`
Radarr Remove By Tag	`radarr_remove_by_tag`	Removes every item from Radarr with the Tags given	List or comma separated string of tags
Sonarr Add All	`sonarr_add_all`	Adds every item in the library to Sonarr	`true` or `false`
Sonarr Remove By Tag	`sonarr_remove_by_tag`	Removes every item from Sonarr with the Tags given	List or comma separated string of tags

When using radarr_add_all or sonarr_add_all the existing paths in plex will be used as the root folder of each item.
If the paths in Plex are not the same as your Radarr/Sonarr paths you can use the plex_path and radarr_path/sonarr_path Radarr/Sonarr details to convert the paths

TMDb Collections

This operation will scan every movie in your library and create collections based on a template for those collections.

To run the most basic way you can just leave tmdb_collections blank like so:

library:
  Movies:
    operations:
      tmdb_collections:

This will run all collections found with this default template:

library:
  Movies:
    operations:
      tmdb_collections:
        template:
          tmdb_collection_details: <<collection_id>>

Where <<collection_id>> is the TMDb Collection ID.

To change the template for more complex runs you can use the template attribute to define the template that is used for the operation like so:

library:
  Movies:
    operations:
      tmdb_collections:
        template:
          tmdb_collection_details: <<collection_id>>
          collection_order: release

Remember if you define your own template you need to use the <<collection_id>> template variable to differentiate the collections.

There are other attributes that can be used under tmdb_collections

exclude_ids: list or comma separate list of TMDb Collection IDs to ignore
remove_suffix: Removes the suffix given from the TMDb Collection names. i.e. Star Wars Collection -> Star Wars. Multiple suffixes can be given as a list or comma separated string.
dictionary_variables: Variable changes by TMDb Collection ID this can allow you to have other attributes change per Collection.

library:
  Movies:
    operations:
      tmdb_collections:
        exclude_ids:
          - 10
        remove_suffix: Collection
        dictionary_variables:
          my_collection_poster:
            119: https://www.themoviedb.org/t/p/original/oENY593nKRVL2PnxXsMtlh8izb4.jpg
            531241: https://www.themoviedb.org/t/p/original/nogV4th2P5QWYvQIMiWHj4CFLU9.jpg
        template:
          optional:
            - my_collection_poster
          tmdb_collection_details: <<collection_id>>
          collection_order: release
          url_poster: <<my_collection_poster>>

If the Collection is defined in another Metadata file (i.e. you define your own Star Wars Collection) then it will not run under tmdb_collections as long as the collection names match.

Genre Collections

This operation will build a collection for every genre in your library based on a template for those collections.

To run the most basic way you can just leave genre_collections blank like so:

library:
  Movies:
    operations:
      genre_collections:

This will run all genres found with this default template:

library:
  Movies:
    operations:
      genre_collections:
        title_format: "Top <<genre>> <<library_type>>s"
        template:
          smart_filter:
            limit: 50
            sort_by: critic_rating.desc
            all:
              genre: <<genre>>

Where <<genre>> is the Genre found in Plex and <<library_type>> is either Movie, Show, or Artist depending on your library type.

To change the template for more complex runs you can use the template attribute to define the template that is used for the operation like so:

library:
  Movies:
    operations:
      genre_collections:
        template:
          smart_filter:
            limit: 50
            sort_by: critic_rating.desc
            all:
              genre: <<genre>>
          collection_mode: hide

Remember if you define your own template you need to use the <<genre>> template variable to differentiate the collections.

There are other attributes that can be used under genre_collections

exclude_genres: list or comma separate list of Genres to ignore
title_format: Format you want the title in.
dictionary_variables: Variable changes by Genre this can allow you to have other attributes change per Collection.

library:
  Movies:
    operations:
      tmdb_collections:
        exclude_genres:
          - Family
        title_format: "Top <<genre>> <<library_type>>s on IMDb"
        dictionary_variables:
          my_collection_poster:
            Action: https://theposterdb.com/api/assets/69195
            Comedy: https://theposterdb.com/api/assets/69200
        template:
          optional:
            - my_collection_poster
          imdb_list: https://www.imdb.com/search/title/?title_type=feature&release_date=1990-01-01,&user_rating=5.0,10.0&num_votes=100000,&genres=<<genre>>
          collection_order: custom
          url_poster: <<my_collection_poster>>

If the Collection is defined in another Metadata file (i.e. you define your own Action Collection) then it will not run under genre_collections as long as the collection names match.

Genre Mapper

You can use the genre_mapper operation to map genres in your library.

Each attribute under genre_mapper is a separate mapping and has two parts.

The key (Action in the example below) is what the genres will end up as.
The value( Action/Adventure, Action & Adventure in the example below) is what genres you want mapped to the key.

So this example will change go through every item in your library and change the genre Action/Adventure or Action & Adventure to Action and Romantic Comedy to Comedy.

library:
  Movies:
    operations:
      genre_mapper:
        Action: Action/Adventure, Action & Adventure
        Comedy: Romantic Comedy

you can also use a list:

library:
  Movies:
    operations:
      genre_mapper:
        Action: 
         - Action/Adventure
         - Action & Adventure
        Comedy: Romantic Comedy

To just Remove a Genre without replacing it just set the Genre to nothing like this.

library:
  Movies:
    operations:
      genre_mapper:
        Action: Action/Adventure, Action & Adventure
        Romantic Comedy:

This example will change go through every item in your library and change the genre Action/Adventure or Action & Adventure to Action and remove every instance of the Genre Romantic Comedy.

TMDb Collections
Genre Collections
Genre Mapper

Want to contribute to this Wiki?

Home
Installation
Run Commands & Environmental Variables
Walkthroughs, Guides, and Best Practices
Configuration File
Metadata and Playlist Files
- Metadata
- Templates
- Filters
- Builders
- Details
Acknowledgements

Want to contribute to this Wiki?

Fork it and send a pull request.