Genre Collections

The genre Default Collection File is used to dynamically create collections based on the genres available in your library.

This file also merges similarly named genres (such as "Sci-Fi", "SciFi" and "Sci-Fi & Fantasy") into one ("Science Fiction")

Requirements & Recommendations

Supported Library Types: Movie, Show

Collections Section 060

Collection	Key	Description
`Genre Collections`	`separator`	Separator Collection to denote the Section of Collections.
`<<Genre>> Movies/Shows` Example: `Action Movies`	`<<Genre>>` Example: `Action`	Collection of Movies/Shows that have this Genre.

Config

The below YAML in your config.yml will create the collections:

libraries:
  Movies:
    collection_files:
      - default: genre
  TV Shows:
    collection_files:
      - default: genre

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.

* **Shared Template Variables** are additional variables shared across the Kometa Defaults.

* **Shared Separator Variables** are additional variables available since this Default contains a 
[Separator](../separators.md).

=== "File-Specific Template Variables"

    | Variable                      | Description & Values                                                                                                                                                                                                                                   |
    |:------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
    | `limit`                       | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0                                                                                                                                |
    | `limit_<<key>>`<sup>1</sup>   | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0                                                                                                             |
    | `sort_by`                     | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options)                                      |
    | `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options)                                                |
    | `exclude`                     | **Description:** Exclude these Genres from creating a Dynamic Collection.<br>**Values:** List of Genres found in your library                                                                                                                          |
    | `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 Genres found in your library |
    | `append_addons`               | **Description:** Appends to the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Genres found in your library                                                                                                                   |
    | `remove_addons`               | **Description:** Removes from the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Genres found in your library                                                                                                                 |
    | `name_format`                 | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it.                                                                    |
    | `summary_format`              | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that have the genre <<key_name>>.`<br>**Values:** Any string.                                                                       |

    1. Each default collection has a `key` that when calling to effect a specific collection you must replace 
    `<<key>>` with when calling.

=== "Shared Template Variables"

    {%
      include-markdown "../collection_variables.md"
    %}

=== "Shared Separator Variables"

    {%
      include-markdown "../separator_variables.md"
    %}

???+ 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:
    collection_files:
      - default: genre
        template_variables:
          sep_style: red #(1)!
          exclude:
            - Politics #(2)!
            - News #(3)!
          append_addons:
            Horror: #(4)!
              - Thriller #(5)! # Adds all thriller items to the Horror collection
```

1.  Use the red [Separator Style](../separators.md#separator-styles)
2.  Do not create a "Politics" collection, and do not include it in any other collections that it may be in as part 
of an "include"
3.  Do not create a "News" collection, and do not include it in any other collections that it may be in as part of 
an "include"
4.  Create a "Horror" collection, this genre does not need to exist in your library
5.  Include the "Thriller" genre in the "Horror" collection, the "Thriller" genre must exist in your library if the 
"Horror" genre does not

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 addons (click to expand) ¶"

<div id="addons" />

```yaml
addons: {%    
  include-markdown "../../../defaults/both/genre.yml" 
  comments=false
  preserve-includer-indent=false
  start="addons:"
%}
```

7.7 KiB Raw Blame History