Mirrors/Plex-Meta-Manager
2
0
Fork 0
mirror of https://github.com/meisnate12/Plex-Meta-Manager synced 2024-11-26 22:40:26 +00:00
Code Issues Projects Releases Packages Wiki Activity
Plex-Meta-Manager/docs/defaults/both/collectionless.md
meisnate12 25f7e3f28c [189] wiki update
2022-11-07 22:02:07 -05:00

7.3 KiB
Raw Blame History

Collectionless Collection

The collectionless Default Metadata File is used to create a Collectionless collection to help Show/Hide Movies/Shows properly in your library.

For this file to work it needs to run last under metadata_path and all other normal collections must use collection_mode: hide_items.

This file works with Movie and Show Libraries.

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
    metadata_path:
      - pmm: collectionless
  TV Shows:
    template_variables:
      collection_mode: hide_items
    metadata_path:
      - 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 templates_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:
releaseOrder Collection by Release Dates
alphaOrder Collection Alphabetically
customOrder Collection Via the Builder Order
Any plex_search Sort OptionOrder 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

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
    metadata_path:
      - pmm: collectionless
        template_variables:
          exclude:
            - Marvel Cinematic Universe
          collection_order: release

Default exclude_prefix

exclude_prefix:
  - "!"
  - "~"