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

9.2 KiB

FlixPatrol Charts Collections

The flixpatrol Default Metadata File is used to create collections based on FlixPatrol Charts.

Requirements & Recommendations

Supported Library Types: Movie, Show

Collections Section 020

Collection Key Description
Netflix Top 10 Movies/Shows netflix Collection of the Top Movies/Shows on Netflix according to FlixPatrol.
Disney+ Top 10 Movies/Shows disney Collection of the Top Movies/Shows on Disney+ according to FlixPatrol.
MAX Top 10 Movies/Shows max Collection of the Top Movies/Shows on MAX according to FlixPatrol.
Hulu Top 10 Movies/Shows hulu Collection of the Top Movies/Shows on Hulu according to FlixPatrol.
Paramount+ Top 10 Movies/Shows paramount Collection of the Top Movies/Shows on Paramount+ according to FlixPatrol.
Prime Video Top 10 Movies/Shows prime Collection of the Top Movies/Shows on Prime Video according to FlixPatrol.
Apple+ Top 10 Movies/Shows apple Collection of the Top Movies/Shows on Apple+ according to FlixPatrol.

Config

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

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

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: 10
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
location Description: Changes the Builder Location for all collections in a Defaults file.
Default: world
Values: location Attribute Options
location_<<key>>1 Description: Changes the Builder Location of the specified key's collection.
Default: location
Values: location Attribute Options
time_window Description: Changes the Builder Time Window for all collections in a Defaults file.
Default: last_week
Values: time_window Attribute Options
time_window_<<key>>1 Description: Changes the Builder Time Window of the specified key's collection.
Default: time_window
Values: time_window Attribute Options
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: flixpatrol
        template_variables:
          location: united_states
          time_window: last_month