Collectionless Collections¶

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 size option when using the Plex Movie Agent. (Use the franchise Default 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.

Example Template Variable Amendments (Click to Expand)

The below is an example config.yml extract with some Template Variables added in to change how the file works.

Click the icon to learn more

libraries:
  Movies:
    template_variables:
      collection_mode: hide_items #(1)!
    collection_files:
      - default: collectionless
        template_variables:
          exclude:
            - Marvel Cinematic Universe #(2)!
          collection_order: release #(3)!

Sets the collection mode to "Hide items which are in collections" for any Collection that is processed as part of the Kometa run against this library.
Prevent media within the "Marvel Cinematic Universe" Collection from being considered for collectionless.
Sort the "Collectionless" Collection by release date

File-Specific Template Variables are variables available specifically for this Kometa Defaults File.

Warning

Shared Collection Variables are NOT available to this Defaults File.

File-Specific Template Variables

Variable Description & Values

collection_order

Description: Changes the Collection Order for all collections in a Defaults File.
Default: alpha
Values:

`release`	Order Collection by Release Dates
`alpha`	Order Collection Alphabetically
`custom`	Order Collection Via the Builder Order
Any `plex_search` Sort Option	Order Collection by any `plex_search` Sort Option

sort_title Description: Sets the sort title for the collection.
Default: ~_Collectionless
Values: Any String

url_poster Description: Changes the poster url of the collection.
Values: URL directly to the Image

exclude Description: Exclude these Collections from being considered for collectionless.
Values: List of Collections

exclude_prefix Description: Overrides the default exclude_prefix list. Exclude Collections with one of these prefixes from being considered for collectionless.
Default: default exclude_prefix list
Values: List of Prefixes

name_collectionless Description: Changes the name of the collection.
Values: New Collection Name

summary_collectionless Description: Changes the summary of the collection.
Values: New Collection Summary

Default Value Source¶

This is a reference showing the source of the data used in this Defaults File.

Nothing in this section is required for using the Defaults File, but it can be useful for understanding where the data comes from.

Nothing in this section is directly useful for customizing this Defaults File.

Nothing here is a code example for end user use. It all looks like code, since it is taken directly from the Kometa source code to ensure it is up-to-date and accurate, but it is not intended for end user use, and is expressed in a different format to the way you would customize the defaults via Template Variables.

I want to customize this default

To learn how to customize any Defaults File using Template Variables see the Defaults Usage Guide.

Each Defaults File has its own set of Template Variables, which are used to control the behavior of that default. The Template Variables for this file can be found here.

I want to know what's behind the defaults

The lists provided here are for reference to show what values will be in use if no customization is done.

These do not show how to customize the defaults.

Nothing here is a code example for end user use. It all looks like code, since it is taken directly from the Kometa source code to ensure it is up-to-date and accurate, but it is not intended for end user use.

These lists are provided for reference only.

If you want to customize these collections, refer to the Defaults Usage Guide to learn how to use Template Variables.

Collectionless Collection

The Collectionless collection use the plex_collectionless Builder to create the collection.

Collections and their items are excluded from this collection based on a name prefix or the collection name.