Plex-Meta-Manager/docs/defaults/chart/tmdb.md
2023-01-04 14:46:04 -05:00

6.6 KiB

TMDb Charts Collections

The tmdb Default Metadata File is used to create collections based on TMDb Charts.

The TMDb Airing Today and TMDb On The Air Collections only work with Show Libraries but the rest of the collections work with both Movie and Show libraries.

Collections Section 01

Collection Key Description
TMDb Popular popular Collection of the Most Popular Movies/Shows on TMDb.
TMDb Top Rated top Collection of the Top Rated Movies/Shows on TMDb.
TMDb Trending trending Collection of Trending Movies/Shows on TMDb.
TMDb Airing Today airing Collection of Shows Airing Today on TMDb.
TMDb On The Air air Collection of Shows currently On The Air on TMDb.

Config

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

libraries:
  Movies:
    metadata_path:
      - pmm: tmdb
  TV Shows:
    metadata_path:
      - pmm: tmdb

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.

All Shared Collection Variables are available as well as the additional Variables below which can be used to customize the file.

Variable Description & Values
limit Description: Changes the Builder Limit for all collections in a Defaults file.
Default: 100
Values: Number Greater then 0
limit_<<key>>1 Description: Changes the Builder Limit of the specified key's collection.
Default: limit
Values: Number Greater then 0
sync_mode Description: Changes the Sync Mode for all collections in a Defaults file.
Default: sync
Values:
syncAdd and Remove Items based on Builders
appendOnly Add Items based on Builders
sync_mode_<<key>>1 Description: Changes the Sync Mode of the specified key's collection.
Default: sync_mode
Values:
syncAdd and Remove Items based on Builders
appendOnly Add Items based on Builders
collection_order Description: Changes the Collection Order for all collections in a Defaults file.
Default: custom
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
collection_order_<<key>>1 Description: Changes the Collection Order of the specified key's collection.
Default: collection_order
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
  1. Each default collection has a key that when calling to effect a specific collection you must replace <<key>> with when calling.

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

libraries:
  Movies:
    metadata_path:
      - pmm: tmdb
        template_variables:
          use_trending: false
          limit_popular: 20
          visible_library_popular: true
          visible_home_popular: true
          visible_shared_popular: true