`append` | Only Add Items to the Collection |
`sync` | Add & Remove Items from the Collection |
|
) list) | weekly(Days of Week) | `weekly(sunday)`weekly(sunday|tuesday)
|
-| Monthly | Update once a month on the specified day | monthly(Day of Month) | `monthly(1)` |
-| Yearly | Update once a year on the specified day | yearly(MM/DD) | `yearly(01/30)` |
-| Range | Updates whenever the date is within the range (For multiple ranges, use a bar-separated (|
) list) | range(MM/DD-MM/DD) | `range(12/01-12/31)`range(8/01-8/15|9/01-9/15)
|
-| Never | Never updates | never | `never` |
-| Non Existing | Updates if it doesn't exist | non_existing | `non_existing` |
-| All | Requires that all comma separated scheduling options inside its brackets be meet in order to run | all[Options] | `all[weekly(sunday), hourly(17)]` |
-
-* `daily` is the default when `schedule` is not specified.
-* You can run the script multiple times per day but using the `--time` command line argument detailed on the [Run Commands & Environmental Variables Page](../../pmm/essentials/environmental.md#time-to-run).
-* You can have multiple scheduling options as a list.
-* You can use the `delete_not_scheduled` setting to delete Collections that are skipped due to not being scheduled.
-
-## Examples
-
-Below is an example of a library which has been scheduled to run every Sunday. This will schedule everything within the library (in this case Collection Files and Operations) for the same day.
-
-
-```yaml
-libraries:
- Movies:
- schedule: weekly(sunday)
- collection_files:
- - file: config/Movies.yml
- - pmm: imdb
- - pmm: studio
- - pmm: genre
- - pmm: actor
- operations:
- mass_critic_rating_update: tmdb
-```
-
-Collection Files, Playlist Files, and Overlay Files can all be individually scheduled, as seen below where different files are scheduled to run on each day of the week:
-
-**Note: Overlay Files cannot be individually Scheduled, all Overlay Files must be scheduled for the same period.**
-
-```yaml
-libraries:
- Movies:
- collection_files:
- - file: config/Movies.yml
- schedule: weekly(monday)
- - pmm: imdb
- schedule: weekly(tuesday)
- - folder: config/Movies/
- schedule: weekly(wednesday)
- - pmm: genre
- schedule: weekly(thursday)
- - pmm: actor
- schedule: weekly(friday)
- overlay_files:
- - schedule: weekly(saturday)
- - pmm: audio_codec
- - pmm: resolution
- - pmm: video_format
-playlist_files:
- - file: config/Playlists.yml
- schedule: weekly(sunday)
-```
-
-Below is an example of a collection which has been scheduled to run on a Sunday. In this scenario, if you run PMM on a Monday, this collection will be skipped but any other collections which do not have a scheduled defined will be run.
-
-```yaml
-collections:
- TMDb Trending Weekly:
- tmdb_trending_weekly: 30
- sync_mode: sync
- schedule: weekly(sunday)
- TMDb Top Rated:
- tmdb_top_rated: 30
- sync_mode: sync
- schedule:
- - monthly(1)
- - monthly(15)
-```
-
-You can also schedule items to be "pinned" to your home screen on a schedule. For example, this collection will be pinned to your home screen for the month of December and on January 1st will no longer be pinned (you must run PMM on 1st January for the removal of the pin to happen)
-
-```yaml
-collections:
- Christmas Movies:
- imdb_list: https://www.imdb.com/list/ls000096828/
- sync_mode: sync
- visible_home: range(12/01-12/31)
-```
-
-Whilst it isn't possible to schedule individual Operations, you can create additional placeholder library names and point them to the original library using `library_name`. This can be used to achieve individually scheduled operations, as seen below:
-```yaml
-libraries:
- Movies:
- collection_files:
- - file: config/Movies.yml
- Movies Operations (Monday): # Name doesn't matter
- library_name: Movies # Must match your library name in Plex
- schedule: weekly(monday)
- operations:
- mass_user_rating_update: imdb
- Movies Operations (Wednesday): # Name doesn't matter
- library_name: Movies # Must match your library name in Plex
- schedule: weekly(wednesday)
- operations:
- mass_audience_rating_update: tmdb
- Movies Operations (Friday): # Name doesn't matter
- library_name: Movies # Must match your library name in Plex
- schedule: weekly(friday)
- operations:
- mass_critic_rating_update: trakt
-```
diff --git a/docs/builders/dynamic.md b/docs/builders/dynamic.md
deleted file mode 100644
index 4bfdb2f5..00000000
--- a/docs/builders/dynamic.md
+++ /dev/null
@@ -1,105 +0,0 @@
-# Dynamic Collections
-
-Plex Meta Manager can dynamically create collections based on different criteria, such as
-* Collections based on the Collections from TMDb for every item in the library. ([Star Wars](https://www.themoviedb.org/collection/10-star-wars-collection), [Harry Potter](https://www.themoviedb.org/collection/1241), etc...)
-* Collections based on each of a Users Trakt Lists
-* Collections for the top `X` popular people on TMDb (Bruce Willis, Tom Hanks, etc...)
-* Collections for each decade represented in the library (Best of 1990s, Best of 2000s, etc...)
-* Collections for each of the moods/styles within a Music library (A Cappella, Pop Rock, etc...)
-
-The main purpose of dynamic collections is to automate the creation of collections which would otherwise require considerable user input and repetition (such as creating a collection for every genre).
-
-Each dynamic collection must have a mapping name (just like standard collections), which is also attached to the collection as a label to mark it as having been created by this dynamic collection.
-
-This example will create a collection for every TMDb Collection associated with items in the library.
-
-```yaml
-dynamic_collections:
- TMDb Collections: # This name is the mapping name
- type: tmdb_collection
- remove_suffix: "Collection"
-```
-
-## Collection Naming
-
-By default, the collections generated will be named for the thing being used to create them; things like genres, countries, actors or even Trakt List Names.
-
-There are many attributes that can change the titles, including `title_format`, `remove_suffix`, `remove_prefix`, `key_name_override`, and `title_override` all detailed below.
-
-## Dynamic Keys & Key Names
-
-A `dynamic key` or `key` for short is used to refer to a specific value/result from the dynamic collection criteria that will be used to create the collection.
-
-A `key_name` is the name that replaces `<type |
- tmdb_collection |
-
---|---|
data |
- Not Used | -
Keys | -TMDb Collection ID | -
Key Names | -TMDb Collection Title | -
Default title_format |
- <<key_name>> |
-
Default Template | -
-
-```yaml
-default_template:
- tmdb_collection_details: < |
-
type |
- tmdb_popular_people |
-
---|---|
data |
- Number greater than 0 | -
Keys | -TMDb Person ID | -
Key Names | -TMDb Person Name | -
Default title_format |
- <<key_name>> |
-
Default Template | -
-
-```yaml
-default_template:
- tmdb_person: < |
-
type |
- original_language |
-
---|---|
data |
- Not Used | -
Keys | -ISO 639-1 Code | -
Key Names | -ISO Language Name | -
Default title_format |
- <<key_name>> <<library_type>>s |
-
Default Template | -
-
-```yaml
-default_template:
- plex_all: true
- filters:
- original_language: < |
-
type |
- origin_country |
-
---|---|
data |
- Not Used | -
Keys | -ISO 3166-1 alpha-2 country code | -
Key Names | -ISO Country Name | -
Default title_format |
- <<key_name>> <<library_type>>s |
-
Default Template | -
-
-```yaml
-default_template:
- plex_all: true
- filters:
- origin_country: < |
-
type |
- trakt_user_lists |
-
---|---|
data |
- List of Trakt Users | -
Keys | -Trakt List URL | -
Key Names | -Trakt List Title | -
Default title_format |
- <<key_name>> |
-
Default Template | -
-
-```yaml
-default_template:
- trakt_list_details: < |
-
type |
- trakt_liked_lists |
-
---|---|
data |
- Not Used | -
Keys | -Trakt List URL | -
Key Names | -Trakt List Title | -
Default title_format |
- <<key_name>> |
-
Default Template | -
-
-```yaml
-default_template:
- trakt_list_details: < |
-
type |
- trakt_people_list |
-
---|---|
data |
- List of Trakt URLs | -
Keys | -TMDb Person ID | -
Key Names | -TMDb Person Name | -
Default title_format |
- <<key_name>> |
-
Default Template | -
-
-```yaml
-default_template:
- tmdb_person: < |
-
type |
- actor |
- |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
data s |
-
-
|
- |||||||||||
Keys | -Person Name | -|||||||||||
Key Names | -Person Name | -|||||||||||
Default title_format |
- <<key_name>> |
- |||||||||||
Default Template | -
-
-```yaml
-default_template:
- plex_search:
- any:
- actor: < |
-
type |
- director |
- |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
data s |
-
-
|
- |||||||||||
Keys | -Person Name | -|||||||||||
Key Names | -Person Name | -|||||||||||
Default title_format |
- <<key_name>> |
- |||||||||||
Default Template | -
-
-```yaml
-default_template:
- plex_search:
- any:
- director: < |
-
type |
- writer |
- |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
data s |
-
-
|
- |||||||||||
Keys | -Person Name | -|||||||||||
Key Names | -Person Name | -|||||||||||
Default title_format |
- <<key_name>> |
- |||||||||||
Default Template | -
-
-```yaml
-default_template:
- plex_search:
- any:
- writer: < |
-
type |
- producer |
- |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
data s |
-
-
|
- |||||||||||
Keys | -Person Name | -|||||||||||
Key Names | -Person Name | -|||||||||||
Default title_format |
- <<key_name>> |
- |||||||||||
Default Template | -
-
-```yaml
-default_template:
- plex_search:
- all:
- producer: < |
-
type |
- genre |
-
---|---|
data |
- Not Used | -
Keys | -Genre | -
Key Names | -Genre | -
Default title_format |
- Top <<key_name>> <<library_type>>s |
-
Default Template | -
-
-```yaml
-default_template:
- smart_filter:
- limit: 50
- sort_by: critic_rating.desc
- any:
- genre: < |
-
type |
- album_genre |
-
---|---|
data |
- Not Used | -
Keys | -Genre | -
Key Names | -Genre | -
Default title_format |
- Top <<key_name>> Albums |
-
Default Template | -
-
-```yaml
-default_template:
- smart_filter:
- limit: 50
- sort_by: plays.desc
- any:
- album_genre: < |
-
type |
- content_rating |
-
---|---|
data |
- Not Used | -
Keys | -Content Rating | -
Key Names | -Content Rating | -
Default title_format |
- Top <<key_name>> <<library_type>>s |
-
Default Template | -
-
-```yaml
-default_template:
- smart_filter:
- limit: 50
- sort_by: critic_rating.desc
- any:
- content_rating: < |
-
type |
- year |
-
---|---|
data |
- Not Used | -
Keys | -Year | -
Key Names | -Year | -
Default title_format |
- Best <<library_type>>s of <<key_name>> |
-
Default Template | -
-
-```yaml
-default_template:
- smart_filter:
- limit: 50
- sort_by: critic_rating.desc
- any:
- year: < |
-
type |
- episode_year |
-
---|---|
data |
- Not Used | -
Keys | -Episode Year | -
Key Names | -Year | -
Default title_format |
- Best <<library_type>>s of <<key_name>> |
-
Default Template | -
-
-```yaml
-default_template:
- smart_filter:
- limit: 50
- sort_by: critic_rating.desc
- any:
- episode_year: < |
-
type |
- decade |
-
---|---|
data |
- Not Used | -
Keys | -Decade | -
Key Names | -Decade | -
Default title_format |
- Best <<library_type>>s of <<key_name>> |
-
Default Template | -
-
-```yaml
-default_template:
- smart_filter:
- limit: 50
- sort_by: critic_rating.desc
- any:
- decade: < |
-
type |
- country |
-
---|---|
data |
- Not Used | -
Keys | -Country | -
Key Names | -Country | -
Default title_format |
- Top <<key_name>> <<library_type>>s |
-
Default Template | -
-
-```yaml
-default_template:
- smart_filter:
- limit: 50
- sort_by: critic_rating.desc
- any:
- country: < |
-
type |
- resolution |
-
---|---|
data |
- Not Used | -
Keys | -Resolution | -
Key Names | -Resolution | -
Default title_format |
- <<key_name>> <<library_type>>s |
-
Default Template | -
-
-```yaml
-default_template:
- smart_filter:
- limit: 50
- sort_by: title.asc
- any:
- resolution: < |
-
type |
- subtitle_language |
-
---|---|
data |
- Not Used | -
Keys | -ISO 639-1 Code | -
Key Names | -Subtitle Language Name | -
Default title_format |
- Top <<key_name>> <<library_type>>s |
-
Default Template | -
-
-```yaml
-default_template:
- smart_filter:
- limit: 50
- sort_by: critic_rating.asc
- any:
- subtitle_language: < |
-
type |
- audio_language |
-
---|---|
data |
- Not Used | -
Keys | -ISO 639-1 Code | -
Key Names | -Audio Language Name | -
Default title_format |
- Top <<key_name>> <<library_type>>s |
-
Default Template | -
-
-```yaml
-default_template:
- smart_filter:
- limit: 50
- sort_by: critic_rating.asc
- any:
- audio_language: < |
-
type |
- studio |
-
---|---|
data |
- Not Used | -
Keys | -Studio | -
Key Names | -Studio | -
Default title_format |
- Top <<key_name>> <<library_type>>s |
-
Default Template | -
-
-```yaml
-default_template:
- smart_filter:
- limit: 50
- sort_by: critic_rating.desc
- any:
- studio: < |
-
type |
- edition |
-
---|---|
data |
- Not Used | -
Keys | -Editions | -
Key Names | -Edition | -
Default title_format |
- Top <<key_name>> <<library_type>>s |
-
Default Template | -
-
-```yaml
-default_template:
- smart_filter:
- limit: 50
- sort_by: critic_rating.desc
- any:
- edition: < |
-
type |
- network |
-
---|---|
data |
- Not Used | -
Keys | -Network | -
Key Names | -Network | -
Default title_format |
- Top <<key_name>> <<library_type>>s |
-
Default Template | -
-
-```yaml
-default_template:
- smart_filter:
- limit: 50
- sort_by: critic_rating.desc
- any:
- network: < |
-
type |
- mood |
-
---|---|
data |
- Not Used | -
Keys | -Mood | -
Key Names | -Mood | -
Default title_format |
- Most Played <<value>> <<library_type>>s |
-
Default Template | -
-
-```yaml
-default_template:
- smart_filter:
- limit: 10
- sort_by: plays.desc
- any:
- artist_mood: < |
-
type |
- album_mood |
-
---|---|
data |
- Not Used | -
Keys | -Mood | -
Key Names | -Mood | -
Default title_format |
- Most Played <<value>> Albums |
-
Default Template | -
-
-```yaml
-default_template:
- smart_filter:
- limit: 10
- sort_by: plays.desc
- any:
- album_mood: < |
-
type |
- track_mood |
-
---|---|
data |
- Not Used | -
Keys | -Mood | -
Key Names | -Mood | -
Default title_format |
- Most Played <<value>> Tracks |
-
Default Template | -
-
-```yaml
-default_template:
- smart_filter:
- limit: 50
- sort_by: plays.desc
- any:
- track_mood: < |
-
type |
- style |
-
---|---|
data |
- Not Used | -
Keys | -Style | -
Key Names | -Style | -
Default title_format |
- Most Played <<key_name>> <<library_type>>s |
-
Default Template | -
-
-```yaml
-default_template:
- smart_filter:
- limit: 10
- sort_by: plays.desc
- any:
- artist_style: < |
-
type |
- album_style |
-
---|---|
data |
- Not Used | -
Keys | -Style | -
Key Names | -Style | -
Default title_format |
- Most Played <<key_name>> Albums |
-
Default Template | -
-
-```yaml
-default_template:
- smart_filter:
- limit: 10
- sort_by: plays.desc
- any:
- album_style: < |
-
type |
- number |
- |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
data s |
-
-
|
- |||||||||||
Keys | -Number | -|||||||||||
Key Names | -Number | -|||||||||||
Default title_format |
- <<key_name>> |
- |||||||||||
Default Template | -**None** | -
type |
- custom |
-
---|---|
data s |
- Strings to iterate | -
Keys | -key |
-
Key Names | -key_name |
-
Default title_format |
- <<key_name>> |
-
Default Template | -None | -
`default` | Library default |
`oldest` | Oldest first |
`newest` | Newest first |
`name` | Alphabetical |
`default` | Library default |
`oldest` | Oldest first |
`newest` | Newest first |
`all` | All episodes |
`5_latest` | 5 latest episodes |
`3_latest` | 3 latest episodes |
`latest` | Latest episodes |
`past_3` | Episodes added in the past 3 days |
`past_7` | Episodes added in the past 7 days |
`past_30` | Episodes added in the past 30 days |
`never` | Never |
`day` | After a day |
`week` | After a week |
`refresh` | On next refresh |
`default` | Library default |
`show` | Show |
`hide` | Hide |
`default` | Library default |
`tmdb_aired` | The Movie Database (Aired) |
`tvdb_aired` | TheTVDb (Aired) |
`tvdb_dvd` | TheTVDb (DVD) |
`tvdb_absolute` | TheTVDb (Absolute) |
`default` | Library default |
`no` | No |
`yes` | Yes |
`managed: true` | Collection must be Managed to be deleted (collection has the `PMM` label) |
`managed: false` | Collection must be Unmanaged to be deleted (collection does not have the `PMM` label) |
`configured: true` | Collection must be Configured to be deleted (collection is in the config file of the specific PMM run) |
`configured: false` | Collection must be Unconfigured to be deleted (collection is not in the config file of the specific PMM run) |
`less: ###` | Collection must contain less then the given number of items to be deleted. ### is a Number greater than 0 |
`tmdb` | Use TMDb for Genres |
`tvdb` | Use TVDb for Genres |
`imdb` | Use IMDb for Genres |
`omdb` | Use IMDb through OMDb for Genres |
`anidb` | Use AniDB Main Tags for Genres |
`anidb_3_0` | Use AniDB Main Tags and All 3 Star Tags and above for Genres |
`anidb_2_5` | Use AniDB Main Tags and All 2.5 Star Tags and above for Genres |
`anidb_2_0` | Use AniDB Main Tags and All 2 Star Tags and above for Genres |
`anidb_1_5` | Use AniDB Main Tags and All 1.5 Star Tags and above for Genres |
`anidb_1_0` | Use AniDB Main Tags and All 1 Star Tags and above for Genres |
`anidb_0_5` | Use AniDB Main Tags and All 0.5 Star Tags and above for Genres |
`mal` | Use MyAnimeList for Genres |
`lock` | Lock all Genre Field |
`unlock` | Unlock all Genre Field |
`remove` | Remove all Genres and Lock all Field |
`reset` | Remove all Genres and Unlock all Field |
`mdb` | Use MdbList for Content Ratings |
`mdb_commonsense` | Use Commonsense Rating through MDbList for Content Ratings |
`mdb_commonsense0` | Use Commonsense Rating with Zero Padding through MDbList for Content Ratings |
`omdb` | Use IMDb through OMDb for Content Ratings |
`mal` | Use MyAnimeList for Content Ratings |
`lock` | Lock Content Rating Field |
`unlock` | Unlock Content Rating Field |
`remove` | Remove Content Rating and Lock Field |
`reset` | Remove Content Rating and Unlock Field |
`anidb` | Use AniDB Main Title for Original Titles |
`anidb_official` | Use AniDB Official Title based on the language attribute in the config file for Original Titles |
`mal` | Use MyAnimeList Main Title for Original Titles |
`mal_english` | Use MyAnimeList English Title for Original Titles |
`mal_japanese` | Use MyAnimeList Japanese Title for Original Titles |
`lock` | Lock Original Title Field |
`unlock` | Unlock Original Title Field |
`remove` | Remove Original Title and Lock Field |
`reset` | Remove Original Title and Unlock Field |
`anidb` | Use AniDB Animation Work for Studio |
`mal` | Use MyAnimeList Studio for Studio |
`tmdb` | Use TMDb Studio for Studio |
`lock` | Lock Original Title Field |
`unlock` | Unlock Original Title Field |
`remove` | Remove Original Title and Lock Field |
`reset` | Remove Original Title and Unlock Field |
`tmdb` | Use TMDb Release Date |
`tvdb` | Use TVDb Release Date |
`omdb` | Use IMDb Release Date through OMDb |
`mdb` | Use MdbList Release Date |
`anidb` | Use AniDB Release Date |
`mal` | Use MyAnimeList Release Date |
`lock` | Lock Originally Available Field |
`unlock` | Unlock Originally Available Field |
`remove` | Remove Originally Available and Lock Field |
`reset` | Remove Originally Available and Unlock Field |
`tmdb` | Use TMDb Rating |
`imdb` | Use IMDb Rating |
`trakt_user` | Use Trakt User's Personal Rating |
`omdb` | Use IMDbRating through OMDb |
`mdb` | Use MdbList Score |
`mdb_average` | Use MdbList Average Score |
`mdb_imdb` | Use IMDb Rating through MDbList |
`mdb_metacritic` | Use Metacritic Rating through MDbList |
`mdb_metacriticuser` | Use Metacritic User Rating through MDbList |
`mdb_trakt` | Use Trakt Rating through MDbList |
`mdb_tomatoes` | Use Rotten Tomatoes Rating through MDbList |
`mdb_tomatoesaudience` | Use Rotten Tomatoes Audience Rating through MDbList |
`mdb_tmdb` | Use TMDb Rating through MDbList |
`mdb_letterboxd` | Use Letterboxd Rating through MDbList |
`mdb_myanimelist` | Use MyAnimeList Rating through MDbList |
`anidb_rating` | Use AniDB Rating |
`anidb_average` | Use AniDB Average |
`anidb_score` | Use AniDB Review Score |
`mal` | Use MyAnimeList Score |
`lock` | Lock Rating Field |
`unlock` | Unlock Rating Field |
`remove` | Remove Rating and Lock Field |
`reset` | Remove Rating and Unlock Field |
`tmdb` | Use TMDb Rating |
`imdb` | Use IMDb Rating |
`lock` | Lock Rating Field |
`unlock` | Unlock Rating Field |
`remove` | Remove Rating and Lock Field |
`reset` | Remove Rating and Unlock Field |
`source` | Source of the poster update | `tmdb`, `plex`, `lock`, or `unlock` |
`seasons` | Update season posters while updating shows **Default:** `true` | `true` (default) or `false` |
`episodes` | Update episode posters while updating shows **Default:** `true` | `true` (default) or `false` |
`source` | Source of the poster update | `tmdb`, `plex`, `lock`, or `unlock` |
`seasons` | Update season posters while updating shows **Default:** `true` | `true` (default) or `false` |
`episodes` | Update episode posters while updating shows **Default:** `true` | `true` (default) or `false` |
`none` | Apply all Parental Labels with a value of `None`, `Mild`, `Moderate`, or `Severe` |
`mild` | Apply all Parental Labels with a value of `Mild`, `Moderate`, or `Severe` |
`moderate` | Apply all Parental Labels with a value of `Moderate` or `Severe` |
`severe` | Apply all Parental Labels with a value of `Severe` |
`default` | Library default |
`hide` | Hide Collection |
`hide_items` | Hide Items in this Collection |
`show_items` | Show this Collection and its Items |
`key` | Genre you want mapped to the value | `Action/Adventure, Action & Adventure` in the example below |
`value` | What the genre will end up as | `Action` in the example below |
`key` | Content rating you want mapped to the value | `PG`, `PG-13` in the example below |
`value` | What the content rating will end up as | `Y-10` in the example below |
`path` | Path to where the metadata will be saved/maintained **Default:** `< **Values:** Path to Metadata File |
`exclude` | Exclude all listed attributes from being saved in the collection file **Values:** `Comma-separated string or list of attributes` |
`sync_tags` | All Tag Attributes will have the `.sync` option and blank attribute will be added to sync **Default:** `false` **Values:** `true` or `false` |
`add_blank_entries` | Will add a line for entries that have no metadata changes **Default:** `true` **Values:** `true` or `false` |
|
) list) | weekly(Days of Week) | `weekly(sunday)`weekly(sunday|tuesday)
|
+| Monthly | Update once a month on the specified day | monthly(Day of Month) | `monthly(1)` |
+| Yearly | Update once a year on the specified day | yearly(MM/DD) | `yearly(01/30)` |
+| Range | Updates whenever the date is within the range (For multiple ranges, use a bar-separated (|
) list) | range(MM/DD-MM/DD) | `range(12/01-12/31)`range(8/01-8/15|9/01-9/15)
|
+| Never | Never updates | never | `never` |
+| Non Existing | Updates if it doesn't exist | non_existing | `non_existing` |
+| All | Requires that all comma separated scheduling options inside its brackets be meet in order to run | all[Options] | `all[weekly(sunday), hourly(17)]` |
+
+* `daily` is the default when `schedule` is not specified.
+* You can run the script multiple times per day but using the `--time` command line argument detailed on the [Run Commands & Environmental Variables Page](../pmm/environmental.md).
+* You can have multiple scheduling options as a list.
+* You can use the `delete_not_scheduled` setting to delete Collections that are skipped due to not being scheduled.
+
+## Examples
+
+??? blank "Scheduling a Library¶"
+
+ Uses the `schedule` [Library Attribute](libraries.md#Attributes) to set when a library will be run.
+
+ Other schedule rules for files, overlays, collections, and any other attribute that can be scheduled must also be
+ met.
+
+ ???+ example "Example"
+
+ Below is an example of a library which has been scheduled to run every Sunday.
+
+ ```yaml
+ libraries:
+ Movies:
+ schedule: weekly(sunday)
+ collection_files:
+ - file: config/Movies.yml
+ - pmm: imdb
+ - pmm: studio
+ - pmm: genre
+ - pmm: actor
+ operations:
+ mass_critic_rating_update: tmdb
+ ```
+
+??? blank "Scheduling Collection, Playlist, and Metadata Files¶"
+
+ Uses the `schedule` [Block Attribute](files.md#Other-Block-Attributes) to set when a file
+ will be run.
+
+ Other schedule rules for collections and any other attribute that can be scheduled must also be met.
+
+ ???+ example "Example"
+
+ Collection Files, Playlist Files, and Metadata Files can all be individually scheduled, as seen below where
+ different files are scheduled to run on each day of the week:
+
+ ```yaml
+ libraries:
+ Movies:
+ collection_files:
+ - file: config/Movies.yml
+ schedule: weekly(monday)
+ - pmm: imdb
+ schedule: weekly(tuesday)
+ - folder: config/Movies/
+ schedule: weekly(wednesday)
+ - pmm: genre
+ schedule: weekly(thursday)
+ - pmm: actor
+ schedule: weekly(friday)
+ metadata_files:
+ - file: config/metadata.yml
+ schedule: weekly(saturday)
+ playlist_files:
+ - file: config/Playlists.yml
+ schedule: weekly(sunday)
+ ```
+
+??? blank "Scheduling Overlays¶"
+
+ Uses the `schedule_overlays` [Library Attribute](libraries.md#attributes) to set when
+ overlays will run for a library.
+
+ **Note: Overlay Files cannot be individually Scheduled, all Overlay Files must be scheduled for the same period.**
+
+ ???+ example "Example"
+
+ In the Example below overlays will only be run weekly on Saturday.
+
+ ```yaml
+ libraries:
+ Movies:
+ schedule_overlays: weekly(saturday)
+ overlay_files:
+ - pmm: audio_codec
+ - pmm: resolution
+ - pmm: video_format
+ ```
+
+??? blank "Scheduling Individual Collections¶"
+
+ Uses the `schedule` [Definition Setting](../files/settings.md) to set when this
+ collection will run.
+
+ ???+ example "Example"
+
+ Below is an example of a collection which has been scheduled to run on a Sunday. In this scenario, if you run
+ PMM on a Monday, this collection will be skipped but any other collections which do not have a scheduled defined
+ will be run.
+
+ ```yaml
+ collections:
+ TMDb Trending Weekly:
+ tmdb_trending_weekly: 30
+ sync_mode: sync
+ schedule: weekly(sunday)
+ TMDb Top Rated:
+ tmdb_top_rated: 30
+ sync_mode: sync
+ schedule:
+ - monthly(1)
+ - monthly(15)
+ ```
+
+??? blank "Scheduling Operation Blocks¶"
+
+ Each [Operation Block](operations.md#operation-blocks) can use the `schedule`
+ [Definition Setting](../files/settings.md) to set when that block will run.
+
+ ???+ example "Example"
+
+ This example shows just one Operation Block scheduled weekly on fridays.
+
+ ```yaml
+ libraries:
+ Movies:
+ collection_files:
+ - pmm: imdb
+ operations:
+ schedule: weekly(friday)
+ mass_critic_rating_update: tmdb
+ split_duplicates: true
+ ```
+
+ This example shows 2 Operation Blocks each with a differnet schedule.
+
+ ```yaml
+ libraries:
+ Movies:
+ collection_files:
+ - pmm: imdb
+ operations:
+ - schedule: weekly(friday)
+ mass_critic_rating_update: tmdb
+ - schedule: weekly(saturday)
+ split_duplicates: true
+ ```
+
+??? blank "Scheduling Pinning Collections¶"
+
+ Uses the `visible_library`, `visible_home`, or `visible_shared`
+ [Collection Metadata Update](../files/updates.md) to have collections be "pinned" to your home screen while
+ scheduled.
+
+ ???+ example "Example"
+
+ In this example, the collection will be pinned to your home screen for the month of December and on January 1st
+ will no longer be pinned (you must run PMM on 1st January for the removal of the pin to happen)
+
+ ```yaml
+ collections:
+ Christmas Movies:
+ imdb_list: https://www.imdb.com/list/ls000096828/
+ sync_mode: sync
+ visible_home: range(12/01-12/31)
+ ```
diff --git a/docs/config/settings.md b/docs/config/settings.md
index 287966c0..90ae65ff 100644
--- a/docs/config/settings.md
+++ b/docs/config/settings.md
@@ -5,7 +5,9 @@ search:
# Settings
## Overview
-The `settings:` attribute and subsequent settings can be used to command various aspects of the functionality of Plex Meta Manager.
+
+The `settings:` attribute and subsequent settings can be used to command various aspects of the functionality of Plex
+Meta Manager.
Examples of these settings include the ability to:
@@ -13,9 +15,11 @@ Examples of these settings include the ability to:
* Create asset folders for collections so that custom posters can be stored for upload.
* Use a custom repository as the base for all `git` Metadata files.
-The settings attribute and attributes can be specified individually per library, or can be inherited from the global value if it has been set. If an attribute is specified at both the library and global level, then the library level attribute will take priority.
+The settings attribute and attributes can be specified individually per library, or can be inherited from the global
+value if it has been set. If an attribute is specified at both the library and global level, then the library level
+attribute will take priority.
-There are some attributes which can be specified at the collection level using [Setting Details](../builders/details/definition.md).
+There are some attributes which can be specified at the collection level using [Settings](../files/settings.md).
Attributes set at the collection level will take priority over any library or global-level attribute.
@@ -23,60 +27,989 @@ Attributes set at the collection level will take priority over any library or gl
The available setting attributes which can be set at each level are outlined below:
+??? blank "`cache` - Used to control PMM's cache database.¶"
-| Attribute | Global Level | Library Level | Collection/Playlist Level |
-|:--------------------------------------------------------------|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:|
-| [`cache`](#cache) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } |
-| [`cache_expiration`](#cache-expiration) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } |
-| [`asset_directory`](#image-asset-directory) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
-| [`asset_folders`](#image-asset-folders) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
-| [`asset_depth`](#asset-depth) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
-| [`create_asset_folders`](#create-asset-folders) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
-| [`prioritize_assets`](#prioritize-assets) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
-| [`dimensional_asset_rename`](#dimensional-asset-rename) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
-| [`download_url_assets`](#download-url-assets) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
-| [`show_missing_season_assets`](#show-missing-season-assets) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
-| [`show_missing_episode_assets`](#show-missing-episode-assets) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
-| [`show_asset_not_needed`](#show-asset-not-needed) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
-| [`sync_mode`](#sync-mode) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
-| [`default_collection_order`](#default-collection-order) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
-| [`minimum_items`](#minimum-items) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
-| [`delete_below_minimum`](#delete-below-minimum) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
-| [`delete_not_scheduled`](#delete-not-scheduled) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
-| [`run_again_delay`](#run-again-delay) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } |
-| [`missing_only_released`](#missing-only-released) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
-| [`show_unmanaged`](#show-unmanaged-collections) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
-| [`show_unconfigured`](#show-unconfigured-collections) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
-| [`show_filtered`](#show-filtered) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
-| [`show_options`](#show-options) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
-| [`show_missing`](#show-missing) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
-| [`only_filter_missing`](#only-filter-missing) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
-| [`show_missing_assets`](#show-missing-assets) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
-| [`save_report`](#save-report) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
-| [`tvdb_language`](#tvdb-language) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } |
-| [`ignore_ids`](#ignore-ids) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
-| [`ignore_imdb_ids`](#ignore-imdb-ids) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
-| [`item_refresh_delay`](#item-refresh-delay) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
-| [`playlist_sync_to_users`](#playlist-sync-to-users) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } |
-| [`playlist_exclude_users`](#playlist-exclude-users) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } |
-| [`playlist_report`](#playlist-report) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
-| [`run_order`](#run-order) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
-| [`custom_repo`](#custom-repo) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } |
-| [`verify_ssl`](#verify-ssl) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } |
-| [`check_nightly`](#check-nightly) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } |
+ Allow Plex Meta Manager to create and maintain a local cache database for faster subsequent
+ processing. The cache file is created in the same directory as the configuration file.
+
+ `sync` | Will add and remove any items that are added/removed from the source builder. |
`append` | Will only add items that are added from the source builder, but will not remove anything even if it is removed from the source builder. |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` sort option](../files/builders/plex.md#sort-options) |
Default Value | `true` |
Allowed Values | `true` or `false` |
`all` | All episodes except specials |
`future` | Episodes that have not aired yet |
`missing` | Episodes that do not have files or have not aired yet |
`existing` | Episodes that have files or have not aired yet |
`pilot` | The first episode, all others will be ignored |
`first` | All episodes of the first season, all others will be ignored |
`latest` | All episodes of the latest season and future seasons |
`none` | No episodes |
`standard` | Episodes released with SxxEyy pattern |
`daily` | Episodes released daily that use year-month-day pattern (2017-05-25) |
`anime` | Episodes released using an absolute episode number |
`all` | All episodes except specials |
`future` | Episodes that have not aired yet |
`missing` | Episodes that do not have files or have not aired yet |
`existing` | Episodes that have files or have not aired yet |
`pilot` | The first episode, all others will be ignored |
`first` | All episodes of the first season, all others will be ignored |
`latest` | All episodes of the latest season and future seasons |
`none` | No episodes |
`standard` | Episodes released with SxxEyy pattern |
`daily` | Episodes released daily that use year-month-day pattern (2017-05-25) |
`anime` | Episodes released using an absolute episode number |
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
Attribute | Description & Values | |
---|---|---|
starting | Controls the starting year for collections Default: current_year-5 Values: Number greater than 0 | |
ending | Controls the ending year for collections Default: current_year Values: Number greater than 1 | |
increment | Controls the increment (i.e. every 5th year) Default: 1 Values: Number greater than 0 |
starting
and ending
can also have the value current_year
current_year
by doing current_year-5
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
Attribute | Description & Values | |
---|---|---|
starting | Controls the starting year for collections Default: current_year-5 Values: Number greater than 0 | |
ending | Controls the ending year for collections Default: current_year Values: Number greater than 1 | |
increment | Controls the increment (i.e. every 5th year) Default: 1 Values: Number greater than 0 |
starting
and ending
can also have the value current_year
current_year
by doing current_year-5
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
Attribute | Description & Values | |
---|---|---|
starting | Controls the starting year for collections Default: current_year-5 Values: Number greater than 0 | |
ending | Controls the ending year for collections Default: current_year Values: Number greater than 1 | |
increment | Controls the increment (i.e. every 5th year) Default: 1 Values: Number greater than 0 |
starting
and ending
can also have the value current_year
current_year
by doing current_year-5
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
Attribute | Description & Values | |
---|---|---|
starting | Controls the starting year for collections Default: current_year-5 Values: Number greater than 0 | |
ending | Controls the ending year for collections Default: current_year Values: Number greater than 1 | |
increment | Controls the increment (i.e. every 5th year) Default: 1 Values: Number greater than 0 |
starting
and ending
can also have the value current_year
current_year
by doing current_year-5
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
Attribute | Description & Values | |
---|---|---|
starting | Controls the starting year for collections Default: current_year-5 Values: Number greater than 0 | |
ending | Controls the ending year for collections Default: current_year Values: Number greater than 1 | |
increment | Controls the increment (i.e. every 5th year) Default: 1 Values: Number greater than 0 |
starting
and ending
can also have the value current_year
current_year
by doing current_year-5
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
Attribute | Description & Values | |
---|---|---|
starting | Controls the starting year for collections Default: current_year-5 Values: Number greater than 0 | |
ending | Controls the ending year for collections Default: current_year Values: Number greater than 1 | |
increment | Controls the increment (i.e. every 5th year) Default: 1 Values: Number greater than 0 |
starting
and ending
can also have the value current_year
current_year
by doing current_year-5
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
Attribute | Description & Values | |
---|---|---|
starting | Controls the starting year for collections Default: current_year-5 Values: Number greater than 0 | |
ending | Controls the ending year for collections Default: current_year Values: Number greater than 1 | |
increment | Controls the increment (i.e. every 5th year) Default: 1 Values: Number greater than 0 |
starting
and ending
can also have the value current_year
current_year
by doing current_year-5
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
Attribute | Description & Values | |
---|---|---|
starting | Controls the starting year for collections Default: current_year-5 Values: Number greater than 0 | |
ending | Controls the ending year for collections Default: current_year Values: Number greater than 1 | |
increment | Controls the increment (i.e. every 5th year) Default: 1 Values: Number greater than 0 |
starting
and ending
can also have the value current_year
current_year
by doing current_year-5
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
Attribute | Description & Values | |
---|---|---|
starting | Controls the starting year for collections Default: current_year-5 Values: Number greater than 0 | |
ending | Controls the ending year for collections Default: current_year Values: Number greater than 1 | |
increment | Controls the increment (i.e. every 5th year) Default: 1 Values: Number greater than 0 |
starting
and ending
can also have the value current_year
current_year
by doing current_year-5
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
Attribute | Description & Values | |
---|---|---|
starting | Controls the starting year for collections Default: current_year-5 Values: Number greater than 0 | |
ending | Controls the ending year for collections Default: current_year Values: Number greater than 1 | |
increment | Controls the increment (i.e. every 5th year) Default: 1 Values: Number greater than 0 |
starting
and ending
can also have the value current_year
current_year
by doing current_year-5
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
Attribute | Description & Values | |
---|---|---|
starting | Controls the starting year for collections Default: current_year-6 Values: Number greater than 0 | |
ending | Controls the ending year for collections Default: current_year-1 Values: Number greater than 1 | |
increment | Controls the increment (i.e. every 5th year) Default: 1 Values: Number greater than 0 |
starting
and ending
can also have the value current_year
current_year
by doing current_year-5
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
Attribute | Description & Values | |
---|---|---|
starting | Controls the starting year for collections Default: current_year-6 Values: Number greater than 0 | |
ending | Controls the ending year for collections Default: current_year-1 Values: Number greater than 1 | |
increment | Controls the increment (i.e. every 5th year) Default: 1 Values: Number greater than 0 |
starting
and ending
can also have the value current_year
current_year
by doing current_year-5
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
Attribute | Description & Values | |
---|---|---|
starting | Controls the starting year for collections Default: current_year-5 Values: Number greater than 0 | |
ending | Controls the ending year for collections Default: current_year Values: Number greater than 1 | |
increment | Controls the increment (i.e. every 5th year) Default: 1 Values: Number greater than 0 |
starting
and ending
can also have the value current_year
current_year
by doing current_year-5
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
Attribute | Description & Values | |
---|---|---|
starting | Controls the starting year for collections Default: current_year-5 Values: Number greater than 0 | |
ending | Controls the ending year for collections Default: current_year Values: Number greater than 1 | |
increment | Controls the increment (i.e. every 5th year) Default: 1 Values: Number greater than 0 |
starting
and ending
can also have the value current_year
current_year
by doing current_year-5
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
Attribute | Description & Values | |
---|---|---|
starting | Controls the starting year for collections Default: current_year-5 Values: Number greater than 0 | |
ending | Controls the ending year for collections Default: current_year Values: Number greater than 1 | |
increment | Controls the increment (i.e. every 5th year) Default: 1 Values: Number greater than 0 |
starting
and ending
can also have the value current_year
current_year
by doing current_year-5
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`sync` | Add and Remove Items based on Builders |
`append` | Only Add Items based on Builders |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
`release` | Order Collection by Release Dates |
`alpha` | Order Collection Alphabetically |
`custom` | Order Collection Via the Builder Order |
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options) | Order Collection by any `plex_search` Sort Option |
Attribute | Description & Values | |
---|---|---|
starting | Controls the starting year for collections Default: current_year-5 Values: Number greater than 0 | |
ending | Controls the ending year for collections Default: current_year Values: Number greater than 1 | |
increment | Controls the increment (i.e. every 5th year) Default: 1 Values: Number greater than 0 |
starting
and ending
can also have the value current_year
current_year
by doing current_year-5
Attribute | Description & Values |
---|---|
depth | Controls the depth within the casting credits to search for common actors Default: 5 Values: Number greater than 0 |
limit | Controls the maximum number of collections to create Default: 25 Values: Number greater than 0 |