From f7e26e5c740849f3c614364810384578d9b3c1a4 Mon Sep 17 00:00:00 2001 From: meisnate12 Date: Wed, 12 Oct 2022 10:02:58 -0400 Subject: [PATCH] [112] update seasonal --- VERSION | 2 +- defaults/movie/seasonal.yml | 62 +++++++++++++++++------- docs/defaults/movie/franchise.md | 4 +- docs/defaults/movie/seasonal.md | 81 +++++++++++++++++++++++++++----- 4 files changed, 116 insertions(+), 33 deletions(-) diff --git a/VERSION b/VERSION index 8ae5d37f..c07ad28d 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.17.3-develop111 +1.17.3-develop112 diff --git a/defaults/movie/seasonal.yml b/defaults/movie/seasonal.yml index 78dc6880..733c5d0f 100644 --- a/defaults/movie/seasonal.yml +++ b/defaults/movie/seasonal.yml @@ -19,11 +19,22 @@ templates: sort_by_<>: <> schedule_<>: <> limit_<>: <> + tmdb_collection_<>: <> + tmdb_movie_<>: <> + imdb_list_<>: <> + trakt_list_<>: <> + summary_<>: <> + name_<>: <> + emoji_<>: <> optional: - schedule - tmdb_collection - tmdb_movie - limit + - imdb_list + - trakt_list + - season_summary + - season_name smart_label: sort_by: <>>> limit: <>>> @@ -31,40 +42,57 @@ templates: label: <> schedule: <>>> delete_not_scheduled: true - tmdb_collection: <> - tmdb_movie: <> + tmdb_collection: <>>> + tmdb_movie: <>>> + imdb_list: <>>> + trakt_list: <>>> cache_builders: 1 + summary: <>>> + name: <>>><>>> collections: Seasonal Collections: template: - - name: separator off + - name: separator separator: seasonal + use_separator: false dynamic_collections: Seasonal: type: custom data: - years: 🎊 New Year's Day - valentine: 💘 Valentine's Day - patrick: ☘ St. Patrick's Day - easter: 🐰 Easter - mother: 🤱 Mother's Day - memorial: 🪖 Memorial Day - father: 👨 Father's Day - independence: 🎆 Independence Day - labor: ⚒ Labor Day - halloween: 🎃 Halloween - thanksgiving: 🦃 Thanksgiving - christmas: 🎅 Christmas + years: New Year's Day + valentine: Valentine's Day + patrick: St. Patrick's Day + easter: Easter + mother: Mother's Day + memorial: Memorial Day + father: Father's Day + independence: Independence Day + labor: Labor Day + halloween: Halloween + thanksgiving: Thanksgiving + christmas: Christmas title_format: <> <>s template: - holiday - - translation - shared - arr - imdb template_variables: + emoji: + years: "🎊 " + valentine: "💘 " + patrick: "☘ " + easter: "🐰 " + mother: "🤱 " + memorial: "🪖 " + father: "👨 " + independence: "🎆 " + labor: "⚒ " + halloween: "🎃 " + thanksgiving: "🦃 " + christmas: "🎅 " schedule: years: range(12/26-01/04) valentine: range(02/01-02/29) @@ -125,6 +153,4 @@ dynamic_collections: default: seasonal/<> translation_key: default: season - use_separator: - default: false diff --git a/docs/defaults/movie/franchise.md b/docs/defaults/movie/franchise.md index 72450c7a..9ae8fe2c 100644 --- a/docs/defaults/movie/franchise.md +++ b/docs/defaults/movie/franchise.md @@ -41,8 +41,8 @@ All [Shared Variables](../variables) are available as well as the additional Var | `order_<>` | **Description:** Controls the sort order of the collections in their collection section.
**Values:** Any number | | `collection_mode` | **Description:** Controls the collection mode of all collections in this file.
**Values:**
`default`Library default
`hide`Hide Collection
`hide_items`Hide Items in this Collection
`show_items`Show this Collection and its Items
| | `minimum_items` | **Description:** Controls the minimum items that the collection must have to be created.
**Default:** `2`
**Values:** Any number | -| `movie_<>` | **Description:** Adds the TMDb Movie IDs given to the specified key's collection. Overrides the [default movie](#default-movie) for that movie if used.
**Values:** List of TMDb Movie IDs | -| `name_mapping_<>` | **Description:** Sets the name mapping value for using assets of the specified key's collection.Overrides the [default name_mapping](#default-name_mapping) for that movie if used.
**Values:** Any String | +| `movie_<>` | **Description:** Adds the TMDb Movie IDs given to the specified key's collection. Overrides the [default movie](#default-movie) for that collection if used.
**Values:** List of TMDb Movie IDs | +| `name_mapping_<>` | **Description:** Sets the name mapping value for using assets of the specified key's collection.Overrides the [default name_mapping](#default-name_mapping) for that collection if used.
**Values:** Any String | | `sort_title` | **Description:** Sets the sort title for all collections. Use `<>` to use the collection name. **Example:** `"!02_<>"`
**Values:** Any String with `<>` | | `sort_title_<>` | **Description:** Sets the sort title of the specified key's collection.
**Default:** `sort_title`
**Values:** Any String | | `build_collection` | **Description:** Controls if you want the collection to actually be built. i.e. you may just want these movies sent to Radarr.
**Values:** `false` to not build the collection | diff --git a/docs/defaults/movie/seasonal.md b/docs/defaults/movie/seasonal.md index f2dccdc0..58515856 100644 --- a/docs/defaults/movie/seasonal.md +++ b/docs/defaults/movie/seasonal.md @@ -43,18 +43,24 @@ Note that the `templates_variables:` section only needs to be used if you do wan All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| Variable | Description & Values | -|:-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `use_separator` | **Description:** Turn the separator collection off.
**Values:** `true` to turn on the collection | -| `sep_style` | **Description:** Separator Style.
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | -| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | -| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `schedule_<>` | **Description:** Changes the Schedule of the specified key's collection.
**Default:**
🎊 New Year's Day Moviesrange(12/26-01/04)
💘 Valentine's Day Moviesrange(02/01-02/29)
☘ St. Patrick's Day Moviesrange(03/01-03/18)
🐰 Easter Moviesrange(03/20-04/30)
🤱 Mother's Day Moviesrange(05/05-05/10)
🪖 Memorial Day Moviesrange(5/18-6/7)
👨 Father's Day Moviesrange(06/15-06/20)
🎆 Independence Day Moviesrange(06/23-07/11)
⚒ Labor Day Moviesrange(09/01-09/10)
🎃 Halloween Moviesrange(10/01-10/31)
🦃 Thanksgiving Moviesrange(11/01-11/30)
🎅 Christmas Moviesrange(12/01-12/31)

