You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
157 lines
22 KiB
157 lines
22 KiB
# Franchise Collections
|
|
|
|
The `franchise` Default Collection File is used to create collections based on popular TV Show franchises, and can be
|
|
used as a replacement to the TMDb Collections that Plex creates out-of-the-box.
|
|
|
|
Unlike most Default Collection Files, Franchise works by placing collections inline with the main library items if your
|
|
library allows it. For example, the "Pretty Little Liars" franchise collection will appear next to the "Pretty Little
|
|
Liars" show in your library so that you have easy access to the other shows in the franchise.
|
|
|
|
**[This file has a Movie Library Counterpart.](../movie/franchise.md)**
|
|
|
|
|
|
|
|
## Requirements & Recommendations
|
|
|
|
Supported Library Types: Show
|
|
|
|
## Collections
|
|
|
|
| Collection | Key | Description |
|
|
|:------------------------------------------------------------|:----------------------------------------------------|:---------------------------------------------------|
|
|
| `<<Collection Name>>`<br>**Example:** `Pretty Little Liars` | `<<Starting TMDb Show ID>>`<br>**Example:** `31917` | Collection of Shows specified for this Collection. |
|
|
|
|
## Config
|
|
|
|
The below YAML in your config.yml will create the collections:
|
|
|
|
```yaml
|
|
libraries:
|
|
TV Shows:
|
|
collection_files:
|
|
- default: franchise
|
|
```
|
|
|
|
## Template Variables
|
|
|
|
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
|
make your own local copy.
|
|
|
|
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
|
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
|
|
|
??? abstract "Variable Lists (click to expand)"
|
|
|
|
* **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file.
|
|
|
|
???+ warning
|
|
|
|
[Shared Collection Variables](../collection_variables.md) are NOT available to this default file.
|
|
|
|
=== "File-Specific Template Variables"
|
|
|
|
| Variable | Description & Values |
|
|
|:-----------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| `summary_<<key>>`<sup>1</sup> | **Description:** Changes the summary of the specified key's collection.<br>**Values:** New Collection Summary |
|
|
| `collection_section` | **Description:** Adds a sort title with this collection sections.<br>**Values:** Any number |
|
|
| `order_<<key>>`<sup>1</sup> | **Description:** Controls the sort order of the collections in their collection section.<br>**Values:** Any number |
|
|
| `collection_mode` | **Description:** Controls the collection mode of all collections in this file.<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`hide`</td><td>Hide Collection</td></tr><tr><td>`hide_items`</td><td>Hide Items in this Collection</td></tr><tr><td>`show_items`</td><td>Show this Collection and its Items</td></tr></table> |
|
|
| `minimum_items` | **Description:** Controls the minimum items that the collection must have to be created.<br>**Default:** `2`<br>**Values:** Any number |
|
|
| `name_mapping_<<key>>`<sup>1</sup> | **Description:** Sets the name mapping value for using assets of the specified key's collection.<br>**Values:** Any String |
|
|
| `sort_title` | **Description:** Sets the sort title for all collections. Use `<<collection_name>>` to use the collection name. **Example:** `"!02_<<collection_name>>"`<br>**Values:** Any String with `<<collection_name>>` |
|
|
| `sort_title_<<key>>`<sup>1</sup> | **Description:** Sets the sort title of the specified key's collection.<br>**Default:** `sort_title`<br>**Values:** Any String |
|
|
| `build_collection` | **Description:** Controls if you want the collection to actually be built. i.e. you may just want these shows sent to Sonarr.<br>**Values:** `false` to not build the collection |
|
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in this file.<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
|
| `exclude` | **Description:** Exclude these Collections from creating a Dynamic Collection.<br>**Values:** List of Collection IDs |
|
|
| `data` | **Description:** Overrides the [default data dictionary](#data). Defines the data that the custom dynamic collection processes.<br>**Values:** Dictionary List of TMDb Main Show ID |
|
|
| `append_data` | **Description:** Appends to the [default data dictionary](#data).<br>**Values:** Dictionary List of TMDb Main Show ID |
|
|
| `remove_data` | **Description:** Removes from the [default data dictionary](#data).<br>**Values:** List of TMDb Main Show IDs to remove |
|
|
| `addons` | **Description:** Overrides the [default addons dictionary](#addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Dictionary List of TMDb Show IDs |
|
|
| `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).<br>**Values:** Dictionary List of TMDb Show IDs |
|
|
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).<br>**Values:** Dictionary List of TMDb Show IDs |
|
|
| `sonarr_add_missing` | **Description:** Override Sonarr `add_missing` attribute for all collections in a Defaults file.<br>**Values:** `true` or `false` |
|
|
| `sonarr_add_missing_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `add_missing` attribute of the specified key's collection.<br>**Default:** `sonarr_add_missing`<br>**Values:** `true` or `false` |
|
|
| `sonarr_folder` | **Description:** Override Sonarr `root_folder_path` attribute for all collections in a Defaults file.<br>**Values:** Folder Path |
|
|
| `sonarr_folder_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `root_folder_path` attribute of the specified key's collection.<br>**Default:** `sonarr_folder`<br>**Values:** Folder Path |
|
|
| `sonarr_tag` | **Description:** Override Sonarr `tag` attribute for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
|
| `sonarr_tag_<<key>>`<sup>1</sup> | **Description:** Override Sonarr `tag` attribute of the specified key's collection.<br>**Default:** `sonarr_tag`<br>**Values:** List or comma-separated string of tags |
|
|
| `item_sonarr_tag` | **Description:** Used to append a tag in Sonarr for every show found by the builders that's in Sonarr for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
|
| `item_sonarr_tag_<<key>>`<sup>1</sup> | **Description:** Used to append a tag in Sonarr for every show found by the builders that's in Sonarr of the specified key's collection.<br>**Default:** `item_sonarr_tag`<br>**Values:** List or comma-separated string of tags |
|
|
|
|
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
|
`<<key>>` with when calling.
|
|
|
|
???+ example "Example Template Variable Amendments"
|
|
|
|
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
|
|
|
Click the :fontawesome-solid-circle-plus: icon to learn more
|
|
|
|
```yaml
|
|
libraries:
|
|
TV Shows:
|
|
collection_files:
|
|
- default: franchise
|
|
template_variables:
|
|
append_data:
|
|
"31917": Pretty Little Liars #(1)!
|
|
append_addons:
|
|
31917: [46958, 79863, 110531] #(2)!
|
|
sonarr_add_missing: true #(3)!
|
|
```
|
|
|
|
1. Add [TMDb Show 31917](https://www.themoviedb.org/tv/31917-pretty-little-liars) to the data dictionary
|
|
2. Add [TMDb Shows 46958](https://www.themoviedb.org/tv/46958), [79863](https://www.themoviedb.org/tv/79863)
|
|
and [110531](https://www.themoviedb.org/tv/110531) as addons of [TMDb Show
|
|
31917](https://www.themoviedb.org/tv/31917-pretty-little-liars) so that they appear in the same collection
|
|
3. Add items missing from your library in Plex to Sonarr
|
|
|
|
## Default Values
|
|
|
|
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
|
show how to change a name or a list.**
|
|
|
|
If you want to customize these values, use the methods described above.
|
|
|
|
??? example "Default `data` (click to expand) <a class="headerlink" href="#data" title="Permanent link">¶</a>"
|
|
|
|
<div id="data" />
|
|
|
|
```{ .dtd .no-copy }
|
|
###############################################################################
|
|
################################## IMPORTANT ##################################
|
|
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
|
|
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
|
|
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
|
|
###############################################################################
|
|
data: {%
|
|
include-markdown "../../../defaults/show/franchise.yml"
|
|
comments=false
|
|
preserve-includer-indent=false
|
|
start="data:"
|
|
end="template:"
|
|
%}
|
|
```
|
|
|
|
??? example "Default `addons` (click to expand) <a class="headerlink" href="#addons" title="Permanent link">¶</a>"
|
|
|
|
<div id="addons" />
|
|
|
|
```{ .dtd .no-copy }
|
|
###############################################################################
|
|
################################## IMPORTANT ##################################
|
|
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
|
|
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
|
|
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
|
|
###############################################################################
|
|
addons: {%
|
|
include-markdown "../../../defaults/show/franchise.yml"
|
|
comments=false
|
|
preserve-includer-indent=false
|
|
start="addons:"
|
|
%}
|
|
```
|