Plex-Meta-Manager/docs/defaults/chart/basic.md

5.8 KiB

Basic Chart Default Metadata File

The - pmm: chart/basic Metadata File is used to dynamically create collections based on recently released media in your library.

Example Collections Created:

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

libraries:
  Movies:
    metadata_path:
      - pmm: chart/basic

Template Variables

Template Variables can be used to manipulate the file from the default settings which are provided.

Note that the templates_variables: section only needs to be used if you do NOT want to use the default settings.

As this file is more complex than others, a key system is used to control each collection that is created by the file. Each key refers to one chart and is used to control multiple template variables.

Below are the keys and what they refer to:

Key Chart
released Newly Released
episodes New Episodes

Below are the available variables which can be used to customize the file. Note that any use of key within the variable should be replaced with the key from the above table (i.e. use_episodes instead of use_key, order_released instead of order_key)

Variable Usage Default Value Values
use_key Turn the collection on/off true true or false
order_key Determine collection order in its section Alphabetical Order Any number (i.e. 01 for order_released to put released first in the list of charts)
summary_key Determines summary of collection Any summary text
limit_key Determines limit of collection 100 Any number
collection_order_key Determines collection order of the collection
visible_library_key Set visible_library for the collection false true or false
visible_home_key Set visible_home for the collection false true or false
visible_shared_key Set visible_shared for the collection false true or false
item_sonarr_tag_key Sonarr Tag for existing items false Tag(s) to add to existing items
item_radarr_tag_key Radarr Tag for existing items Tag(s) to add to existing items
collection_section Controls the sort order of these collections against other default collections 01 Any number
collection_mode Controls the collection mode of these collections default default - Library default
hide - Hide Collection
hide_items- Hide Items in this Collection
show_items - Show this Collection and its Items

The below shows an example config.yml with all the template_variables set away from their defaults:

libraries:
  Movies:
    metadata_path:
      - pmm: basic
        template_variables:
          use_released: false
          order_released: 01
          summary_released: "Newly Released items"
          limit_released: 10
          visible_library_released: true
          visible_home_released: true
          visible_shared_released: true
          item_sonarr_tag_released: New Episodes
          item_radarr_tag_season: Newly Released
          collection_section: 09
          collection_mode: show_items