9.0 KiB
Collectionless Collection
The collectionless Default Collection File is used to create a
Collectionless collection to help Show/Hide Movies/Shows properly in
your library.
Requirements & Recommendations
Supported Library Types: Movie, Show
Requirements:
-
This file needs to run last under
collection_files. -
All other normal collections must use
collection_mode: hide_items. -
Disable the
Minimum automatic collection sizeoption when using thePlex MovieAgent. (Use thefranchiseDefault for automatic collections)
Collection
| Collection | Description |
|---|---|
Collectionless |
Collectionless collection to help Show/Hide Movies/Shows properly in your library. |
Config
The below YAML in your config.yml will create the collections:
libraries:
Movies:
template_variables:
collection_mode: hide_items
collection_files:
- default: collectionless
TV Shows:
template_variables:
collection_mode: hide_items
collection_files:
- default: collectionless
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 |
|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `name_collectionless` | **Description:** Changes the name of the collection.<br>**Values:** New Collection Name |
| `summary_collectionless` | **Description:** Changes the summary of the collection.<br>**Values:** New Collection Summary |
| `sort_title` | **Description:** Sets the sort title for the collection.<br>**Default:** `~_Collectionless`<br>**Values:** Any String |
| `collection_order` | **Description:** Changes the Collection Order for all collections in this file.<br>**Default:** `alpha`<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> |
| `url_poster` | **Description:** Changes the poster url of the collection.<br>**Values:** URL directly to the Image |
| `exclude` | **Description:** Exclude these Collections from being considered for collectionless.<br>**Values:** List of Collections |
| `exclude_prefix` | **Description:** Overrides the [default exclude_prefix list](#exclude-prefix). Exclude Collections with one of these prefixes from being considered for collectionless.<br>**Default:** [default exclude_prefix list](#exclude-prefix)<br>**Values:** List of Prefixes | |
???+ 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:
Movies:
template_variables:
collection_mode: hide_items
collection_files:
- default: collectionless
template_variables:
exclude:
- Marvel Cinematic Universe
collection_order: release
```
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 exclude_prefix (click to expand) ¶"
<div id="exclude-prefix" />
```{ .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 ############
###############################################################################
{%
include-markdown "../../../defaults/both/collectionless.yml"
comments=false
preserve-includer-indent=true
dedent=true
start="# check1"
end="# check2"
%}
```