7.6 KiB

Raw Blame History

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: For this file to work it needs to run last under collection_files and all other normal collections must use collection_mode: hide_items

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:
      - pmm: collectionless
  TV Shows:
    template_variables:
      collection_mode: hide_items
    collection_files:
      - pmm: 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 is its default value if it has one if not it's just ignored.

Shared Collection Variables are NOT available to this default file.

Variable Description & Values

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

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

collection_order

Description: Changes the Collection Order for all collections in this 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

url_poster Description: Changes the poster url of thecollection.
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

Example Template Variable Amendments

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

libraries:
  Movies:
    template_variables:
      collection_mode: hide_items
    collection_files:
      - pmm: collectionless
        template_variables:
          exclude:
            - Marvel Cinematic Universe
          collection_order: release

Default values

???+ tip

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.

Default `exclude_prefix`

exclude_prefix:
  - "!"
  - "~"

7.6 KiB Raw Blame History