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

7.1 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 Anticipated anticipated Collection of the Most Anticipated Movies/Shows on Trakt.
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 Variable Default Values

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.

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.

{% include-markdown "../collection_variables.md" %}

Example Template Variable Amendments

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

???+ tip

Anywhere you see this icon:

> :fontawesome-solid-circle-plus:

That's a tooltip, you can press them to get more information.
libraries:
  Movies:
    metadata_path:
      - pmm: trakt
        template_variables:
          use_collected: false #(1)!
          use_recommended: false #(2)!
          limit: 20 #(3)!
          visible_library_popular: true #(4)!
          visible_home_popular: true #(5)!
          visible_shared_popular: true #(6)!
  1. Do not create the "Trakt Collected" collection
  2. Do not create the "Trakt Recommended" collection
  3. Change all collections built by this file to have a maximum of 20 items
  4. Pin the "Trakt Popular" collection to the Recommended tab of the library
  5. Pin the "Trakt Popular" collection to the home screen of the server owner
  6. Pin the "Trakt Popular" collection to the home screen of other users of the server