* [rholder](https://github.com/rholder) and all other contributors for [retrying](https://github.com/rholder/retrying)
* [ZeroQI](https://github.com/ZeroQI) and all other contributors for [Absolute Series Scanner](https://github.com/ZeroQI/Absolute-Series-Scanner) and [HTTP Anidb Metadata Agent (HAMA)](https://github.com/ZeroQI/Hama.bundle)
* [ScudLee](https://github.com/ScudLee) and all other contributors for [AniDb Anime Lists](https://github.com/Anime-Lists/anime-lists)
* [Fribb](https://github.com/Fribb) and all other contributors for [MyAnimeList Metadata Agent](https://github.com/Fribb/MyAnimeList.bundle) and [MyAnimeList Anime Lists](https://github.com/Fribb/anime-lists)
* [Fribb](https://github.com/Fribb) and all other contributors for [MyAnimeList Metadata Agent](https://github.com/Fribb/MyAnimeList.bundle)
* [BeeeQueue](https://github.com/BeeeQueue) and all other contributors for [arm-server](https://github.com/BeeeQueue/arm-server)
@ -109,14 +110,31 @@ All the following attributes update various details of the collection's Metadata
| TMDb Person | `tmdb_person` | Used to change the collection's summary and poster to a TMDb Person's biography and profile as well as allow the people specified to be used in [Plex Searches](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Plex-Builders#plex-search) | TMDb Person ID (List or Comma-separated string) |
| Sort Title | `sort_title` | Used to change the collection's sort title | Text to change Sort Title |
| Content Rating | `content_rating` | Used to change the collection's content rating | Text to change Content Rating |
| Label | `label` | Used to change the collection's labels | Comma-separated string of labels to append or sync |
| Label Sync Mode | `label_sync_mode` | Used with `label` to change the label sync mode<br>**Default Mode:** `append` | `append`: Only Add Labels to the Item<br>`sync`: Add & Remove Labels from the Item |
| Label | `label` | Used to append new labels to the collection | Comma-separated string of labels to append |
| Label Sync | `label.sync` | Matches the labels of the collection to the labels provided | Comma-separated string of labels to sync |
| Collection Mode | `collection_mode` | Used to change the Collection Mode | `default`: Library default<br>`hide`: Hide Collection<br>`hide_items`: Hide Items in this Collection<br>`show_items`: Show this Collection and its Items |
| Collection Order | `collection_order` | Used to change the Collection Order | `release`: Order Collection by Release Dates<br>`alpha`: Order Collection Alphabetically | :heavy_check_mark: | :heavy_check_mark: |
* **Sort Title:** You can use `sort_title` to "promote" certain collections to the top of a library by creating a sort title starting with a `+` or "demote" certain collections to the bottom of a library by creating a sort title starting with a `~`.
* **Collection Order:** At this moment, Plex only allows filtering by alphabetical order or by release date, if you want Plex to allow a custom order please vote or post a comment on the Plex forum: [Topic - Plex Custom Collection Sorting](https://forums.plex.tv/t/custom-collection-sorting-machete-order/236226)
## Item Metadata Attributes
All the following attributes update various details of the metadata for every item in the collection.
| Name | Attribute | Description | Allowed Values | Works with Movies | Works with Shows |
| :--- | :--- | :--- | :---: | :---: |
| Label | `item_label` | Used to append new labels to every movie/show in the collection | Comma-separated string of labels to append | :heavy_check_mark: | :heavy_check_mark: |
| Label Sync | `item_label.sync` | Matches the labels of every movie/show in the collection to the labels provided | Comma-separated string of labels to sync | :heavy_check_mark: | :heavy_check_mark: |
| Episode Sorting | `item_episode_sorting` | Changes the episode sorting of every show in the collection | `default`: Library default<br>`oldest`: Oldest first<br>`newest`: Newest first | :x: | :heavy_check_mark: |
| Keep Episodes | `item_keep_episodes` | Changes the keep episodes of every show in the collection | `all`: All episodes<br>`5_latest`: 5 latest episodes<br>`3_latest`: 3 latest episodes<br>`latest`: Latest episodes<br>`past_3`: Episodes added in the past 3 days<br>`past_7`: Episodes added in the past 7 days<br>`past_30`: Episodes added in the past 30 days | :x: | :heavy_check_mark: |
| Delete Episodes | `item_delete_episodes` | Changes the delete episodes of every show in the collection | `never`: Never<br>`day`: After a day<br>`week`: After a week<br>`refresh`: On next refresh | :x: | :heavy_check_mark: |
| Season Display | `item_season_display` | Changes the season display of every show in the collection | `default`: Library default<br>`show`: Show<br>`hide`: Hide | :x: | :heavy_check_mark: |
| Episode Ordering | `item_episode_ordering` | Changes the episode ordering of every show in the collection | `default`: Library default<br>`tmdb_aired`*: The Movie Database (Aired)<br>`tvdb_aired`: TheTVDB (Aired)<br>`tvdb_dvd`: TheTVDB (DVD)<br>`tvdb_absolute`: TheTVDB (Absolute) | :x: | :heavy_check_mark: |
| Use Original Title* | `item_use_original_title` | Changes the use original title of every movie/show in the collection | `default`: Library default<br>`no`: No<br>`yes`: Yes | :heavy_check_mark: | :heavy_check_mark: |
\* Must be using the **New Plex Movie Agent** or the **New Plex TV Agent**
## Summary Attributes
All the following attributes update the summary of the collection from various sources.
@ -40,6 +40,8 @@ All collection filter options are listed below. To display collections filtered
| `critic_rating.lte` | Matches any movie/show whose critic rating is less then or equal to the specified critic rating | :heavy_check_mark: | :heavy_check_mark: |
| `audience_rating.gte` | Matches any movie/show whose audience rating is greater then or equal to the specified audience rating | :heavy_check_mark: | :heavy_check_mark: |
| `audience_rating.lte` | Matches any movie/show whose audience rating is less then or equal to the specified audience rating | :heavy_check_mark: | :heavy_check_mark: |
| `user_rating.gte` | Matches any movie/show whose user rating is greater then or equal to the specified user rating | :heavy_check_mark: | :heavy_check_mark: |
| `user_rating.lte` | Matches any movie/show whose user rating is less then or equal to the specified user rating | :heavy_check_mark: | :heavy_check_mark: |
| `tmdb_vote_count.gte` | Matches any movie/show whose TMDb vote count is greater then or equal to the specified count | :heavy_check_mark: | :heavy_check_mark: |
| `tmdb_vote_count.lte` | Matches any movie/show whose TMDb vote count is less then or equal to the specified count | :heavy_check_mark: | :heavy_check_mark: |
| `duration.gte` | Matches any movie/show whose duration is greater then or equal to the specified duration in minutes | :heavy_check_mark: | :x: |
| Library Type | `library_type` | `movie` (For Movie Libraries)<br>`show` (For Show Libraries) | N/A | :heavy_check_mark: |
| Library Name | `library_name` | Library name (Only needed when trying to use multiple libraries with the same name) | Base Attribute Name | :x: |
| Metadata Path | `metadata_path` | System Location for the Metadata YAML file | Same directory as config YAML file | :x: |
| Mass Genre Update | `mass_genre_update` | Updates every movie/show in the library to the chosen site's genres<br>`tmdb`: Use TMDb for Genres<br>`omdb`: Use IMDb through OMDb for Genres | No Update | :x: |
@ -30,23 +26,20 @@ The available attributes for each library are as follows
* Library mappings must have a colon (:) placed after them
* Each library must have a different name. If you want to use multiple libraries with the same name you can use the `library_name` attribute to specify the real Library Name and just have a placeholder as the library mapping name. A simple example is below:
@ -45,7 +45,8 @@ The available attributes for each movie/show are as follows
| Title | `title` | Title if different from the mapping value useful when you have multiple movies with the same name | :heavy_check_mark: | :heavy_check_mark: |
| Alternative Title | `alt_title` | Alternative title to look for | :heavy_check_mark: | :heavy_check_mark: |
| Year | `year` | Year of movie/show for better identification | :heavy_check_mark: | :heavy_check_mark: |
| TMDb Show ID | `tmdb_id` | TMDb Show ID to use for metadata useful for miniseries that have been compiled into a movie | :heavy_check_mark: | :x: |
| TMDb Show ID | `tmdb_show` | TMDb Show ID to use for metadata useful for miniseries that have been compiled into a movie | :heavy_check_mark: | :heavy_check_mark: |
| TMDb Movie ID | `tmdb_movie` | TMDb Movie ID to use for metadata useful for movies that have been split into segments | :heavy_check_mark: | :heavy_check_mark: |
@ -112,3 +113,11 @@ You can add `.sync` to any tag attribute to sync all tags vs just appending the
\* Must be using the **New Plex Movie Agent** or the **New Plex TV Agent**
## Image Attributes
| Name | Attribute | Description | Allowed Values |
| :--- | :--- | :--- | :--- |
| URL Poster | `url_poster` | Used to change the movie/show's poster to the URL | URL of image publicly available on the internet |
| File Poster | `file_poster` | Used to change the movie/show's poster to the image in the file system | Path to image in the file system |
| URL Background | `url_background` | Use to change the movie/show's background to the URL | URL of image publicly available on the internet |
| File Background | `file_background` | Used to change the movie/show's background to the image in the file system | Path to image in the file system |
| Cache | `cache` | Should the script store a cache<br>**boolean:** true or false | true | :heavy_check_mark: | :x: | :x: |
| Cache | `cache` | Create a cache database for faster processing. The cache file is created in the same location as your config file.<br>**boolean:** true or false | true | :heavy_check_mark: | :x: | :x: |
| Cache Expiration | `cache_expiration` | Number of days before each cache mapping expires and has to be reloaded | 60 | :heavy_check_mark: | :x: | :x: |
| Image Asset Folders | `asset_folders` | Search in assets for named folders vs named files<br>i.e. `assets/Star Wars.png` vs `assets/Star Wars/poster.png` | true | :heavy_check_mark: | :heavy_check_mark: | :x: |
| Image Asset For All* | `assets_for_all` | Search in assets for images for every item in your library | false | :heavy_check_mark: | :heavy_check_mark: | :x: |
| Sync Mode | `sync_mode` | `append`: Only Add Items to the Collection<br>`sync`: Add & Remove Items from the Collection | append | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| [Run Again Delay](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Collection-Details#setting-attributes) | `run_again_delay` | Number of minutes to run `run_again` collections after daily run is finished<br>**number:** 0 or greater | 0 | :heavy_check_mark: | :x: | :x: |
| Show Unmanaged Collections | `show_unmanaged` | Show collections not managed by Plex Meta Manager at the end of each run<br>**boolean:** true or false | true | :heavy_check_mark: | :heavy_check_mark: | :x: |
@ -28,7 +32,7 @@ settings:
| Show Missing | `show_missing` | Library Level toggle to show movies/shows missing from collections<br>**boolean:** true or false | true | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| Save Missing | `save_missing` | Library Level toggle to save movies/shows missing from collections to a file next to you Metadata file<br>**boolean:** true or false | true | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
* The cache database file is created in the same location as your config file.
\* The file/folder name in your assets directory must match the folder name the media is stored in. i.e. if you have `Movies/Star Wars (1977)/Star Wars (1977) [1080p].mp4` then your asset directory would look at `assets/Star Wars (1977)/poster.png` for the poster
## Image Asset Directory
The Image Asset Directory can be used to update the posters and backgrounds of collections and the movies and shows inside them. If you want to add multiple Image Asset Directories you have to use a list. Comma-separated values will not work.
@ -45,6 +49,8 @@ After the folder has been created you can add a `poster.ext` or `background.ext`
If you want to update the posters of a show's seasons, inside the shows' assets folder you can add a `Season##.ext` file to update the poster of the specified season (replacing `##` with the zero padded season number and `.ext` with the image extension).
If you want to update the posters of a show's episodes, inside the shows' assets folder you can add a `S##E##.ext` file to update the poster of the specified episode (replacing the first `##` with the zero padded season number, the second `##` with the zero padded episode number, and `.ext` with the image extension).
Here's an example config folder structure with an assets directory.
meisnate12
3 years ago