6.9 KiB

Raw Blame History

TMDb Charts Collections

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

Requirements & Recommendations

Supported Library Types: Movie, Show

Recommendations: The TMDb Airing Today and TMDb On The Air Collections only work with Show Libraries

Collections Section 020

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:
    collection_files:
      - pmm: tmdb
  TV Shows:
    collection_files:
      - pmm: tmdb

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>>¹ 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:

`sync`	Add and Remove Items based on Builders
`append`	Only Add Items based on Builders

sync_mode_<<key>>¹

Description: Changes the Sync Mode of the specified key's collection.
Default: sync_mode
Values:

`sync`	Add and Remove Items based on Builders
`append`	Only Add Items based on Builders

collection_order

Description: Changes the Collection Order for all collections in a Defaults file.
Default: custom
Values:

`release`	Order Collection by Release Dates
`alpha`	Order Collection Alphabetically
`custom`	Order Collection Via the Builder Order
Any `plex_search` Sort Option	Order Collection by any `plex_search` Sort Option

collection_order_<<key>>¹

Description: Changes the Collection Order of the specified key's collection.
Default: collection_order
Values:

`release`	Order Collection by Release Dates
`alpha`	Order Collection Alphabetically
`custom`	Order Collection Via the Builder Order
Any `plex_search` Sort Option	Order Collection by any `plex_search` Sort Option

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:
    collection_files:
      - pmm: tmdb
        template_variables:
          use_trending: false #(1)!
          limit_popular: 20 #(2)!
          visible_library_popular: true #(3)!
          visible_home_popular: true #(4)!
          visible_shared_popular: true #(5)!

Do not create the "TMDb Trending" collection
Change "TMDb Popular" to have a maximum of 20 items
Pin the "TMDb Popular" collection to the Recommended tab of the library
Pin the "TMDb Popular" collection to the home screen of the server owner
Pin the "TMDb Popular" collection to the home screen of other users of the server

6.9 KiB Raw Blame History