* [vladimir-tutin](https://github.com/vladimir-tutin) for writing the original [Plex Auto Collections](https://github.com/vladimir-tutin/Plex-Auto-Collections) which prompted the creation of Plex Meta Manager
* [mza921](https://github.com/mza921) and [burkasaurusrex](https://github.com/burkasaurusrex) for updating and maintaining a [Plex Auto Collections](https://github.com/mza921/Plex-Auto-Collections) fork of the original
* [bearlikelion](https://github.com/bearlikelion) for writing [popularplex](https://github.com/bearlikelion/popularplex) which served as inspiration for Tautulli support
* [jkirkcaldy](https://github.com/jkirkcaldy) for writing [plex-utills](https://github.com/jkirkcaldy/plex-utills) which served as inspiration for Image Overlay
## Dependency Acknowledgements
* [pkkid](https://github.com/pkkid) and all other contributors for [python-plexapi](https://github.com/pkkid/python-plexapi)
The available collection details for each collection are split into different sections
* [Settings Details](#setting-details)
* [Radarr Details](#radarr-details)
* [Sonarr Details](#sonarr-details)
* [Metadata Details](#metadata-details)
* [Item Metadata Details](#item-metadata-details)
* [Summary Details](#summary-details)
* [Poster Details](#poster-details)
* [Background Details](#background-details)
## Setting Details
All the following attributes serve various functions as how the collection functions inside of Plex Meta Manager.
| Name | Attribute | Description | Allowed Values |
| :--- | :--- | :--- | :--- |
| Schedule | `schedule` | Used to schedule this collection | [`schedule` mapping details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Schedule-Attribute) |
| Schedule | `schedule` | Used to schedule this collection | [`schedule` mapping details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Schedule-Detail) |
| Template | `template` | Used to specify a template and template variables to use for this collection | [`template` mapping details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Template-Attributes) |
| Run Again | `run_again` | Used to try and add all the items missing from the collection to the collection again after the daily run <br>**Default Mode:** `false`| **boolean:**`true` or `false` |
| Sync Mode | `sync_mode` | Used to change how collection builders sync with this collection<br>**Default Mode:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | `append`: Only Add Items to the Collection<br>`sync`: Add & Remove Items from the Collection |
@ -70,11 +70,11 @@ All the following attributes serve various functions as how the collection funct
| Show Missing Collections | `show_missing` | Collection level `show_missing` toggle<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | **boolean:**`true` or `false` |
| Save Missing Collections | `save_missing` | Collection level `save_missing` toggle<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | **boolean:**`true` or `false` |
| Name Mapping | `name_mapping` | Used to specify the folder name in the [Image Assets Directory](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes#image-asset-directory) | Folder Name In Assets Directory |
| Test Mode | `test` | When running in Test Mode (`---run-tests` [option](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Local-Installation#run-tests)) only collections with `test: true` will be run<br>**Default:** `false` | **boolean:**`true` or `false` |
| Test Mode | `test` | When running in Test Mode (`--run-tests` [option](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Local-Installation#run-tests)) only collections with `test: true` will be run<br>**Default:** `false` | **boolean:**`true` or `false` |
* **Name Mapping:** If your collection name contains characters that are not allowed in file paths (i.e. for windows `<`, `>`, `:`, `"`, `/`, `\`, `|`, `?`, `*` cannot be in the file path), but you want them in your collection name you can use the `name_mapping` attribute to specific this collection's name in the file system.
## Radarr Attributes
## Radarr Details
All the following attributes can override the global [Radarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Radarr-Attributes) attributes.
| Name | Attribute | Description | Allowed Values |
@ -86,8 +86,11 @@ All the following attributes can override the global [Radarr](https://github.com
| Radarr Tag | `radarr_tag` | Collection level `tag` attribute override for Radarr<br>**Default:** [Radarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Radarr-Attributes) library value | List or comma-separated string of tags |
| Radarr Search | `radarr_search` | Collection level `search` attribute override for Radarr<br>**Default:** [Radarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Radarr-Attributes) library value | **boolean:**`true` or `false` |
| Item Radarr Tag | `item_radarr_tag` | Used to append a tag in Radarr for every movie in the collection | List or comma-separated string of tags |
| Item Radarr Tag Remove | `item_radarr_tag.remove` | Used to remove existing tags in Radarr for every movie in the collection | List or comma-separated string of tags |
| Item Radarr Tag Sync | `item_radarr_tag.sync` | Matches the tags in Radarr for every movie in the collection with the provided tags | List or comma-separated string of tags |
## Sonarr Attributes
## Sonarr Details
All the following attributes can override the global [Sonarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Sonarr-Attributes) attributes.
| Name | Attribute | Description | Allowed Values |
@ -102,8 +105,11 @@ All the following attributes can override the global [Sonarr](https://github.com
| Sonarr Tag | `sonarr_tag` | Collection level `tag` attribute override for Sonarr<br>**Default:** [Sonarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Sonarr-Attributes) library value | List or comma-separated string of tags |
| Sonarr Search | `sonarr_search` | Collection level `search` attribute override for Sonarr<br>**Default:** [Sonarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Sonarr-Attributes) library value | **boolean:**`true` or `false` |
| Sonarr Cutoff Search | `sonarr_cutoff_search` | Collection level `cutoff_search` attribute override for Sonarr<br>**Default:** [Sonarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Sonarr-Attributes) library value | **boolean:**`true` or `false` |
| Item Sonarr Tag | `item_sonarr_tag` | Used to append a tag in Sonarr for every series in the collection | List or comma-separated string of tags |
| Item Sonarr Tag Remove | `item_sonarr_tag.remove` | Used to remove existing tags in Sonarr for every series in the collection | List or comma-separated string of tags |
| Item Sonarr Tag Sync | `item_sonarr_tag.sync` | Matches the tags in Sonarr for every series in the collection with the provided tags | List or comma-separated string of tags |
## Metadata Attributes
## Metadata Details
All the following attributes update various details of the collection's Metadata.
| Name | Attribute | Description | Allowed Values |
@ -116,11 +122,14 @@ All the following attributes update various details of the collection's Metadata
| 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: |
| Visible on Library | `visible_library` | Used to change collection visible on Library | `true`: Visible<br>`false`: Not Visible |
| Visible on Home | `visible_home` | Used to change collection visible on Home | `true`: Visible<br>`false`: Not Visible |
| Visible on Shared | `visible_shared` | Used to change collection visible on Shared Users' Home | `true`: Visible<br>`false`: Not Visible |
* **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
## Item Metadata Details
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 |
@ -128,6 +137,8 @@ All the following attributes update various details of the metadata for every it
| 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 Remove | `item_label.remove` | Used to remove existing labels from every movie/show in the collection | Comma-separated string of labels to remove | :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: |
| Image Overlay | `item_overlay` | Adds and overlay image to the poster of every movie/show in the collection | [`item_overlay` details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Image-Overlay-Attribute) | :heavy_check_mark: | :heavy_check_mark: |
| Check For Assets | `item_assets` | Checks your assets folders for assets of every movie/show in the collection | `true` or `false`<br>**Default:** false | :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: |
@ -138,7 +149,7 @@ All the following attributes update various details of the metadata for every it
\* Must be using the **New Plex Movie Agent** or the **New Plex TV Agent**
## Summary Attributes
## Summary Details
All the following attributes update the summary of the collection from various sources.
| Name | Attribute | Description | Allowed Values |
@ -152,7 +163,7 @@ All the following attributes update the summary of the collection from various s
| Trakt Description | `trakt_description` | Used to change the collection's summary to the Trakt List Description | Trakt List URL |
| Letterboxd Description | `letterboxd_description` | Used to change the collection's summary to the Letterboxd List Description | Letterboxd List URL |
## Poster Attributes
## Poster Details
All the following attributes update the poster of the collection from various sources.
| Name | Attribute | Description | Allowed Values |
@ -166,7 +177,7 @@ All the following attributes update the poster of the collection from various so
* If no poster is specified the script will look in the library's [Image Asset Directories](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes#image-asset-directory) for a folder named either the collection name or the `name_mapping` if specified and look for a `poster.ext` file in that folder (replacing .ext with the image extension).
## Background Attributes
## Background Details
All the following attributes update the background of the collection from various sources.
| Name | Attribute | Description | Allowed Values |
@ -9,7 +9,7 @@ You can use `plex_all: true` to start your filter from your entire library.
**Filters can be very slow. Try to build or narrow your collection using [Plex Search](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Plex-Builders#plex-search) if possible.**
## String Filters
String filters can be used with either no modifier or with `.not`, `.begins`, or `.ends`.
String filters can be used with either no modifier or with `.not`, `.begins`, `.ends`, or `.regex`.
String filter can take multiple values **only as a list**.
@ -19,8 +19,9 @@ String filter can take multiple values **only as a list**.
| :--- | :--- |
| No Modifier | Matches every item where the attribute contains the given string |
| `.not` | Matches every item where the attribute does not contain the given string |
| `begins` | Matches every item where the attribute begins with the given string |
| `ends` | Matches every item where the attribute ends with the given string |
| `.begins` | Matches every item where the attribute begins with the given string |
| `.ends` | Matches every item where the attribute ends with the given string |
| `.regex` | Matches every item where the attribute matches the regex given |
### Attribute
@ -65,7 +66,7 @@ The `original_language` filter will also filter out movies from being added to R
| `subtitle_language` | Uses the subtitle language tags to match | :heavy_check_mark: | :x: |
## Date Filters
Date filters can be used with either no modifier or with `.not`, `.before`, or `.after`.
Date filters can be used with either no modifier or with `.not`, `.before`, `.after`, or `.regex`.
No date filter can take multiple values.
@ -75,8 +76,9 @@ No date filter can take multiple values.
| :--- | :--- | :---: |
| No Modifier | Matches every item where the date attribute<br>is in the last X days | **Format:** number of days<br>e.g. `30` |
| `.not` | Matches every item where the date attribute<br>is not in the last X days | **Format:** number of days<br>e.g. `30` |
| `before` | Matches every item where the date attribute<br>is before the given date | **Format:** MM/DD/YYYY<br>e.g. `01/01/2000` |
| `after` | Matches every item where the date attribute<br>is after the given date | **Format:** MM/DD/YYYY<br>e.g. `01/01/2000` |
| `.before` | Matches every item where the date attribute<br>is before the given date | **Format:** MM/DD/YYYY<br>e.g. `01/01/2000` |
| `.after` | Matches every item where the date attribute<br>is after the given date | **Format:** MM/DD/YYYY<br>e.g. `01/01/2000` |
| `.regex` | Matches every item where the attribute matches the regex given | N/A |
### Attribute
@ -105,7 +107,7 @@ The `tmdb_vote_count` filter will also filter out movies/shows from being added
| `year` | Uses the year attribute to match | `1800` - `Current Year` | :heavy_check_mark: | :heavy_check_mark: |
| `critic_rating` | Uses the critic rating attribute to match | `0.0` - `10.0` | :heavy_check_mark: | :heavy_check_mark: |
| `audience_rating` | Uses the audience rating attribute to match | `0.0` - `10.0` | :heavy_check_mark: | :heavy_check_mark: |
@ -114,6 +116,15 @@ The `tmdb_vote_count` filter will also filter out movies/shows from being added
| `plays` | Uses the plays attribute to match | minimum: `1` | :heavy_check_mark: | :x: |
| `duration` | Uses the duration attribute to match using minutes | minimum: `1` | :heavy_check_mark: | :x: |
## Special Filters
Special Filters each have their own set of rules for how they're used.
### Attribute
| Special Filters | Description | Movie<br>Libraries | Show<br>Libraries |
| :--- | :--- | :---: | :---: |
| `history` | Uses the release date attribute (originally available) to match dates throughout history<br>`day`: Match the Day and Month to Today's Date<br>`month`: Match the Month to Today's Date<br>`1-30`: Match the Day and Month to Today's Date or `1-30` days before Today's Date | :heavy_check_mark: | :heavy_check_mark: |
@ -7,8 +7,7 @@ This wiki should tell you everything you need to know about the script to get it
[](https://hub.docker.com/r/meisnate12/plex-meta-manager)
You can build different collections using the lists on [icheckmovies.com](https://www.icheckmovies.com/) (ICheckMovies).
No configuration is required for these builders.
| Name | Attribute | Description | Works with Movies | Works with Shows |
| :--- | :--- | :--- | :---: | :---: |
| [ICheckMovies List](#icheckmovies-list) | `icheckmovies_list` | Gets every movie in the ICheckMovies List | :heavy_check_mark: | :x: |
| [ICheckMovies List Details](#icheckmovies-list) | `icheckmovies_list_details` | Gets every movie in the ICheckMovies List and updates the collection with the description of the ICheckMovies list | :heavy_check_mark: | :x: |
## ICheckMovies List
Gets every movie in the ICheckMovies List.
The expected input is a ICheckMovies List URL. Multiple values are supported as either a list or a comma-separated string.
In order to add an overlay to a set of items you must add `item_overlay: OVERLAY_NAME` to the collection config, where `OVERLAY_NAME` matches the exact name of a folder in your `overlays` directory.
Your `overlays` directory must be inside your config folder structured like below:
```
config
├── overlays
│ ├── OVERLAY_NAME
│ ├── overlay.png
```
* `OVERLAY_NAME` is the folder contacting your `overlay.png` and its name is what you give `item_overlay` to refer to this specific overlay.
* `overlay.png` is the overlay file with the banner. You can create you're own with this [PSD](https://github.com/meisnate12/Plex-Meta-Manager/blob/master/overlays.psd). The font can be found [here](https://www.dafontfree.net/freefonts-eurostile-extended-f123859.htm).
* An item can only be in one overlay search so make sure you exclude other searches when using multiple overlays.
* Posters will be backed up in the overlay director and if an item is removed from the search the original poster should be added back.
### Example Folder Structure
This is an example of the default set found [here](https://github.com/meisnate12/Plex-Meta-Manager/tree/master/config/overlays) which would have 5 overlay options `4K`, `4K-Dolby`, `4K-HDR`, `Dolby`, and `HDR` and have a directory structured like below:
```
config
├── config.yml
├── Movies.yml
├── TV Shows.yml
├── overlays
│ ├── 4K
│ ├── overlay.png
│ ├── 4K-Dolby
│ ├── overlay.png
│ ├── 4K-HDR
│ ├── overlay.png
│ ├── Dolby
│ ├── overlay.png
│ ├── HDR
│ ├── overlay.png
```
### Examples Collection Configs
#### 4K Overlay Only
Add a 4K overlay to all 4K Movies
```yaml
collections:
4K Overlay:
plex_search:
all:
resolution: 4K
item_overlay: 4K
build_collection: false
```
#### 4K and HDR Overlays
Here's an example of how you could add `4K`, `4K-HDR`, and `HDR` overlays
@ -5,7 +5,7 @@ No configuration is required for these builders.
| Name | Attribute | Description | Works with Movies | Works with Shows |
| :--- | :--- | :--- | :---: | :---: |
| [Letterboxd List](#letterboxd-list) | `letterboxd_list` | Gets every movie in the Letterboxd List | :heavy_check_mark: | :x: |
| [Letterboxd List Details](#letterboxd-list) | `letterboxd_list_details` | Gets every movie in the Letterboxd List and updates the collection with the description of the Letterboxd list | :heavy_check_mark: | :x: |
| [Letterboxd List Details](#letterboxd-list) | `letterboxd_list_details` | Gets every movie in the Letterboxd List and updates the collection with the description of the Letterboxd list | :heavy_check_mark: | :x: |
@ -35,6 +37,7 @@ The available attributes for each library are as follows
| Mass Genre Update | `mass_genre_update` | Updates every item's genres 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: |
| Mass Audience Rating Update | `mass_audience_rating_update` | Updates every item's audience rating in the library to the chosen site's rating<br>`tmdb`: Use TMDb for Rating<br>`omdb`: Use IMDb through OMDb for Rating | No Update | :x: |
| Mass Critic Rating Update | `mass_critic_rating_update` | Updates every item's critic rating in the library to the chosen site's rating<br>`tmdb`: Use TMDb for Rating<br>`omdb`: Use IMDb through OMDb for Rating | No Update | :x: |
| Split Duplicates | `split_duplicates` | Splits all duplicate movies/shows found in this library<br>`true` or `false` | `false` | :x: |
| Radarr Add All | `radarr_add_all` | Adds every item in the library to Radarr | No Adds | :x: |
| Sonarr Add All | `sonarr_add_all` | Adds every item in the library to Sonarr | No Adds | :x: |
@ -60,7 +60,7 @@ There are two different options when it comes to how the program looks at the fi
* Replace `.ext` with the image extension
By default, the program will only look inside the Image Asset Directories for Images when it runs a collection from a Metadata File. When it does this it will look not only for the collection images, but it will also look for images of every item in the collection.
By default, the program will only look inside the Image Asset Directories for Images when it runs a collection from a Metadata File. When it does this by default it will only look for the collection images, but you can have it look for images of every item in the collection if you add `item_assets: true` to the collection config.
If you're using `asset_folders` set to true you can also nest movie/show folders inside an Image Assets Collection Folder that contains that movie/show.
meisnate12
3 years ago