meisnate12
2 years ago
parent
1a9df0f38d
commit
8415a5fe43
|
After Width: | Height: | Size: 216 KiB |
|
After Width: | Height: | Size: 150 KiB |
|
After Width: | Height: | Size: 54 KiB |
|
After Width: | Height: | Size: 712 KiB |
|
Before Width: | Height: | Size: 318 KiB After Width: | Height: | Size: 318 KiB |
@ -0,0 +1,24 @@
|
||||
# Builders
|
||||
|
||||
Builders use third-party services to source items to be added to the collection. Multiple builders can be used in the same collection from a variety of sources listed below.
|
||||
|
||||
| Name | Description | Requires Config |
|
||||
|:--------------------------------------|:----------------------------------------------------------------------------------------------|:---------------:|
|
||||
| [Plex](builders/plex) | Grabs items based on the metadata inside your Plex Server. | ❌ |
|
||||
| [Smart](builders/smart) | Creates Smart Collections based on the metadata inside your Plex Server. (Collections Only) | ❌ |
|
||||
| [TMDb](builders/tmdb) | Grabs items based on metadata and lists on [TheMovieDb.org](https://www.themoviedb.org/). | ❌ |
|
||||
| [TVDb](builders/tvdb) | Grabs items based on metadata and lists on [TheTVDb.com](https://www.thetvdb.com/). | ✅ |
|
||||
| [IMDb](builders/imdb) | Grabs items based on metadata and lists on [IMDb.com](https://www.imdb.com/). | ✅ |
|
||||
| [Trakt](builders/trakt) | Grabs items based on metadata and lists on [Trakt.tv](https://trakt.tv/). | ❌ |
|
||||
| [Tautulli](builders/tautulli) | Grabs items based on metadata and lists in your [Tautulli](https://tautulli.com/). | ❌ |
|
||||
| [Radarr](builders/radarr) | Grabs items based on metadata and lists in your [Radarr](https://radarr.video/) . | ❌ |
|
||||
| [Sonarr](builders/sonarr) | Grabs items based on metadata and lists in your [Sonarr](https://sonarr.tv/). | ❌ |
|
||||
| [MdbList](builders/mdblist) | Grabs items based on metadata and lists on [MdbList.com](https://mdblist.com/). | ✅ |
|
||||
| [Letterboxd](builders/letterboxd) | Grabs items based on metadata and lists on [Letterboxd.com](https://letterboxd.com/). | ✅ |
|
||||
| [ICheckMovies](builders/icheckmovies) | Grabs items based on metadata and lists on [ICheckMovies.com](https://www.icheckmovies.com/). | ✅ |
|
||||
| [FlixPatrol](builders/flixpatrol) | Grabs items based on metadata and lists on [FlixPatrol.com](https://flixpatrol.com/). | ✅ |
|
||||
| [Reciperr](builders/reciperr) | Grabs items based on metadata and lists on [reciperr.com](https://reciperr.com/). | ✅ |
|
||||
| [StevenLu](builders/stevenlu) | Grabs items based on metadata and lists on [StevenLu.com](https://movies.stevenlu.com/). | ✅ |
|
||||
| [AniDB](builders/anidb) | Grabs items based on metadata and lists on [AniDB.net](https://anidb.net/). | ✅ |
|
||||
| [AniList](builders/anilist) | Grabs items based on metadata and lists on [AniList.co](https://anilist.co/). | ✅ |
|
||||
| [MyAnimeList](builders/myanimelist) | Grabs items based on metadata and lists on [MyAnimeList.net](https://myanimelist.net/). | ❌ |
|
||||
@ -1,35 +1,35 @@
|
||||
# Setting Details
|
||||
# Definition Settings
|
||||
|
||||
All the following attributes serve various functions as how the collection/playlist functions inside of Plex Meta Manager.
|
||||
All the following attributes serve various functions as how the definition functions inside of Plex Meta Manager.
|
||||
|
||||
| Attribute | Description & Values |
|
||||
|:-----------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `name` | **Description:** Used to specify the name of the collection/playlist in Plex as different than the mapping name.<br>**Values:** Any String |
|
||||
| `limit` | **Description:** Used to specify the max number of items for the collection/playlist<br>**Values:** Number greater than 0 |
|
||||
| `template` | **Description:** Used to specify a template and template variables to use for this collection/playlist. See the [Templates Page](../templates) for more information.<br>**Values:** Dictionary |
|
||||
| `run_again` | **Description:** Used to try and add all the missing items to the collection/playlist again after the daily run.<br>**Default:** `false`<br>**Values:** `true` or `false` |
|
||||
| `sync_mode` | **Description:** Used to change how builders sync with this collection/playlist.<br>**Default:** `sync_mode` [settings value](../../config/settings) in the Configuration File<br>**Values:**<table class="clearTable"><tr><td>`append`</td><td>Only Add Items to the Collection</td></tr><tr><td>`sync`</td><td>Add & Remove Items from the Collection</td></tr></table> |
|
||||
| `minimum_items` | **Description:** Minimum items that must be found to add to a collection/playlist.<br>**Default:** `minimum_items` [settings value](../../config/settings) in the Configuration File<br>**Values:** number greater than 0 |
|
||||
| `delete_below_minimum` | **Description:** Deletes the collection/playlist if below the minimum.<br>**Default:** `delete_below_minimum` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
|
||||
| `delete_not_scheduled` | **Description:** Deletes the collection/playlist if its skipped because its not scheduled.<br>**Default:** `delete_not_scheduled` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
|
||||
| `tmdb_region` | **Description:** Sets the region for `tmdb_popular`, `tmdb_now_playing`, `tmdb_top_rated`, and `tmdb_upcoming` |
|
||||
| `validate_builders` | **Description:** When set to false the collection/playlist will not fail if one builder fails.<br>**Default:** `true`<br>**Values:** `true` or `false` |
|
||||
| `cache_builders` | **Description:** Caches the items found by the builders for a number of days. This is useful if you run the same configuration on multiple libraries/servers in one run just set the value to `1`.<br>**Default:** `0` <br>**Values:** number 0 or greater |
|
||||
| `blank_collection` | **Description:** When set to true the collection will be created with no builders and no items added.<br>**Default:** `false`<br>**Values:** `true` or `false` |
|
||||
| `build_collection` | **Description:** When set to false the collection won't be created but items can still be added to Radarr/Sonarr. Does not work for playlists.<br>**Default:** `true`<br>**Values:** `true` or `false` |
|
||||
| `server_preroll` | **Description:** Used to set the `Movie pre-roll video` Text box in Plex under Settings -> Extras.<br>You can run this with a [schedule](schedule) to change the pre-rolls automatically.<br>**Values:** Any String |
|
||||
| `missing_only_released` | **Description:** Collection/Playlist Level `missing_only_released` toggle.<br>**Default:** `missing_only_released` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
|
||||
| `only_filter_missing` | **Description:** Collection/Playlist Level `only_filter_missing` toggle.<br>**Default:** `only_filter_missing` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
|
||||
| `show_filtered` | **Description:** Collection/Playlist level `show_filtered` toggle.<br>**Default:** `show_filtered` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
|
||||
| `show_missing` | **Description:** Collection/Playlist level `show_missing` toggle.<br>**Default:** `show_missing` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
|
||||
| `save_report` | **Description:** Collection/Playlist level `save_report` toggle.<br>**Default:** `save_report` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
|
||||
| `ignore_ids` | **Description:** Collection/Playlist level `ignore_ids` which is combined with the library and global `ignore_ids`.<br>**Default:** `ignore_ids` [settings value](../../config/settings) in the Configuration File<br>**Values:** List or comma-separated String of TMDb/TVDb IDs |
|
||||
| `ignore_imdb_ids` | **Description:** Collection/Playlist level `ignore_imdb_ids` which is combined with the library and global `ignore_imdb_ids`.<br>**Default:** `ignore_imdb_ids` [settings value](../../config/settings) in the Configuration File<br>**Values:** List or comma-separated String of IMDb IDs |
|
||||
| `name_mapping` | **Description:** Used to specify the folder name in the [Image Assets Directory](../../home/guides/assets) i.e. if your collection/playlist 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 name you can this to specify the name in the file system.<br>**Values:** Any String |
|
||||
| `test` | **Description:** When running in Test Mode (`--run-tests` [option](../../home/environmental)) only collections/playlists with `test: true` will be run.<br>**Default:** `false`<br>**Values:** `true` or `false` |
|
||||
| `changes_webhooks` | **Description:** Used to specify a collection/playlist changes webhook for just this collection/playlist.<br>**Values:** List of webhooks |
|
||||
| `sync_to_trakt_list` | **Description:** Used to specify a trakt list you want the collection/playlist synced to.<br>**Values:** Trakt List Slug you want to sync to |
|
||||
| `sync_missing_to_trakt_list` | **Description:** Used to also sync missing items to the Trakt List specified by `sync_to_trakt_list`.<br>**Default:** `false`<br>**Values:** `true` or `false` |
|
||||
| `allowed_library_types` | **Description:** Used to specify the types of libraries that this definition can work with.<br>Multiple can be used for one definition as a list or comma separated string. One `false` will cause it to fail.<br>**Values:** `movie`, `show`, `artist`, `true`, `false` |
|
||||
| `default_percent` | **Description:** Used to declare the default percent for `episodes`, `seasons`, `tracks`, and `albums` [special filters](../filters.md#special-filters). Default is 50.<br>**Values:** Integer between 1 and 100 |
|
||||
| `ignore_blank_results` | **Description:** Used to not have Errors resulting from blank results from builders<br>**Default:** `false`<br>**Values:** `true` or `false` |
|
||||
| Attribute | Description & Values |
|
||||
|:-----------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `name` | **Description:** Used to specify the name of the definition in Plex as different than the mapping name.<br>**Values:** Any String |
|
||||
| `limit` | **Description:** Used to specify the max number of items for the definition<br>**Values:** Number greater than 0 |
|
||||
| `template` | **Description:** Used to specify a template and template variables to use for this definition. See the [Templates Page](../templates) for more information.<br>**Values:** Dictionary |
|
||||
| `run_again` | **Description:** Used to try and add all the missing items to the definition again after the daily run.<br>**Default:** `false`<br>**Values:** `true` or `false` |
|
||||
| `sync_mode` | **Description:** Used to change how builders sync with this definition.<br>**Default:** `sync_mode` [settings value](../../config/settings) in the Configuration File<br>**Values:**<table class="clearTable"><tr><td>`append`</td><td>Only Add Items to the Collection</td></tr><tr><td>`sync`</td><td>Add & Remove Items from the Collection</td></tr></table> |
|
||||
| `minimum_items` | **Description:** Minimum items that must be found to add to a definition.<br>**Default:** `minimum_items` [settings value](../../config/settings) in the Configuration File<br>**Values:** number greater than 0 |
|
||||
| `delete_below_minimum` | **Description:** Deletes the definition if below the minimum.<br>**Default:** `delete_below_minimum` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
|
||||
| `delete_not_scheduled` | **Description:** Deletes the definition if its skipped because its not scheduled.<br>**Default:** `delete_not_scheduled` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
|
||||
| `tmdb_region` | **Description:** Sets the region for `tmdb_popular`, `tmdb_now_playing`, `tmdb_top_rated`, and `tmdb_upcoming` |
|
||||
| `validate_builders` | **Description:** When set to false the definition will not fail if one builder fails.<br>**Default:** `true`<br>**Values:** `true` or `false` |
|
||||
| `cache_builders` | **Description:** Caches the items found by the builders for a number of days. This is useful if you run the same configuration on multiple libraries/servers in one run just set the value to `1`.<br>**Default:** `0` <br>**Values:** number 0 or greater |
|
||||
| `blank_collection` | **Description:** When set to true the collection will be created with no builders and no items added.<br>**Default:** `false`<br>**Values:** `true` or `false` |
|
||||
| `build_collection` | **Description:** When set to false the collection won't be created but items can still be added to Radarr/Sonarr. Does not work for playlists.<br>**Default:** `true`<br>**Values:** `true` or `false` |
|
||||
| `server_preroll` | **Description:** Used to set the `Movie pre-roll video` Text box in Plex under Settings -> Extras.<br>You can run this with a [schedule](schedule) to change the pre-rolls automatically.<br>**Values:** Any String |
|
||||
| `missing_only_released` | **Description:** definition Level `missing_only_released` toggle.<br>**Default:** `missing_only_released` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
|
||||
| `only_filter_missing` | **Description:** definition Level `only_filter_missing` toggle.<br>**Default:** `only_filter_missing` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
|
||||
| `show_filtered` | **Description:** definition level `show_filtered` toggle.<br>**Default:** `show_filtered` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
|
||||
| `show_missing` | **Description:** definition level `show_missing` toggle.<br>**Default:** `show_missing` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
|
||||
| `save_report` | **Description:** definition level `save_report` toggle.<br>**Default:** `save_report` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
|
||||
| `ignore_ids` | **Description:** definition level `ignore_ids` which is combined with the library and global `ignore_ids`.<br>**Default:** `ignore_ids` [settings value](../../config/settings) in the Configuration File<br>**Values:** List or comma-separated String of TMDb/TVDb IDs |
|
||||
| `ignore_imdb_ids` | **Description:** definition level `ignore_imdb_ids` which is combined with the library and global `ignore_imdb_ids`.<br>**Default:** `ignore_imdb_ids` [settings value](../../config/settings) in the Configuration File<br>**Values:** List or comma-separated String of IMDb IDs |
|
||||
| `name_mapping` | **Description:** Used to specify the folder name in the [Image Assets Directory](../../home/guides/assets) i.e. if your definition 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 name you can this to specify the name in the file system.<br>**Values:** Any String |
|
||||
| `test` | **Description:** When running in Test Mode (`--run-tests` [option](../../home/environmental)) only definitions with `test: true` will be run.<br>**Default:** `false`<br>**Values:** `true` or `false` |
|
||||
| `changes_webhooks` | **Description:** Used to specify a definition changes webhook for just this definition.<br>**Values:** List of webhooks |
|
||||
| `sync_to_trakt_list` | **Description:** Used to specify a trakt list you want the definition synced to.<br>**Values:** Trakt List Slug you want to sync to |
|
||||
| `sync_missing_to_trakt_list` | **Description:** Used to also sync missing items to the Trakt List specified by `sync_to_trakt_list`.<br>**Default:** `false`<br>**Values:** `true` or `false` |
|
||||
| `allowed_library_types` | **Description:** Used to specify the types of libraries that this definition can work with.<br>Multiple can be used for one definition as a list or comma separated string. One `false` will cause it to fail.<br>**Values:** `movie`, `show`, `artist`, `true`, `false` |
|
||||
| `default_percent` | **Description:** Used to declare the default percent for `episodes`, `seasons`, `tracks`, and `albums` [special filters](../filters.md#special-filters). Default is 50.<br>**Values:** Integer between 1 and 100 |
|
||||
| `ignore_blank_results` | **Description:** Used to not have Errors resulting from blank results from builders<br>**Default:** `false`<br>**Values:** `true` or `false` |
|
||||
@ -0,0 +1,34 @@
|
||||
# Item Metadata Updates
|
||||
|
||||
All the following attributes update various details of the metadata for every item in the collection.
|
||||
|
||||
**None of these updates work with Playlists or Overlays.**
|
||||
|
||||
| Attribute | Description & Values |
|
||||
|:--------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `item_label` | **Description:** Appends new labels to every movie/show in the collection<br>**Values:** Comma-separated string of labels to append |
|
||||
| `item_label.remove` | **Description:** Removes existing labels from every movie/show in the collection<br>**Values:** Comma-separated string of labels to remove |
|
||||
| `item_label.sync` | **Description:** Matches the labels of every movie/show in the collection to the labels provided (Leave blank to remove all labels)<br>**Values:** Comma-separated string of labels to sync |
|
||||
| `item_genre` | **Description:** Appends new genres to every movie/show in the collection<br>**Values:** Comma-separated string of genres to append |
|
||||
| `item_genre.remove` | **Description:** Removes existing genres from every movie/show in the collection<br>**Values:** Comma-separated string of genres to remove |
|
||||
| `item_genre.sync` | **Description:** Matches the genres of every movie/show in the collection to the genres provided (Leave blank to remove all genres)<br>**Values:** Comma-separated string of genres to sync |
|
||||
| `item_edition` | **Description:** Replaced the edition of every movie in the collection<br>**Values:** Edition Name |
|
||||
| `non_item_remove_label` | **Description:** Matches every movie/show that has the given label and is not in the collection and removes the label<br>**Values:** Comma-separated string of labels to remove |
|
||||
| `item_lock_poster` | **Description:** Locks/Unlocks the poster of every movie/show in the collection<br>**Default:** `None`<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Lock</td></tr><tr><td>`false`</td><td>Unlock</td></tr></table> |
|
||||
| `item_lock_background` | **Description:** Locks/Unlocks the background of every movie/show in the collection<br>**Default:** `None`<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Lock</td></tr><tr><td>`false`</td><td>Unlock</td></tr></table> |
|
||||
| `item_lock_title` | **Description:** Locks/Unlocks the title of every movie/show in the collection<br>**Default:** `None`<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Lock</td></tr><tr><td>`false`</td><td>Unlock</td></tr></table> |
|
||||
| `item_assets` | **Description:** Checks your assets folders for assets of every movie/show in the collection<br>**Default:** `false`<br>**Values:** `true` or `false` |
|
||||
| `item_refresh` | **Description:** Refreshes the metadata of every movie/show in the collection<br>**Default:** `false`<br>**Values:** `true` or `false` |
|
||||
| `item_refresh_delay` | **Description:** Amount of time to wait between each `item_refresh` of every movie/show in the collection<br>**Default:** `0`<br>**Values:** Number greater than `0` |
|
||||
| `item_tmdb_season_titles` | **Description:** Changes the season titles of every show in the collection to match TMDb<br>**Default:** `false`<br>**Values:** `true` or `false` |
|
||||
| `item_episode_sorting`<sup>1</sup> | **Description:** Changes the episode sorting of every show in the collection<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`oldest`</td><td>Oldest first</td></tr><tr><td>`newest`</td><td>Newest first</td></tr></table> |
|
||||
| `item_keep_episodes`<sup>1</sup> | **Description:** Changes the keep episodes of every show in the collection<br>**Values:**<table class="clearTable"><tr><td>`all`</td><td>All episodes</td></tr><tr><td>`5_latest`</td><td>5 latest episodes</td></tr><tr><td>`3_latest`</td><td>3 latest episodes</td></tr><tr><td>`latest`</td><td>Latest episodes</td></tr><tr><td>`past_3`</td><td>Episodes added in the past 3 days</td></tr><tr><td>`past_7`</td><td>Episodes added in the past 7 days</td></tr><tr><td>`past_30`</td><td>Episodes added in the past 30 days</td></tr></table> |
|
||||
| `item_delete_episodes`<sup>1</sup> | **Description:** Changes the delete episodes of every show in the collection<br>**Values:**<table class="clearTable"><tr><td>`never`</td><td>Never</td></tr><tr><td>`day`</td><td>After a day</td></tr><tr><td>`week`</td><td>After a week</td></tr><tr><td>`refresh`</td><td>On next refresh</td></tr></table> |
|
||||
| `item_season_display`<sup>1</sup> | **Description:** Changes the season display of every show in the collection<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`show`</td><td>Show</td></tr><tr><td>`hide`</td><td>Hide</td></tr></table> |
|
||||
| `item_episode_ordering`<sup>1</sup> | **Description:** Changes the episode ordering of every show in the collection<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`tmdb_aired`</td><td>The Movie Database (Aired)</td></tr><tr><td>`tvdb_aired`</td><td>TheTVDb (Aired)</td></tr><tr><td>`tvdb_dvd`</td><td>TheTVDb (DVD)</td></tr><tr><td>`tvdb_absolute`</td><td>TheTVDb (Absolute)</td></tr></table> |
|
||||
| `item_metadata_language`<sup>2</sup> | **Description:** Changes the metadata language of every movie/show in the collection<br>**Values:** `default`, `ar-SA`, `ca-ES`, `cs-CZ`, `da-DK`, `de-DE`, `el-GR`, `en-AU`, `en-CA`, `en-GB`, `en-US`, `es-ES`, `es-MX`, `et-EE`, `fa-IR`, `fi-FI`, `fr-CA`, `fr-FR`, `he-IL`, `hi-IN`, `hu-HU`, `id-ID`, `it-IT`, `ja-JP`, `ko-KR`, `lt-LT`, `lv-LV`, `nb-NO`, `nl-NL`, `pl-PL`, `pt-BR`, `pt-PT`, `ro-RO`, `ru-RU`, `sk-SK`, `sv-SE`, `th-TH`, `tr-TR`, `uk-UA`, `vi-VN`, `zh-CN`, `zh-HK`, `zh-TW` |
|
||||
| `item_use_original_title`<sup>2</sup> | **Description:** Changes the use original title of every movie/show in the collection<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`no`</td><td>No</td></tr><tr><td>`yes`</td><td>Yes</td></tr></table> |
|
||||
|
||||
<sup>1</sup> Only works with TV Show Libraries
|
||||
|
||||
<sup>2</sup> Must be using the **New Plex Movie Agent** or the **New Plex TV Agent**
|
||||
@ -0,0 +1,11 @@
|
||||
# Settings/Updates
|
||||
|
||||
The settings will change how Plex Meta Manager functions with the Definition while updates change the actual metadata stored in plex.
|
||||
|
||||
| Name | Description |
|
||||
|:---------------------------------------------------------|:---------------------------------------------------------------------------------------|
|
||||
| [Definition Settings](details/definition) | These are settings to change of Plex Meta Manager deals with the definition. |
|
||||
| [Schedule Settings](details/schedule) | These are settings to change how the definition is scheduled to run. |
|
||||
| [Arr Definition Settings](details/arr) | These are settings to change how Radarr/Sonarr is handled in this specific definition. |
|
||||
| [Collection/Playlist Metadata Updates](details/metadata) | These are settings to change an aspect of a collection/playlist's metadata. |
|
||||
| [Item Metadata Updates](details/item_metadata) | These are settings to change an aspect of metadata for all items in the collection. |
|
||||
Loading…
Reference in new issue