Plex-Meta-Manager/docs/defaults/chart/other.md
2023-12-13 16:44:44 -05:00

6.4 KiB

Other Charts Collections

The other_chart Default Collection File is used to create collections based on other Charts.

Requirements & Recommendations

Supported Library Types: Movie, Show

Recommendations: The StevenLu's Popular Movies and Top 10 Pirated Movies of the Week Collections only work with Movie Libraries

Collections Section 020

Collection Key Description
AniDB Popular anidb Collection of the most Popular Anime on AniDB.
Common Sense Selection commonsense Collection of Common Sense Selection Movies/Shows.
StevenLu's Popular Movies stevenlu Collection of StevenLu's Popular Movies.
Top 10 Pirated Movies of the Week pirated Collection of the Top 10 Pirated Movies of the Week.

Config

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

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

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_anidb Description: Changes the Builder Limit of the AniDB Popular Collection.
Default: 30
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:
    collection_files:
      - pmm: other_chart
        template_variables:
          use_anidb: false #(1)!
          visible_library_commonsense: true #(2)!
          visible_home_commonsense: true #(3)!
          visible_shared_commonsense: true #(4)!
  1. Do not create the "AniDB Popular" collection
  2. Pin the "Common Sense Selection" collection to the Recommended tab of the library
  3. Pin the "Common Sense Selection" collection to the home screen of the server owner
  4. Pin the "Common Sense Selection" collection to the home screen of other users of the server