**Values:** [Any Schedule Option](../../metadata/details/schedule) | -| `exclude` | **Description:** Exclude these Seasons from creating a Dynamic Collection.
**Values:** List of Seasons Keys | -| `seasonal_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | -| `seasonal_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `A collection of <> <>s that may relate to the season.`
**Values:** Any string. | +| Variable | Description & Values | +|:--------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `use_separator` | **Description:** Turn the separator collection off.
**Values:** `true` to turn on the collection | +| `sep_style` | **Description:** Separator Style.
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | +| `tmdb_collection_<>` | **Description:** Adds the TMDb Collection IDs given to the specified key's collection. Overrides the [default tmdb_collection](#default-tmdb_collection) for that collection if used.
**Values:** List of TMDb Collection IDs | +| `tmdb_movie_<>` | **Description:** Adds the TMDb Movie IDs given to the specified key's collection. Overrides the [default tmdb_movie](#default-tmdb_movie) for that collection if used.
**Values:** List of TMDb Movie IDs | | +| `imdb_list_<>` | **Description:** Adds the Movies in the IMDb List to the specified key's collection. Overrides the [default imdb_list](#default-imdb_list) for that collection if used.
**Values:** List of IMDb List URLs | | | +| `trakt_list_<>` | **Description:** Adds the Movies in the Trakt List to the specified key's collection.
**Values:** List of Trakt List URLs | | | | +| `emoji` | **Description:** Controls the Emoji Prefix for all Collections. Set to `""` to remove all emojis.
**Values:** Any String | +| `emoji_<>` | **Description:** Controls the Emoji Prefix for the specified key's collection.
**Values:** Any String | +| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `schedule_<>` | **Description:** Changes the Schedule of the specified key's collection.
**Default:**
🎊 New Year's Day Moviesrange(12/26-01/04)
💘 Valentine's Day Moviesrange(02/01-02/29)
☘ St. Patrick's Day Moviesrange(03/01-03/18)
🐰 Easter Moviesrange(03/20-04/30)
🤱 Mother's Day Moviesrange(05/05-05/10)
🪖 Memorial Day Moviesrange(5/18-6/7)
👨 Father's Day Moviesrange(06/15-06/20)
🎆 Independence Day Moviesrange(06/23-07/11)
⚒ Labor Day Moviesrange(09/01-09/10)
🎃 Halloween Moviesrange(10/01-10/31)
🦃 Thanksgiving Moviesrange(11/01-11/30)
🎅 Christmas Moviesrange(12/01-12/31)

**Values:** [Any Schedule Option](../../metadata/details/schedule) | +| `exclude` | **Description:** Exclude these Seasons from creating a Dynamic Collection.
**Values:** List of Seasons Keys | +| `seasonal_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | +| `seasonal_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `A collection of <> <>s that may relate to the season.`
**Values:** Any string. | The below is an example config.yml extract with some Template Variables added in to change how the file works. @@ -69,4 +75,55 @@ libraries: use_independence: false schedule_thanksgiving: range(10/01-10/30) sort_by: random +``` + +## Default `tmdb_collection` + +```yaml +halloween: + - 185103 # Hotel Transylvania + - 11716 # Addams Family + - 750822 # Addams Family Animated + - 313086 # Conjuring + - 91361 # Halloween Collection + - 8581 # A Nightmare on Elm Street Collection + - 1733 # The Mummy Collection + - 8091 # Alien Collection + - 2980 # Ghostbusters + - 751156 # Hocus Pocus +``` + +## Default `tmdb_collection` + +```yaml +halloween: + - 23437 # A Nightmare on Elm Street (2010) +``` + +## Default `imdb_list` + +```yaml +years: https://www.imdb.com/list/ls066838460/ +valentine: + - https://www.imdb.com/list/ls000094398/ + - https://www.imdb.com/list/ls057783436/ + - https://www.imdb.com/list/ls064427905/ +patrick: https://www.imdb.com/list/ls063934595/ +easter: + - https://www.imdb.com/list/ls062665509/ + - https://www.imdb.com/list/ls051733651/ +mother: https://www.imdb.com/list/ls072551197/ +memorial: https://www.imdb.com/list/ls002014923/ +father: https://www.imdb.com/list/ls020471057/ +independence: + - https://www.imdb.com/list/ls068664510/ + - https://www.imdb.com/list/ls080925875/ +labor: https://www.imdb.com/list/ls002014923/ +halloween: + - https://www.imdb.com/list/ls023118929/ + - https://www.imdb.com/list/ls000099714/ +thanksgiving: + - https://www.imdb.com/list/ls000835734/ + - https://www.imdb.com/list/ls091597850/ +christmas: https://www.imdb.com/list/ls000096828/ ``` \ No newline at end of file