Plex-Meta-Manager/docs/defaults/chart/trakt.md
2023-09-25 18:10:21 -05:00

6.7 KiB

Trakt Charts Collections

The trakt Default Metadata File is used to create collections based on Trakt Charts.

Requirements & Recommendations

Supported Library Types: Movie, Show

Requirements: Trakt Authentication

Collections Section 020

Collection Key Description
Trakt Collected collected Collection of the Most Collected Movies/Shows on Trakt.
Trakt Popular popular Collection of the Most Popular Movies/Shows on Trakt.
Trakt Recommended recommended Collection of Recommended Movies/Shows on Trakt.
Trakt Trending trending Collection of Trending Movies/Shows on Trakt.
Trakt Watched watched Collection of the Most Watched Movies/Shows on Trakt.

Config

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

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

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 than 0
limit_<<key>>1 Description: Changes the Builder Limit of the specified key's collection.
Default: limit
Values: Number Greater than 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: trakt
        template_variables:
          use_collected: false
          use_recommended: false
          use_watched: false
          limit: 20
          visible_library_popular: true
          visible_home_popular: true
          visible_shared_popular: true