Mirrors/Plex-Meta-Manager
2
0
Fork 0
mirror of https://github.com/meisnate12/Plex-Meta-Manager synced 2024-12-28 22:03:09 +00:00
Code Issues Projects Releases Packages Wiki Activity
Plex-Meta-Manager/docs/defaults/both/streaming.md

7.5 KiB
Raw Blame History

Streaming Collections

The streaming Default Metadata File is used to dynamically create collections based on the streaming Services that your media is available on.

Requirements & Recommendations

Supported Library Types: Movie, Show

Collections Section 03

Collection Key Description
Streaming Collections separator Separator Collection to denote the Section of Collections.
All 4 Movies/Shows all4 Collection of Movies/Shows Streaming on All 4.
Apple TV+ Movies/Shows appletv Collection of Movies/Shows Streaming on Apple TV+.
BET+ Movies/Shows bet Collection of Movies/Shows Streaming on BET+.
BritBox Movies/Shows britbox Collection of Movies/Shows Streaming on BritBox.
Crunchyroll Movies/Shows crunchyroll Collection of Movies/Shows Streaming on Crunchyroll.
Disney+ Movies/Shows disney Collection of Movies/Shows Streaming on Disney+.
hayu Movies/Shows hayu Collection of Movies/Shows Streaming on hayu.
HBO Max Movies/Shows hbomax Collection of Movies/Shows Streaming on HBO Max.
Hulu Movies/Shows hulu Collection of Movies/Shows Streaming on Hulu.
Netflix Movies/Shows netflix Collection of Movies/Shows Streaming on Netflix.
NOW Movies/Shows now Collection of Movies/Shows Streaming on NOW.
Paramount+ Movies/Shows paramount Collection of Movies/Shows Streaming on Paramount+.
Peacock Movies/Shows peacock Collection of Movies/Shows Streaming on Peacock.
Prime Video Movies/Shows amazon Collection of Movies/Shows Streaming on Prime Video.
Showtime Movies/Shows showtime Collection of Movies/Shows Streaming on Showtime.

Config

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

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

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.

This file contains a Separator so all Shared Separator Variables are available as well.

Variable Description & Values
limit Description: Changes the Builder Limit for all collections in a Defaults file.
Values: Number Greater then 0
limit_<<key>>1 Description: Changes the Builder Limit of the specified key's collection.
Default: limit
Values: Number Greater then 0
sort_by Description: Changes the Smart Filter Sort for all collections in a Defaults file.
Default: release.desc
Values: Any smart_filter Sort Option
sort_by_<<key>>1 Description: Changes the Smart Filter Sort of the specified key's collection.
Default: sort_by
Values: Any smart_filter Sort Option
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
exclude Description: Exclude these Streaming Services from creating a Dynamic Collection.
Values: List of Streaming Service Keys
streaming_name Description: Changes the title format of the Dynamic Collections.
Default: <<key_name>> <<library_translationU>>s
Values: Any string with <<key_name>> in it.
streaming_summary Description: Changes the summary format of the Dynamic Collections.
Default: <<library_translationU>>s streaming on <<key_name>>.
Values: Any string.
  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: streaming
        template_variables:
          use_separator: false
          sep_style: stb
          use_all4: false
          order_britbox: 01
          visible_library_disney: true
          visible_home_disney: true
          visible_shared_disney: true
          sonarr_add_missing_hulu: true
          radarr_add_missing_amazon: true
          sort_by: random