Library Operations¶
There are a variety of Library Operations that can be utilized in a library.
Within each library, operations can be defined by using the operations
attribute, as demonstrated below.
libraries:
Movies:
metadata_path:
- pmm: imdb
operations:
mass_critic_rating_update: tmdb
split_duplicates: true
The available attributes for the operations attribute are as follows
Attribute |
Description |
Movies |
Shows |
Music |
---|---|---|---|---|
Search in assets for images for every item in your library. |
✅ |
✅ |
✅ |
|
Deletes collections based on a set of given attributes. |
✅ |
✅ |
✅ |
|
Updates every item’s genres in the library to the chosen site’s genres. |
✅ |
✅ |
✅ |
|
Updates every item’s content rating in the library to the chosen site’s content rating. |
✅ |
✅ |
❌ |
|
Updates every item’s original title in the library to the chosen site’s original title. |
✅ |
✅ |
❌ |
|
Updates every item’s studio in the library to the chosen site’s studio. |
✅ |
✅ |
❌ |
|
Updates every item’s originally available date in the library to the chosen site’s date. |
✅ |
✅ |
❌ |
|
Updates every item’s audience/critic/user rating in the library to the chosen site’s rating. |
✅ |
✅ |
❌ |
|
Updates every item’s episode’s audience/critic/user rating in the library to the chosen site’s rating. |
❌ |
✅ |
❌ |
|
Updates every item’s poster to the chosen sites poster. Will fallback to |
✅ |
✅ |
❌ |
|
Updates every item’s background to the chosen sites background. Will fallback to |
✅ |
✅ |
❌ |
|
Updates every item’s labels in the library to match the IMDb Parental Guide. |
✅ |
❌ |
❌ |
|
Updates every Collection in your library to the specified Collection Mode. |
✅ |
❌ |
❌ |
|
Search though every track in a music library and replace any blank track titles with the tracks sort title. |
❌ |
❌ |
✅ |
|
Search through every title and remove all ending parentheses in an items title if the title is not locked. |
✅ |
✅ |
❌ |
|
Splits all duplicate movies/shows found in this library. |
✅ |
✅ |
❌ |
|
Adds every item in the library to Radarr. |
✅ |
❌ |
❌ |
|
Removes every item from Radarr with the Tags given. |
✅ |
❌ |
❌ |
|
Adds every item in the library to Sonarr. |
❌ |
✅ |
❌ |
|
Removes every item from Sonarr with the Tags given. |
❌ |
✅ |
❌ |
|
Allows genres to be changed to other genres or be removed from every item in your library. |
✅ |
✅ |
❌ |
|
Allows content ratings to be changed to other content ratings or be removed from every item in your library. |
✅ |
✅ |
❌ |
|
Creates/Maintains a PMM Metadata File with a full |
✅ |
✅ |
✅ |
Assets For All¶
Search in assets for images for every item in your library.
Attribute: assets_for_all
Values: true
or false
Delete Collections¶
Deletes collections based on a set of given attributes. The Collection must match all set attributes to be deleted.
Attribute: delete_collections
Values: There are a few different options to determine how the delete_collections
works.
Attribute |
Description |
---|---|
|
Values: |
|
Values: |
|
Collection must contain less then the given number of items to be deleted. |
Example:
Removes all Managed Collections (Collections with the PMM
Label) that are not configured in the Current Run.
library:
Movies:
operations:
delete_collections:
configured: false
managed: true
Mass Genre Update¶
Updates every item’s genres in the library to the chosen site’s genres.
Attribute: mass_genre_update
Values:
Value |
Description |
---|---|
|
Use TMDb for Genres |
|
Use TVDb for Genres |
|
Use IMDb for Genres |
|
Use IMDb through OMDb for Genres |
|
Use AniDB Main Tags for Genres |
|
Use AniDB Main Tags and All 3 Star Tags and above for Genres |
|
Use AniDB Main Tags and All 2.5 Star Tags and above for Genres |
|
Use AniDB Main Tags and All 2 Star Tags and above for Genres |
|
Use AniDB Main Tags and All 1.5 Star Tags and above for Genres |
|
Use AniDB Main Tags and All 1 Star Tags and above for Genres |
|
Use AniDB Main Tags and All 0.5 Star Tags and above for Genres |
|
Use MyAnimeList for Genres |
|
Lock Genre Field |
|
Unlock Genre Field |
|
Remove all Genres and Lock Field |
|
Remove all Genres and Unlock Field |
Mass Content Rating Update¶
Updates every item’s content rating in the library to the chosen site’s content rating.
Attribute: mass_content_rating_update
Values:
Value |
Description |
---|---|
|
Use MdbList for Content Ratings |
|
Use Commonsense Rating through MDbList for Content Ratings |
|
Use Commonsense Rating with Zero Padding through MDbList for Content Ratings |
|
Use IMDb through OMDb for Content Ratings |
|
Use MyAnimeList for Content Ratings |
|
Lock Content Rating Field |
|
Unlock Content Rating Field |
|
Remove Content Rating and Lock Field |
|
Remove Content Rating and Unlock Field |
Mass Original Title Update¶
Updates every item’s original title in the library to the chosen site’s original title.
Attribute: mass_original_title_update
Values:
Value |
Description |
---|---|
|
Use AniDB Main Title for Original Titles |
|
Use AniDB Official Title based on the language attribute in the config file for Original Titles |
|
Use MyAnimeList Main Title for Original Titles |
|
Use MyAnimeList English Title for Original Titles |
|
Use MyAnimeList Japanese Title for Original Titles |
|
Lock Original Title Field |
|
Unlock Original Title Field |
|
Remove Original Title and Lock Field |
|
Remove Original Title and Unlock Field |
Mass Studio Update¶
Updates every item’s studio in the library to the chosen site’s studio.
Attribute: mass_studio_update
Values:
Value |
Description |
---|---|
|
Use AniDB Animation Work for Studio |
|
Use MyAnimeList Studio for Studio |
|
Use TMDb Studio for Studio |
|
Lock Original Title Field |
|
Unlock Original Title Field |
|
Remove Original Title and Lock Field |
|
Remove Original Title and Unlock Field |
Mass Originally Available Update¶
Updates every item’s originally available date in the library to the chosen site’s date.
Attribute: mass_originally_available_update
Values:
Value |
Description |
---|---|
|
Use TMDb Release Date |
|
Use TVDb Release Date |
|
Use IMDb Release Date through OMDb |
|
Use MdbList Release Date |
|
Use AniDB Release Date |
|
Use MyAnimeList Release Date |
|
Lock Originally Available Field |
|
Unlock Originally Available Field |
|
Remove Originally Available and Lock Field |
|
Remove Originally Available and Unlock Field |
Mass * Rating Update¶
Updates every item’s audience/critic/user rating in the library to the chosen site’s rating.
IMPORTANT NOTE: This does not affect the icons displayed in the Plex UI. This will place the number of your choice in the relevant field in the Plex database. In other words, if Plex is configured to use Rotten Tomatoes ratings, then no matter what happens with this mass rating update operation, the icons in the Plex UI will remain Rotten Tomatoes. The human who decided to put TMDB ratings in the critic slot and Letterboxd ratings in the audience slot is the only party who knows that the ratings are no longer Rotten Tomatoes. One primary use of this feature is to put ratings overlays on posters. More information on what PMM can do with these ratings can be found here.
Attribute: mass_audience_rating_update
/mass_critic_rating_update
/mass_user_rating_update
Values:
Value |
Description |
---|---|
|
Use TMDb Rating |
|
Use IMDb Rating |
|
Use Trakt User’s Personal Rating |
|
Use IMDbRating through OMDb |
|
Use MdbList Score |
|
Use MdbList Average Score |
|
Use IMDb Rating through MDbList |
|
Use Metacritic Rating through MDbList |
|
Use Metacritic User Rating through MDbList |
|
Use Trakt Rating through MDbList |
|
Use Rotten Tomatoes Rating through MDbList |
|
Use Rotten Tomatoes Audience Rating through MDbList |
|
Use TMDb Rating through MDbList |
|
Use Letterboxd Rating through MDbList |
|
Use MyAnimeList Rating through MDbList |
|
Use AniDB Rating |
|
Use AniDB Average |
|
Use AniDB Review Score |
|
Use MyAnimeList Score |
|
Lock Rating Field |
|
Unlock Rating Field |
|
Remove Rating and Lock Field |
|
Remove Rating and Unlock Field |
Mass Episode * Rating Update¶
Updates every item’s episode’s audience/critic/user rating in the library to the chosen site’s rating.
Attribute: mass_episode_audience_rating_update
/mass_episode_critic_rating_update
/mass_episode_user_rating_update
Values:
Value |
Description |
---|---|
|
Use TMDb Rating |
|
Use IMDb Rating |
|
Lock Rating Field |
|
Unlock Rating Field |
|
Remove Rating and Lock Field |
|
Remove Rating and Unlock Field |
Mass Poster Update¶
Updates every item’s poster to the chosen sites poster. Will fallback to plex
if the given option fails. Assets will be used over anything else.
IMPORTANT NOTE: This does not affect the icons displayed in the Plex UI. This will place the number of your choice in the relevant field in the Plex database. In other words, if Plex is configured to use Rotten Tomatoes ratings, then no matter what happens with this mass rating update operation, the icons in the Plex UI will remain Rotten Tomatoes. The human who decided to put TMDB ratings in the critic slot and Letterboxd ratings in the audience slot is the only party who knows that the ratings are no longer Rotten Tomatoes. One primary use of this feature is to put ratings overlays on posters. More information on what PMM can do with these ratings can be found here.
Attribute: mass_poster_update
Values: There are a few different options to determine how the mass_poster_update
works.
Attribute |
Description |
---|---|
|
Source of the poster update |
|
Update season posters while updating shows |
|
Update episode posters while updating shows |
Example:
library:
TV Shows:
operations:
mass_poster_update:
source: tmdb
seasons: false
episodes: false
Mass Background Update¶
Updates every item’s background to the chosen sites background. Will fallback to plex
if the given option fails. Assets will be used over anything else.
Attribute: mass_background_update
Values: There are a few different options to determine how the mass_background_update
works.
Attribute |
Description |
---|---|
|
Source of the background update |
|
Update season backgrounds while updating shows |
|
Update episode backgrounds while updating shows |
Example:
library:
TV Shows:
operations:
mass_background_update:
source: tmdb
seasons: false
episodes: false
Mass IMDb Parental Labels¶
Updates every item’s labels in the library to match the IMDb Parental Guide.
Attribute: mass_imdb_parental_labels
Values:
Value |
Description |
---|---|
|
Apply all Parental Labels with a value of |
|
Apply all Parental Labels with a value of |
|
Apply all Parental Labels with a value of |
|
Apply all Parental Labels with a value of |
Mass Collection Mode¶
Updates every Collection in your library to the specified Collection Mode.
Attribute: mass_collection_mode
Values:
Value |
Description |
---|---|
|
Library default |
|
Hide Collection |
|
Hide Items in this Collection |
|
Show this Collection and its Items |
Update Blank Track Titles¶
Search though every track in a music library and replace any blank track titles with the tracks sort title.
Attribute: update_blank_track_titles
Values: true
or false
Remove Title Parentheses¶
Search through every title and remove all ending parentheses in an items title if the title is not locked.
Attribute: remove_title_parentheses
Values: true
or false
Split Duplicates¶
Splits all duplicate movies/shows found in this library.
Attribute: split_duplicates
Values: true
or false
Radarr Add All¶
Adds every item in the library to Radarr. 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 paths you can use the plex_path
and radarr_path
Radarr details to convert the paths.
Attribute: radarr_add_all
Values: true
or false
Radarr Remove By Tag¶
Removes every item from Radarr with the Tags given.
Attribute: radarr_remove_by_tag
Values: List or comma separated string of tags
Sonarr Add All¶
Adds every item in the library to Sonarr. 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 Sonarr paths you can use the plex_path
and sonarr_path
Sonarr details to convert the paths.
Attribute: sonarr_add_all
Values: true
or false
Sonarr Remove By Tag¶
Removes every item from Sonarr with the Tags given.
Attribute: sonarr_remove_by_tag
Values: List or comma separated string of tags
Genre Mapper¶
Maps genres in your library to be changed to other genres.
Attribute: genre_mapper
Values: Each attribute under genre_mapper
is a separate mapping and has two parts.
The key (
Action/Adventure, Action & Adventure
in the example below) is what genres you want mapped to the value.The value (
Action
in the example below) is what the genres will end up as.
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/Adventure": Action
"Action & Adventure": Action
Romantic Comedy: Comedy
To just Remove a Genre without replacing it just set the Genre to nothing like this.
library:
Movies:
operations:
genre_mapper:
"Action/Adventure": Action
"Action & Adventure": Action
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
.
Content Rating Mapper¶
Maps content ratings in your library to be changed to other content ratings.
Attribute: content_rating_mapper
Values: Each attribute under content_rating_mapper
is a separate mapping and has two parts.
The key (
PG
,PG-13
in the example below) is what content ratings you want mapped to the value.The value (
Y-10
in the example below) is what the content ratings will end up as.
So this example will change go through every item in your library and change the content rating PG
or PG-13
to Y-10
and R
to Y-17
.
library:
Movies:
operations:
content_rating_mapper:
PG: Y-10
"PG-13": Y-10
R: Y-17
To just Remove a content rating without replacing it just set the content rating to nothing like this.
library:
Movies:
operations:
content_rating_mapper:
PG: Y-10
"PG-13": Y-10
R:
This example will change go through every item in your library and change the content rating PG
or PG-13
to Y-10
and remove every instance of the content rating R
.
Metadata Backup¶
Creates/Maintains a Plex Meta Manager Metadata File with a full metadata
mapping based on the library’s items locked attributes.
If you point to an existing Metadata File then PMM will Sync the changes to the file, so you won’t lose non plex changes in the file.
Attribute: metadata_backup
Values: There are a few different options to determine how the metadata_backup
works.
Attribute |
Description |
---|---|
|
Path to where the metadata will be saved/maintained |
|
Exclude all listed attributes from being saved in the metadata file |
|
All Tag Attributes will have the |
|
Will add a line for entries that have no metadata changes |
Example:
library:
Movies:
operations:
metadata_backup:
path: config/Movie_Backup.yml
sync_tags: true
add_blank_entries: false