7.8 KiB

Raw Blame History

Tautulli Charts Collections

The tautulli Default Collection File is used to create collections based on Tautulli/Plex Charts.

Requirements & Recommendations

Supported Library Types: Movie, Show

Collections Section 020

Collection	Key	Description
`Plex Popular`	`popular`	Collection of the most Popular Movies/Shows on Plex.
`Plex Watched`	`watched`	Collection of the most Watched Movies/Shows on Plex.

Config

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

libraries:
  Movies:
    collection_files:
      - pmm: tautulli
  TV Shows:
    collection_files:
      - pmm: tautulli

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

list_days Description: Changes the list_days attribute of the builder for all collections in a Defaults file.
Values: Number greater than 0

list_days_<<key>>¹ Description: Changes the list_days attribute of the builder of the specified key's collection.
Values: Number greater than 0

list_size Description: Changes the list_size attribute of the builder for all collections in a Defaults file.
Values: Number greater than 0

list_size_<<key>>¹ Description: Changes the list_size attribute of the builder of the specified key's collection.
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: tautulli
        template_variables:
          use_watched: false #(1)!
          list_days_popular: 7 #(2)!
          list_size_popular: 10 #(3)!
          visible_library_popular: true #(4)!
          visible_home_popular: true #(5)!
          visible_shared_popular: true #(6)!

Do not create the "Plex Watched" collection
Change "Plex Popular" to look at items from the past 7 days
Change "Plex Popular" to have a maximum of 10 items
Pin the "Plex Popular" collection to the Recommended tab of the library
Pin the "Plex Popular" collection to the home screen of the server owner
Pin the "Plex Popular" collection to the home screen of other users of the server

7.8 KiB Raw Blame History