mirror of
https://github.com/meisnate12/Plex-Meta-Manager
synced 2024-11-22 12:33:10 +00:00
Merge remote-tracking branch 'meisnate12/nightly' into nightly
This commit is contained in:
bullmoose20
commit
f451a3ce49
113 changed files with 334 additions and 829 deletions
|
|
@ -3,7 +3,9 @@
|
|||
version: 2
|
||||
|
||||
build:
|
||||
image: latest
|
||||
os: ubuntu-22.04
|
||||
tools:
|
||||
python: "3.7"
|
||||
|
||||
sphinx:
|
||||
configuration: docs/conf.py
|
||||
|
|
@ -11,8 +13,6 @@ sphinx:
|
|||
formats: []
|
||||
|
||||
python:
|
||||
version: "3.7"
|
||||
|
||||
install:
|
||||
- requirements: docs/requirements.txt
|
||||
|
||||
|
|
|
|||
2
VERSION
2
VERSION
|
|
@ -1 +1 @@
|
|||
1.19.1-develop1
|
||||
1.19.1-develop5
|
||||
|
|
|
|||
|
|
@ -313,6 +313,7 @@ dynamic_collections:
|
|||
- FilmNation Entertainment
|
||||
- Flynn Picture Company
|
||||
- Focus Features
|
||||
- Food Network
|
||||
- Fortiche Production
|
||||
- Fox Television Studios
|
||||
- Freckle Films
|
||||
|
|
@ -332,8 +333,9 @@ dynamic_collections:
|
|||
- HartBeat Productions
|
||||
- Hartswood Films
|
||||
- Hasbro
|
||||
- Heyday Films
|
||||
- HBO
|
||||
- Heyday Films
|
||||
- Hughes Entertainment
|
||||
- Hurwitz & Schlossberg Productions
|
||||
- Hyperobject Industries
|
||||
- Icon Entertainment International
|
||||
|
|
@ -358,6 +360,7 @@ dynamic_collections:
|
|||
- Legendary Pictures
|
||||
- Let's Not Turn This Into a Whole Big Production
|
||||
- Levity Entertainment Group
|
||||
- Lightstorm Entertainment
|
||||
- Likely Story
|
||||
- Lionsgate
|
||||
- Live Entertainment
|
||||
|
|
@ -368,7 +371,7 @@ dynamic_collections:
|
|||
- Mandalay Entertainment
|
||||
- Mandarin
|
||||
- Mandarin Motion Pictures Limited
|
||||
- marv
|
||||
- Marv Films
|
||||
- Marvel Animation
|
||||
- Marvel Studios
|
||||
- Matt Tolmach Productions
|
||||
|
|
@ -458,6 +461,7 @@ dynamic_collections:
|
|||
- The Mark Gordon Company
|
||||
- The Sea Change Project
|
||||
- The Weinstein Company
|
||||
- Tim Burton Productions
|
||||
- Thunder Road
|
||||
- Titmouse
|
||||
- Tomorrow Studios
|
||||
|
|
@ -481,6 +485,7 @@ dynamic_collections:
|
|||
- Walden Media
|
||||
- Walt Disney Animation Studios
|
||||
- Walt Disney Pictures
|
||||
- Walt Disney Productions
|
||||
- Warner Animation Group
|
||||
- Warner Bros. Pictures
|
||||
- Warner Bros. Television
|
||||
|
|
|
|||
|
|
@ -1,67 +0,0 @@
|
|||
##############################################################################
|
||||
# FlixPatrol Charts Collections #
|
||||
# Created by Yozora, Bullmoose20, anon_fawkes, & Sohjiro #
|
||||
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
|
||||
# https://metamanager.wiki/en/latest/defaults/chart/flixpatrol.html #
|
||||
##############################################################################
|
||||
|
||||
external_templates:
|
||||
pmm: templates
|
||||
template_variables:
|
||||
collection_section: "020"
|
||||
pre: "_#"
|
||||
|
||||
templates:
|
||||
flixpatrol:
|
||||
default:
|
||||
location: world
|
||||
location_<<key>>: <<location>>
|
||||
time_window: last_week
|
||||
time_window_<<key>>: <<time_window>>
|
||||
limit: 10
|
||||
limit_<<key>>: <<limit>>
|
||||
conditionals:
|
||||
actual_location:
|
||||
default: <<location_<<key>>>>
|
||||
conditions:
|
||||
- key: apple
|
||||
value: world
|
||||
limit: <<limit>>
|
||||
flixpatrol_top:
|
||||
platform: <<platform>>
|
||||
location: <<actual_location>>
|
||||
time_window: <<time_window_<<key>>>>
|
||||
limit: <<limit_<<key>>>>
|
||||
|
||||
dynamic_collections:
|
||||
FlixPatrol:
|
||||
type: custom
|
||||
data:
|
||||
netflix: Netflix
|
||||
disney: Disney+
|
||||
max: Max
|
||||
hulu: Hulu
|
||||
paramount: Paramount+
|
||||
prime: Prime Video
|
||||
apple: Apple TV+
|
||||
title_format: <<key_name>> Top <<limit>>
|
||||
template:
|
||||
- flixpatrol
|
||||
- shared
|
||||
- arr
|
||||
- custom
|
||||
template_variables:
|
||||
limit:
|
||||
default: 10
|
||||
platform:
|
||||
default: <<key>>
|
||||
max: hbo
|
||||
paramount: paramount_plus
|
||||
prime: amazon_prime
|
||||
apple: apple_tv
|
||||
image:
|
||||
default: chart/<<key>>_top
|
||||
translation_key:
|
||||
default: flixpatrol
|
||||
dynamic:
|
||||
default: true
|
||||
|
|
@ -1,104 +0,0 @@
|
|||
##############################################################################
|
||||
# FlixPatrol Overlays #
|
||||
# Created by Yozora, Bullmoose20, anon_fawkes, & Sohjiro #
|
||||
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
|
||||
# https://metamanager.wiki/en/latest/defaults/overlays/flixpatrol.html #
|
||||
##############################################################################
|
||||
|
||||
external_templates:
|
||||
pmm: templates
|
||||
template_variables:
|
||||
default:
|
||||
pre_text: TOP
|
||||
style: round
|
||||
limit: 10
|
||||
limit_<<key>>: <<limit>>
|
||||
conditionals:
|
||||
pmm:
|
||||
conditions:
|
||||
- file.exists: false
|
||||
file_<<key>>.exists: false
|
||||
url.exists: false
|
||||
url_<<key>>.exists: false
|
||||
git.exists: false
|
||||
git_<<key>>.exists: false
|
||||
repo.exists: false
|
||||
repo_<<key>>.exists: false
|
||||
value: logo/<<style>>/<<key>>
|
||||
queue: position
|
||||
back_color: "#00000099"
|
||||
back_width: 160
|
||||
back_height: 160
|
||||
font_size: 50
|
||||
addon_position: top
|
||||
addon_offset: 30
|
||||
back_padding: 15
|
||||
final_name: text(<<pre_text>><<limit_<<key>>>>)
|
||||
|
||||
queues:
|
||||
position:
|
||||
default:
|
||||
horizontal_offset: 30
|
||||
vertical_offset: 465
|
||||
vertical_align: top
|
||||
right:
|
||||
- horizontal_align: right
|
||||
- vertical_offset: 670
|
||||
- vertical_offset: 875
|
||||
left:
|
||||
- horizontal_align: left
|
||||
- vertical_offset: 670
|
||||
- vertical_offset: 875
|
||||
|
||||
templates:
|
||||
flixpatrol:
|
||||
default:
|
||||
slug: <<key>>
|
||||
time_window: last_week
|
||||
time_window_<<key>>: <<time_window>>
|
||||
location: world
|
||||
location_<<key>>: <<location>>
|
||||
limit: 10
|
||||
limit_<<key>>: <<limit>>
|
||||
conditionals:
|
||||
actual_location:
|
||||
default: <<location_<<key>>>>
|
||||
conditions:
|
||||
- key: apple
|
||||
value: world
|
||||
ignore_blank_results: true
|
||||
flixpatrol_top:
|
||||
platform: <<slug>>
|
||||
location: <<actual_location>>
|
||||
time_window: <<time_window_<<key>>>>
|
||||
limit: <<limit_<<key>>>>
|
||||
|
||||
overlays:
|
||||
|
||||
Netflix:
|
||||
variables: {key: netflix, weight: 60}
|
||||
template: [name: standard, name: flixpatrol]
|
||||
|
||||
Disney:
|
||||
variables: {key: disney, weight: 50}
|
||||
template: [name: standard, name: flixpatrol]
|
||||
|
||||
Max:
|
||||
variables: {key: max, weight: 40, slug: hbo}
|
||||
template: [name: standard, name: flixpatrol]
|
||||
|
||||
Hulu:
|
||||
variables: {key: hulu, weight: 30}
|
||||
template: [name: standard, name: flixpatrol]
|
||||
|
||||
Paramount:
|
||||
variables: {key: paramount, weight: 20, slug: paramount_plus}
|
||||
template: [name: standard, name: flixpatrol]
|
||||
|
||||
Prime:
|
||||
variables: {key: prime, weight: 10, slug: amazon_prime}
|
||||
template: [name: standard, name: flixpatrol]
|
||||
|
||||
Apple:
|
||||
variables: {key: apple, weight: 9, slug: apple_tv}
|
||||
template: [name: standard, name: flixpatrol]
|
||||
BIN
defaults/overlays/images/network/AMC+.png
Normal file
BIN
defaults/overlays/images/network/AMC+.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
BIN
defaults/overlays/images/network/ITV2.png
Normal file
BIN
defaults/overlays/images/network/ITV2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
BIN
defaults/overlays/images/network/ITV3.png
Normal file
BIN
defaults/overlays/images/network/ITV3.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
BIN
defaults/overlays/images/network/ITV4.png
Normal file
BIN
defaults/overlays/images/network/ITV4.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
BIN
defaults/overlays/images/network/ITVBe.png
Normal file
BIN
defaults/overlays/images/network/ITVBe.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
BIN
defaults/overlays/images/studio/bigger/Food Network.png
Normal file
BIN
defaults/overlays/images/studio/bigger/Food Network.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
BIN
defaults/overlays/images/studio/bigger/Hughes Entertainment.png
Normal file
BIN
defaults/overlays/images/studio/bigger/Hughes Entertainment.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 30 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 7.1 KiB |
BIN
defaults/overlays/images/studio/bigger/Marv Films.png
Normal file
BIN
defaults/overlays/images/studio/bigger/Marv Films.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 8.6 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 19 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 20 KiB |
BIN
defaults/overlays/images/studio/standard/Food Network.png
Normal file
BIN
defaults/overlays/images/studio/standard/Food Network.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.7 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 5.9 KiB |
BIN
defaults/overlays/images/studio/standard/Marv Films.png
Normal file
BIN
defaults/overlays/images/studio/standard/Marv Films.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 7 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
|
|
@ -11,18 +11,11 @@ external_templates:
|
|||
run_definition:
|
||||
- <<use_<<key>>>>
|
||||
- <<use_<<alt>>>>
|
||||
- <<allowed_libraries>>
|
||||
default:
|
||||
key: <<overlay_name>>
|
||||
standard_value: 305
|
||||
horizontal_align: left
|
||||
vertical_align: bottom
|
||||
conditionals:
|
||||
back_height:
|
||||
default: 105
|
||||
conditions:
|
||||
- style: standard
|
||||
value: <<standard_value>>
|
||||
vertical_offset:
|
||||
default: 15
|
||||
conditions:
|
||||
|
|
@ -54,9 +47,10 @@ external_templates:
|
|||
value: network/<<key>>
|
||||
allowed_libraries: show
|
||||
group: networks
|
||||
vertical_offset: 15
|
||||
back_color: "#00000099"
|
||||
back_radius: 30
|
||||
back_width: 305
|
||||
back_height: 105
|
||||
|
||||
templates:
|
||||
networks:
|
||||
|
|
@ -122,6 +116,10 @@ overlays:
|
|||
variables: { weight: 10}
|
||||
template: [name: standard, {name: networks, search: [AMC, AMC.com]}]
|
||||
|
||||
AMC+:
|
||||
variables: { weight: 10}
|
||||
template: [name: standard, name: networks]
|
||||
|
||||
Animal Planet:
|
||||
variables: { weight: 10}
|
||||
template: [name: standard, {name: networks, search: [Animal Planet, Animal Planet Brasil, Animal Planet Deutschland]}]
|
||||
|
|
@ -506,6 +504,22 @@ overlays:
|
|||
variables: { weight: 10}
|
||||
template: [name: standard, name: networks]
|
||||
|
||||
ITV2:
|
||||
variables: { weight: 10}
|
||||
template: [name: standard, name: networks]
|
||||
|
||||
ITV3:
|
||||
variables: { weight: 10}
|
||||
template: [name: standard, name: networks]
|
||||
|
||||
ITV4:
|
||||
variables: { weight: 10}
|
||||
template: [name: standard, name: networks]
|
||||
|
||||
ITVBe:
|
||||
variables: { weight: 10}
|
||||
template: [name: standard, name: networks]
|
||||
|
||||
ITVX:
|
||||
variables: { weight: 10}
|
||||
template: [name: standard, name: networks]
|
||||
|
|
|
|||
|
|
@ -882,6 +882,9 @@ overlays:
|
|||
Focus Features:
|
||||
template: [name: standard, name: studios]
|
||||
|
||||
Food Network:
|
||||
template: [name: standard, name: studios]
|
||||
|
||||
Fortiche Production:
|
||||
template: [name: standard, name: studios]
|
||||
|
||||
|
|
@ -939,10 +942,13 @@ overlays:
|
|||
Hasbro:
|
||||
template: [name: standard, name: studios]
|
||||
|
||||
HBO:
|
||||
template: [name: standard, name: studios]
|
||||
|
||||
Heyday Films:
|
||||
template: [name: standard, name: studios]
|
||||
|
||||
HBO:
|
||||
Hughes Entertainment:
|
||||
template: [name: standard, name: studios]
|
||||
|
||||
Hurwitz & Schlossberg Productions:
|
||||
|
|
@ -1017,6 +1023,9 @@ overlays:
|
|||
Levity Entertainment Group:
|
||||
template: [name: standard, name: studios]
|
||||
|
||||
Lightstorm Entertainment:
|
||||
template: [name: standard, name: studios]
|
||||
|
||||
Likely Story:
|
||||
template: [name: standard, name: studios]
|
||||
|
||||
|
|
@ -1047,7 +1056,7 @@ overlays:
|
|||
Mandarin Motion Pictures Limited:
|
||||
template: [name: standard, name: studios]
|
||||
|
||||
marv:
|
||||
Marv Films:
|
||||
template: [name: standard, name: studios]
|
||||
|
||||
Marvel Animation:
|
||||
|
|
@ -1317,6 +1326,9 @@ overlays:
|
|||
The Weinstein Company:
|
||||
template: [name: standard, name: studios]
|
||||
|
||||
Tim Burton Productions:
|
||||
template: [name: standard, name: studios]
|
||||
|
||||
Thunder Road:
|
||||
template: [name: standard, name: studios]
|
||||
|
||||
|
|
@ -1386,6 +1398,9 @@ overlays:
|
|||
Walt Disney Pictures:
|
||||
template: [name: standard, {name: studios, search: [Disney, Walt Disney Pictures]}]
|
||||
|
||||
Walt Disney Productions:
|
||||
template: [name: standard, name: studios]
|
||||
|
||||
Warner Animation Group:
|
||||
template: [name: standard, {name: studios, search: [Warner Animation Group, Warner Bros. Cartoon Studios, Warner Animation]}]
|
||||
|
||||
|
|
|
|||
|
|
@ -50,6 +50,7 @@ dynamic_collections:
|
|||
- ALTBalaji
|
||||
- Amazon Kids+
|
||||
- AMC
|
||||
- AMC+
|
||||
- Animal Planet
|
||||
- Antena 3
|
||||
- Apple TV+
|
||||
|
|
@ -148,6 +149,10 @@ dynamic_collections:
|
|||
- ITV
|
||||
- ITV Encore
|
||||
- ITV1
|
||||
- ITV2
|
||||
- ITV3
|
||||
- ITV4
|
||||
- ITVBe
|
||||
- ITVX
|
||||
- joyn
|
||||
- Kan 11
|
||||
|
|
|
|||
|
|
@ -243,7 +243,6 @@ html_theme_options = {
|
|||
("IMDb Charts", "defaults/chart/imdb"),
|
||||
("TMDb Charts", "defaults/chart/tmdb"),
|
||||
("Trakt Charts", "defaults/chart/trakt"),
|
||||
("Flixpatrol Charts", "defaults/chart/flixpatrol"),
|
||||
("AniList Charts", "defaults/chart/anilist"),
|
||||
("MyAnimeList Charts", "defaults/chart/myanimelist"),
|
||||
("Other Charts", "defaults/chart/other"),
|
||||
|
|
@ -303,7 +302,6 @@ html_theme_options = {
|
|||
("Shared Variables", "defaults/overlay_variables"),
|
||||
("_divider", ),
|
||||
("_menu", "Chart", "defaults/overlays", "#chart-overlays", [
|
||||
("FlixPatrol Top", "defaults/overlays/flixpatrol"),
|
||||
("Ribbon", "defaults/overlays/ribbon"),
|
||||
]),
|
||||
("_menu", "Content", "defaults/overlays", "#content-overlays", [
|
||||
|
|
@ -465,12 +463,6 @@ html_theme_options = {
|
|||
("_menu", "ICheckMovies Builders", "metadata/builders/icheckmovies", [
|
||||
("ICheckMovies List", "metadata/builders/icheckmovies", "#icheckmovies-list"),
|
||||
]),
|
||||
("_menu", "FlixPatrol Builders", "metadata/builders/flixpatrol", [
|
||||
("FlixPatrol Top Platform", "metadata/builders/flixpatrol", "#flixpatrol-top"),
|
||||
("FlixPatrol Popular", "metadata/builders/flixpatrol", "#flixpatrol-popular"),
|
||||
("FlixPatrol Demographics", "metadata/builders/flixpatrol", "#flixpatrol-demographics"),
|
||||
("FlixPatrol URL", "metadata/builders/flixpatrol", "#flixpatrol-url"),
|
||||
]),
|
||||
("_menu", "Reciperr Builders", "metadata/builders/reciperr", [
|
||||
("Reciperr List", "metadata/builders/reciperr", "#reciperr-list"),
|
||||
]),
|
||||
|
|
|
|||
|
|
@ -62,7 +62,7 @@ Deletes collections based on a set of given attributes. The Collection must matc
|
|||
|:-------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `managed` | **Values:**<br>`true`: Collection must be a Managed Collection to be deleted (the collection has the `PMM` label)<br>`false`: Collection must be an Unmanaged Collection to be deleted (the collection does not have the `PMM` label) |
|
||||
| `configured` | **Values:**<br>`true`: Collection must be a Configured Collection to be deleted (collection is in the config file of the specific PMM run)<br>`false`: Collection must be an Unconfigured Collection to be deleted (collection is not in the config file of the specific PMM run).<br>**The collection does not need to be scheduled to be considered configured and only needs to be in the config file.** |
|
||||
| `less` | Collection must contain less then the given number of items to be deleted.<br>**Values:** Number Greater then 0 |
|
||||
| `less` | Collection must contain less then the given number of items to be deleted.<br>**Values:** Number Greater than 0 |
|
||||
|
||||
**Example:**
|
||||
|
||||
|
|
@ -240,8 +240,6 @@ Updates every item's episode's audience/critic/user rating in the library to the
|
|||
|
||||
Updates every item's poster to the chosen sites poster. Will fallback to `plex` if the given option fails. Assets will be used over anything else.
|
||||
|
||||
IMPORTANT NOTE: This does not affect the icons displayed in the Plex UI. This will place the number of your choice in the relevant field in the Plex database. In other words, if Plex is configured to use Rotten Tomatoes ratings, then no matter what happens with this mass rating update operation, the icons in the Plex UI will remain Rotten Tomatoes. The human who decided to put TMDB ratings in the critic slot and Letterboxd ratings in the audience slot is the only party who knows that the ratings are no longer Rotten Tomatoes. One primary use of this feature is to put ratings overlays on posters. More information on what PMM can do with these ratings can be found [here](../home/guides/ratings).
|
||||
|
||||
**Attribute:** `mass_poster_update`
|
||||
|
||||
**Values:** There are a few different options to determine how the `mass_poster_update` works.
|
||||
|
|
|
|||
|
|
@ -43,8 +43,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
| Variable | Description & Values |
|
||||
|:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `style` | **Description:** Controls the visual theme of the collections created.<br>**Default:** `bw`<br>**Values:** `bw`, `rainier`, `signature`, `diiivoy`, or `diiivoycolor` |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>depth</code></td><td>Controls the depth within the casting credits to search for common actors<hr><strong>Default:</strong> 5<hr><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create<hr><strong>Default:</strong> 25<hr><strong>Values:</strong> Number greater than 0</td></tr></table> |
|
||||
|
|
|
|||
|
|
@ -48,8 +48,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
|
||||
| Variable | Description & Values |
|
||||
|:--------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
|
|
|
|||
|
|
@ -42,8 +42,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include)<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)<br>**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) |
|
||||
|
|
|
|||
|
|
@ -44,8 +44,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
|
||||
| Variable | Description & Values |
|
||||
|:--------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
|
|
|
|||
|
|
@ -46,8 +46,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** List of Content Ratings found in your library |
|
||||
|
|
|
|||
|
|
@ -46,8 +46,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** List of Content Ratings found in your library |
|
||||
|
|
|
|||
|
|
@ -46,8 +46,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** List of Content Ratings found in your library |
|
||||
|
|
|
|||
|
|
@ -43,8 +43,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `exclude` | **Description:** Exclude these Genres from creating a Dynamic Collection.<br>**Values:** List of Genres found in your library |
|
||||
|
|
|
|||
|
|
@ -50,8 +50,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
| Variable | Description & Values |
|
||||
|:------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `style` | **Description:** Controls the visual theme of the collections created.<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>default</code></td><td>Default Theme</td></tr><tr><td><code>standards</code></td><td>Standards Theme</td></tr></table> |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** Any Resolutions found in your library |
|
||||
|
|
|
|||
|
|
@ -57,8 +57,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
|
||||
| Variable | Description & Values |
|
||||
|:--------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
|
|
|
|||
|
|
@ -43,8 +43,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** List of Studios found in your library |
|
||||
|
|
@ -358,6 +358,7 @@ include:
|
|||
- FilmNation Entertainment
|
||||
- Flynn Picture Company
|
||||
- Focus Features
|
||||
- Food Network
|
||||
- Fortiche Production
|
||||
- Fox Television Studios
|
||||
- Freckle Films
|
||||
|
|
@ -377,8 +378,9 @@ include:
|
|||
- HartBeat Productions
|
||||
- Hartswood Films
|
||||
- Hasbro
|
||||
- Heyday Films
|
||||
- HBO
|
||||
- Heyday Films
|
||||
- Hughes Entertainment
|
||||
- Hurwitz & Schlossberg Productions
|
||||
- Hyperobject Industries
|
||||
- Icon Entertainment International
|
||||
|
|
@ -403,6 +405,7 @@ include:
|
|||
- Legendary Pictures
|
||||
- Let's Not Turn This Into a Whole Big Production
|
||||
- Levity Entertainment Group
|
||||
- Lightstorm Entertainment
|
||||
- Likely Story
|
||||
- Lionsgate
|
||||
- Live Entertainment
|
||||
|
|
@ -413,7 +416,7 @@ include:
|
|||
- Mandalay Entertainment
|
||||
- Mandarin
|
||||
- Mandarin Motion Pictures Limited
|
||||
- marv
|
||||
- Marv Films
|
||||
- Marvel Animation
|
||||
- Marvel Studios
|
||||
- Matt Tolmach Productions
|
||||
|
|
@ -503,6 +506,7 @@ include:
|
|||
- The Mark Gordon Company
|
||||
- The Sea Change Project
|
||||
- The Weinstein Company
|
||||
- Tim Burton Productions
|
||||
- Thunder Road
|
||||
- Titmouse
|
||||
- Tomorrow Studios
|
||||
|
|
@ -526,6 +530,7 @@ include:
|
|||
- Walden Media
|
||||
- Walt Disney Animation Studios
|
||||
- Walt Disney Pictures
|
||||
- Walt Disney Productions
|
||||
- Warner Animation Group
|
||||
- Warner Bros. Pictures
|
||||
- Warner Bros. Television
|
||||
|
|
|
|||
|
|
@ -42,8 +42,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include)<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)<br>**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) |
|
||||
|
|
|
|||
|
|
@ -41,8 +41,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `10`<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `10`<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<hr><strong>Default:</strong> current_year-10<hr><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<hr><strong>Default:</strong> current_year<hr><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<hr><strong>Default:</strong> 1<hr><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>current_year</code></strong></li><li><strong>You can also use a value relative to the <code>current_year</code> by doing <code>current_year-5</code></strong></li></ul> |
|
||||
|
|
|
|||
|
|
@ -41,8 +41,8 @@ All [Shared Collection Variables](../collection_variables) are available as well
|
|||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the number of items in a collection for all collections in a Defaults file.<br>**Default:** `100`<br>**Values:** Number greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the number of items in a collection of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number greater then 0 |
|
||||
| `limit` | **Description:** Changes the number of items in a collection for all collections in a Defaults file.<br>**Default:** `100`<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the number of items in a collection of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
|
|
|
|||
|
|
@ -39,11 +39,11 @@ All [Shared Collection Variables](../collection_variables) are available as well
|
|||
|
||||
| Variable | Description & Values |
|
||||
|:----------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Smart Filter Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Smart Filter Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `in_the_last_<<key>>`<sup>1</sup> | **Description:** Changes how far back the Smart Filter looks.<table class="clearTable"><tr><td>**Default:**</td></tr><tr><td>`released`</td><td>`90`</td></tr><tr><td>`episodes`</td><td>`7`</td></tr></table>**Values:** Number Greater then 0 |
|
||||
| `in_the_last_<<key>>`<sup>1</sup> | **Description:** Changes how far back the Smart Filter looks.<table class="clearTable"><tr><td>**Default:**</td></tr><tr><td>`released`</td><td>`90`</td></tr><tr><td>`episodes`</td><td>`7`</td></tr></table>**Values:** Number Greater than 0 |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,70 +0,0 @@
|
|||
# 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:
|
||||
|
||||
```yaml
|
||||
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](../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.<br>**Default:** `10`<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `location` | **Description:** Changes the Builder Location for all collections in a Defaults file.<br>**Default:** `world`<br>**Values:** [`location` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) |
|
||||
| `location_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Location of the specified key's collection.<br>**Default:** `location`<br>**Values:** [`location` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) |
|
||||
| `time_window` | **Description:** Changes the Builder Time Window for all collections in a Defaults file.<br>**Default:** `last_week`<br>**Values:** [`time_window` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) |
|
||||
| `time_window_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Time Window of the specified key's collection.<br>**Default:** `time_window`<br>**Values:** [`time_window` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
|
||||
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.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: flixpatrol
|
||||
template_variables:
|
||||
location: united_states
|
||||
time_window: last_month
|
||||
```
|
||||
|
|
@ -42,8 +42,8 @@ All [Shared Collection Variables](../collection_variables) are available as well
|
|||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `100`<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `100`<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ All [Shared Collection Variables](../collection_variables) are available as well
|
|||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit_anidb` | **Description:** Changes the Builder Limit of the AniDB Popular Collection.<br>**Default:** `30`<br>**Values:** Number Greater then 0 |
|
||||
| `limit_anidb` | **Description:** Changes the Builder Limit of the AniDB Popular Collection.<br>**Default:** `30`<br>**Values:** Number Greater than 0 |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
|
|
|
|||
|
|
@ -41,10 +41,10 @@ All [Shared Collection Variables](../collection_variables) are available as well
|
|||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `list_days` | **Description:** Changes the `list_days` attribute of the builder for all collections in a Defaults file.<br>**Values:** Number greater then 0 |
|
||||
| `list_days_<<key>>`<sup>1</sup> | **Description:** Changes the `list_days` attribute of the builder of the specified key's collection.<br>**Values:** Number greater then 0 |
|
||||
| `list_size` | **Description:** Changes the `list_size` attribute of the builder for all collections in a Defaults file.<br>**Values:** Number greater then 0 |
|
||||
| `list_size_<<key>>`<sup>1</sup> | **Description:** Changes the `list_size` attribute of the builder of the specified key's collection.<br>**Values:** Number greater then 0 |
|
||||
| `list_days` | **Description:** Changes the `list_days` attribute of the builder for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
| `list_days_<<key>>`<sup>1</sup> | **Description:** Changes the `list_days` attribute of the builder of the specified key's collection.<br>**Values:** Number Greater than 0 |
|
||||
| `list_size` | **Description:** Changes the `list_size` attribute of the builder for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
| `list_size_<<key>>`<sup>1</sup> | **Description:** Changes the `list_size` attribute of the builder of the specified key's collection.<br>**Values:** Number Greater than 0 |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
|
|
|
|||
|
|
@ -44,8 +44,8 @@ All [Shared Collection Variables](../collection_variables) are available as well
|
|||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `100`<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `100`<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
|
|
|
|||
|
|
@ -44,8 +44,8 @@ All [Shared Collection Variables](../collection_variables) are available as well
|
|||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `100`<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `100`<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
|
|
|
|||
|
|
@ -31,7 +31,6 @@ These collections are applied by calling the below paths into the `metadata_path
|
|||
| [IMDb Charts](chart/imdb) | `imdb` | IMDb Popular, IMDb Top 250 | ✅ | ✅ |
|
||||
| [TMDb Charts](chart/tmdb) | `tmdb` | TMDb Popular, TMDb Airing Today | ✅ | ✅ |
|
||||
| [Trakt Charts](chart/trakt) | `trakt` | Trakt Popular, Trakt Trending | ✅<sup>1</sup> | ✅<sup>1</sup> |
|
||||
| [FlixPatrol Charts](chart/flixpatrol) | `flixpatrol` | Top Disney, Top Max, Top Hulu, Top Netflix | ✅ | ✅ |
|
||||
| [AniList Charts](chart/anilist) | `anilist` | AniList Popular, AniList Season | ✅ | ✅ |
|
||||
| [MyAnimeList Charts](chart/myanimelist) | `myanimelist` | MyAnimeList Popular, MyAnimeList Top Rated | ✅ | ✅ |
|
||||
| [Other Charts](chart/other) | `other_chart` | AniDB Popular, Common Sense Selection | ✅ | ✅ |
|
||||
|
|
|
|||
|
|
@ -22,8 +22,8 @@ Below are the available variables which can be used to customize the file.
|
|||
| `collection_mode` | **Description:** Controls the collection mode of all collections in a Defaults file.<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`hide`</td><td>Hide Collection</td></tr><tr><td>`hide_items`</td><td>Hide Items in this Collection</td></tr><tr><td>`show_items`</td><td>Show this Collection and its Items</td></tr></table> |
|
||||
| `ignore_ids` | **Description:** Set a list or comma-separated string of TMDb/TVDb IDs to ignore in all collections.<br>**Values:** List or comma-separated string of TMDb/TVDb IDs |
|
||||
| `ignore_imdb_ids` | **Description:** Set a list or comma-separated string of IMDb IDs to ignore in all collections.<br>**Values:** List or comma-separated string of IMDb IDs |
|
||||
| `minimum_items` | **Description:** Set the number of minimum items for a collection to be created for all collections.<br>**Values:** Any Number greater then 0 |
|
||||
| `minimum_items_<<key>>`<sup>1</sup> | **Description:** Set the number of minimum items for a collection to be created for the specified key's collection.<br>**Values:** Any Number greater then 0 |
|
||||
| `minimum_items` | **Description:** Set the number of minimum items for a collection to be created for all collections.<br>**Values:** Any number greater than 0 |
|
||||
| `minimum_items_<<key>>`<sup>1</sup> | **Description:** Set the number of minimum items for a collection to be created for the specified key's collection.<br>**Values:** Any number greater than 0 |
|
||||
| `delete_collections_named` | **Description:** Used to delete any collections in your plex named one of the given collections.<br>**Values:** List of Collection Names to delete |
|
||||
| `url_poster` | **Description:** Changes the poster url for all collections.<br>**Values:** URL directly to the Image |
|
||||
| `url_poster_<<key>>`<sup>1</sup> | **Description:** Changes the poster url of the specified key's collection.<br>**Values:** URL directly to the Image |
|
||||
|
|
|
|||
|
|
@ -60,7 +60,6 @@ This is the default PMM collection ordering:
|
|||
| `basic` | `010` |
|
||||
| `anilist` | `020` |
|
||||
| `imdb` | `020` |
|
||||
| `flixpatrol` | `020` |
|
||||
| `myanimelist` | `020` |
|
||||
| `other_chart` | `020` |
|
||||
| `tautulli` | `020` |
|
||||
|
|
|
|||
|
|
@ -45,8 +45,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** List of Content Ratings found in your library |
|
||||
|
|
|
|||
|
|
@ -48,8 +48,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
| Variable | Description & Values |
|
||||
|:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `style` | **Description:** Controls the visual theme of the collections created<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>white</code></td><td>White Theme</td></tr><tr><td><code>color</code></td><td>Color Theme</td></tr></table> |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** List of Countries found in your library |
|
||||
|
|
|
|||
|
|
@ -48,8 +48,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
| Variable | Description & Values |
|
||||
|:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `style` | **Description:** Controls the visual theme of the collections created<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>white</code></td><td>White Theme</td></tr><tr><td><code>color</code></td><td>Color Theme</td></tr></table> |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** List of Countries found in your library |
|
||||
|
|
|
|||
|
|
@ -40,8 +40,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `100`<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `100`<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `critic_rating.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `exclude` | **Description:** Exclude these Decades from creating a Dynamic Collection.<br>**Values:** List of Decades found in your library |
|
||||
|
|
|
|||
|
|
@ -40,8 +40,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
| Variable | Description & Values |
|
||||
|:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `style` | **Description:** Controls the visual theme of the collections created.<br>**Default:** `bw`<br>**Values:** `bw`, `rainier`, `signature`, `diiivoy`, or `diiivoycolor` |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>depth</code></td><td>Controls the depth within the casting credits to search for common actors<hr><strong>Default:</strong> 5<hr><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create<hr><strong>Default:</strong> 25<hr><strong>Values:</strong> Number greater than 0</td></tr></table> |
|
||||
|
|
|
|||
|
|
@ -40,8 +40,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
| Variable | Description & Values |
|
||||
|:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `style` | **Description:** Controls the visual theme of the collections created.<br>**Default:** `bw`<br>**Values:** `bw`, `rainier`, `signature`, `diiivoy`, or `diiivoycolor` |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>depth</code></td><td>Controls the depth within the casting credits to search for common actors<hr><strong>Default:</strong> 5<hr><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create<hr><strong>Default:</strong> 25<hr><strong>Values:</strong> Number greater than 0</td></tr></table> |
|
||||
|
|
|
|||
|
|
@ -48,8 +48,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
| Variable | Description & Values |
|
||||
|:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `style` | **Description:** Controls the visual theme of the collections created<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>white</code></td><td>White Theme</td></tr><tr><td><code>color</code></td><td>Color Theme</td></tr></table> |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** List of Countries found in your library |
|
||||
|
|
|
|||
|
|
@ -63,8 +63,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
| `mdblist_list_<<key>>`<sup>1</sup> | **Description:** Adds the Movies in the MDb List to the specified key's collection.<br>**Values:** List of MDbList URLs | | | |
|
||||
| `emoji` | **Description:** Controls the Emoji Prefix for all Collections. Set to `""` to remove all emojis.<br>**Values:** Any String |
|
||||
| `emoji_<<key>>`<sup>1</sup> | **Description:** Controls the Emoji Prefix for the specified key's collection.<br>**Values:** Any String |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in this file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in this file.<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in this file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
|
|
|
|||
|
|
@ -40,8 +40,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
| Variable | Description & Values |
|
||||
|:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `style` | **Description:** Controls the visual theme of the collections created.<br>**Default:** `bw`<br>**Values:** `bw`, `rainier`, `signature`, `diiivoy`, or `diiivoycolor` |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>depth</code></td><td>Controls the depth within the casting credits to search for common actors<hr><strong>Default:</strong> 5<hr><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create<hr><strong>Default:</strong> 25<hr><strong>Values:</strong> Number greater than 0</td></tr></table> |
|
||||
|
|
|
|||
|
|
@ -12,7 +12,6 @@ These overlays are applied by calling the below paths into the `overlay_path` [s
|
|||
|
||||
| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
|
||||
|:----------------------------------|:-------------|:-----------------------------------------|:--------:|:-------:|:--------:|:--------:|
|
||||
| [FlixPatrol](overlays/flixpatrol) | `flixpatrol` | "Streaming service logo with words "TOP" | ✅ | ✅ | ❌ | ❌ |
|
||||
| [Ribbon](overlays/ribbon) | `ribbon` | IMDb Top 250 Ribbon, RT Fresh Ribbon | ✅ | ✅ | ❌ | ❌ |
|
||||
|
||||
### Content Overlays
|
||||
|
|
|
|||
|
|
@ -24,12 +24,12 @@ Below are the available variables which can be used to customize the file.
|
|||
| `vertical_offset` | **Description:** Controls the Vertical Offset of this overlay. Can be a %.<br>**Values:** Number 0 or greater or 0%-100% |
|
||||
| `vertical_align` | **Description:** Controls the Vertical Alignment of the overlay.<br>**Values:** `top`, `center`, or `bottom` |
|
||||
| `back_color` | **Description:** Controls the Backdrop Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA`<br>`AA` is transparency; 00 [transparent] to FF [opaque]|
|
||||
| `back_width` | **Description:** Controls the Backdrop Width for the Text Overlay. If `back_width` is not specified the Backdrop Sizes to the text<br>**Values:** Any Number greater then 0 |
|
||||
| `back_height` | **Description:** Controls the Backdrop Height for the Text Overlay. If `back_height` is not specified the Backdrop Sizes to the text<br>**Values:** Any Number greater then 0 |
|
||||
| `back_width` | **Description:** Controls the Backdrop Width for the Text Overlay. If `back_width` is not specified the Backdrop Sizes to the text<br>**Values:** Any number greater than 0 |
|
||||
| `back_height` | **Description:** Controls the Backdrop Height for the Text Overlay. If `back_height` is not specified the Backdrop Sizes to the text<br>**Values:** Any number greater than 0 |
|
||||
| `back_align` | **Description:** Controls the Alignment for the Text Overlay inside the backdrop. If `back_align` is not specified the Backdrop Centers the text.<br>**Values:** `left`, `right`, `center`, `top`, or `bottom` |
|
||||
| `back_padding` | **Description:** Controls the Backdrop Padding for the Text Overlay.<br>**Values:** Any Number greater then 0 |
|
||||
| `back_radius` | **Description:** Controls the Backdrop Radius for the Text Overlay.<br>**Values:** Any Number greater then 0 |
|
||||
| `back_padding` | **Description:** Controls the Backdrop Padding for the Text Overlay.<br>**Values:** Any number greater than 0 |
|
||||
| `back_radius` | **Description:** Controls the Backdrop Radius for the Text Overlay.<br>**Values:** Any number greater than 0 |
|
||||
| `back_line_color` | **Description:** Controls the Backdrop Line Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA``AA` is transparency; 00 [transparent] to FF [opaque]|
|
||||
| `back_line_width` | **Description:** Controls the Backdrop Line Width for the Text Overlay.<br>**Values:** Any Number greater then 0 |
|
||||
| `back_line_width` | **Description:** Controls the Backdrop Line Width for the Text Overlay.<br>**Values:** Any number greater than 0 |
|
||||
|
||||
1. Each default overlay has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
|
|
|
|||
|
|
@ -66,9 +66,9 @@ All [Shared Overlay Variables](../overlay_variables) are available with the defa
|
|||
| `weight_<<key>>`<sup>1</sup> | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number |
|
||||
| `font` | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
|
||||
| `font_style` | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `50`<br>**Values:** Any Number greater then 0 |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `50`<br>**Values:** Any number greater than 0 |
|
||||
| `font_color` | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any Number greater then 0 |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any number greater than 0 |
|
||||
| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
|
||||
1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` with when calling.
|
||||
|
|
|
|||
|
|
@ -77,11 +77,11 @@ All [Shared Overlay Variables](../overlay_variables) are available with the defa
|
|||
|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `font` | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
|
||||
| `font_style` | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `55`<br>**Values:** Any Number greater then 0 |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `55`<br>**Values:** Any number greater than 0 |
|
||||
| `font_color` | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any Number greater then 0 |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any number greater than 0 |
|
||||
| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any Number greater then 0 |
|
||||
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 |
|
||||
| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` |
|
||||
| `pre_text` | **Description:** Choose the text before the key for the Overlay.<br>**Values:** Any String |
|
||||
| `post_text` | **Description:** Choose the text after the key for the Overlay.<br>**Default:** `+`<br>**Values:** Any String |
|
||||
|
|
|
|||
|
|
@ -68,11 +68,11 @@ All [Shared Overlay Variables](../overlay_variables) are available with the defa
|
|||
| `back_height` | **Description:** Choose the back height for the overlay lozenge.<br>**Default:**`105` |
|
||||
| `font` | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
|
||||
| `font_style` | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `55`<br>**Values:** Any Number greater then 0 |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `55`<br>**Values:** Any number greater than 0 |
|
||||
| `font_color` | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any Number greater then 0 |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any number greater than 0 |
|
||||
| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any Number greater then 0 |
|
||||
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 |
|
||||
| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` |
|
||||
| `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` |
|
||||
|
||||
|
|
|
|||
|
|
@ -57,11 +57,11 @@ All [Shared Overlay Variables](../overlay_variables) are available with the defa
|
|||
| `back_height` | **Description:** Choose the back height for the overlay lozenge.<br>**Default:**`105` |
|
||||
| `font` | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
|
||||
| `font_style` | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `55`<br>**Values:** Any Number greater then 0 |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `55`<br>**Values:** Any number greater than 0 |
|
||||
| `font_color` | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any Number greater then 0 |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any number greater than 0 |
|
||||
| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any Number greater then 0 |
|
||||
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 |
|
||||
| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
|
|
|||
|
|
@ -63,11 +63,11 @@ All [Shared Overlay Variables](../overlay_variables) are available with the defa
|
|||
| `back_height` | **Description:** Choose the back height for the overlay lozenge.<br>**Default:**`105` |
|
||||
| `font` | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
|
||||
| `font_style` | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `55`<br>**Values:** Any Number greater then 0 |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `55`<br>**Values:** Any number greater than 0 |
|
||||
| `font_color` | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any Number greater then 0 |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any number greater than 0 |
|
||||
| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any Number greater then 0 |
|
||||
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 |
|
||||
| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
|
|
|||
|
|
@ -42,9 +42,9 @@ All [Shared Overlay Variables](../overlay_variables) are available with the defa
|
|||
|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `font` | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
|
||||
| `font_style` | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `55`<br>**Values:** Any Number greater then 0 |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `55`<br>**Values:** Any number greater than 0 |
|
||||
| `font_color` | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any Number greater then 0 |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any number greater than 0 |
|
||||
| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
|
|
|||
|
|
@ -1,89 +0,0 @@
|
|||
# FlixPatrol Top Overlays
|
||||
|
||||
The `flixpatrol` Default Overlay File is used to create an overlay based on the Top Lists from FlixPatrol on items within your library.
|
||||
|
||||
|
||||
|
||||
## Requirements & Recommendations
|
||||
|
||||
Supported Overlay Level: Movie, Show
|
||||
|
||||
## Supported Services
|
||||
|
||||
| Service | Key | Weight |
|
||||
|:------------|:------------|:-------|
|
||||
| Netflix | `netflix` | `60` |
|
||||
| Disney+ | `disney` | `50` |
|
||||
| MAX | `max` | `40` |
|
||||
| Hulu | `hulu` | `30` |
|
||||
| Paramount+ | `paramount` | `20` |
|
||||
| Prime Video | `prime` | `10` |
|
||||
| Apple+ | `apple` | `9` |
|
||||
|
||||
## Config
|
||||
|
||||
The below YAML in your config.yml will create the overlays:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
overlay_path:
|
||||
- pmm: flixpatrol
|
||||
TV Shows:
|
||||
overlay_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 Overlay Variables](../overlay_variables) except `horizontal_offset`, `horizontal_align`, `vertical_offset`, and `vertical_align` are available with the default values below as well as the additional Variables below which can be used to customize the file.
|
||||
|
||||
| Variable | Default |
|
||||
|:--------------------|:------------------|
|
||||
| `horizontal_offset` | `30` |
|
||||
| `horizontal_align` | `left`/`right` |
|
||||
| `vertical_offset` | `465`/`670`/`875` |
|
||||
| `vertical_align` | `top` |
|
||||
| `back_color` | `#00000099` |
|
||||
| `back_radius` | `30` |
|
||||
| `back_width` | `160` |
|
||||
| `back_height` | `160` |
|
||||
| `back_padding` | `15` |
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:----------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `position` | **Description:** Changes the position of the Overlays.<br>**Default:** `right`<br>**Values:** `right`, `left`, or List of Coordinates |
|
||||
| `style` | **Description:** Changes the style of the Logo Image.<br>**Default:** `round`<br>**Values:** `round` or `square` |
|
||||
| `pre_text` | **Description:** Changes the text before the number.<br>**Default:** `TOP`<br>**Values:** Any String |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all overlays in a Defaults file.<br>**Default:** `10`<br>**Values:** Any Number greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's overlay.<br>**Default:** `limit`<br>**Values:** Any Number greater then 0 |
|
||||
| `location` | **Description:** Changes the Builder Location for all overlays in a Defaults file.<br>**Default:** `world`<br>**Values:** [`location` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) |
|
||||
| `location_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Location of the specified key's overlay.<br>**Default:** `location`<br>**Values:** [`location` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) |
|
||||
| `time_window` | **Description:** Changes the Builder Time Window for all overlays in a Defaults file.<br>**Default:** `last_week`<br>**Values:** [`time_window` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) |
|
||||
| `time_window_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Time Window of the specified key's overlay.<br>**Default:** `time_window`<br>**Values:** [`time_window` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) |
|
||||
| `weight_<<key>>`<sup>1</sup> | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number |
|
||||
| `font` | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
|
||||
| `font_style` | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `50`<br>**Values:** Any Number greater then 0 |
|
||||
| `font_color` | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any Number greater then 0 |
|
||||
| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `30`<br>**Values:** Any Number greater then 0 |
|
||||
| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `top`<br>**Values:** `left`, `right`, `top`, `bottom` |
|
||||
|
||||
1. Each default overlay has a `key` that when calling to effect a specific overlay 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.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
overlay_path:
|
||||
- pmm: flixpatrol
|
||||
template_variables:
|
||||
location: united_states
|
||||
```
|
||||
|
|
@ -106,11 +106,11 @@ All [Shared Overlay Variables](../overlay_variables) can be prepended with `rati
|
|||
| `maximum_rating` | **Description:** Maximum Rating to display<br>**Default:** 10.0<br>**Values:** Any Number |
|
||||
| `font`<sup>1</sup> | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Bold.ttf`<br>**Values:** Path to font file |
|
||||
| `font_style`<sup>1</sup> | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
|
||||
| `font_size`<sup>1</sup> | **Description:** Choose the font size for the Overlay.<br>**Default:** `63`<br>**Values:** Any Number greater then 0 |
|
||||
| `font_size`<sup>1</sup> | **Description:** Choose the font size for the Overlay.<br>**Default:** `63`<br>**Values:** Any number greater than 0 |
|
||||
| `font_color`<sup>1</sup> | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `stroke_width`<sup>1</sup> | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any Number greater then 0 |
|
||||
| `stroke_width`<sup>1</sup> | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any number greater than 0 |
|
||||
| `stroke_color`<sup>1</sup> | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `addon_offset`<sup>1</sup> | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any Number greater then 0 |
|
||||
| `addon_offset`<sup>1</sup> | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 |
|
||||
| `addon_position`<sup>1</sup> | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` |
|
||||
| `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `episode` |
|
||||
|
||||
|
|
|
|||
|
|
@ -49,9 +49,9 @@ All [Shared Overlay Variables](../overlay_variables) are available with the defa
|
|||
| `text` | **Description:** Choose the text for the Overlay.<br>**Default:** `Runtime: `<br>**Values:** Any String |
|
||||
| `font` | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
|
||||
| `font_style` | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `55`<br>**Values:** Any Number greater then 0 |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `55`<br>**Values:** Any number greater than 0 |
|
||||
| `font_color` | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any Number greater then 0 |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any number greater than 0 |
|
||||
| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
|
|
|||
|
|
@ -49,14 +49,14 @@ All [Shared Overlay Variables](../overlay_variables) are available with the defa
|
|||
|
||||
| Variable | Description & Values |
|
||||
|:-----------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `last` | **Description:** Episode Air Date in the last number of days for the AIRING Overlay.<br>**Default:** `14`<br>**Values:** Any Number greater then 0 |
|
||||
| `last` | **Description:** Episode Air Date in the last number of days for the AIRING Overlay.<br>**Default:** `14`<br>**Values:** Any number greater than 0 |
|
||||
| `text_<<key>>`<sup>1</sup> | **Description:** Choose the text for the Overlay.<br>**Default:** <table class="clearTable"><tr><th>Key</th><th>Default</th></tr><tr><td>`airing`</td><td>`AIRING`</td></tr><tr><td>`returning`</td><td>`RETURNING`</td></tr><tr><td>`canceled`</td><td>`CANCELED`</td></tr><tr><td>`ended`</td><td>`ENDED`</td></tr></table>**Values:** Any String |
|
||||
| `weight_<<key>>`<sup>1</sup> | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number |
|
||||
| `font` | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
|
||||
| `font_style` | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `50`<br>**Values:** Any Number greater then 0 |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `50`<br>**Values:** Any number greater than 0 |
|
||||
| `font_color` | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any Number greater then 0 |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any number greater than 0 |
|
||||
| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
|
||||
1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` with when calling.
|
||||
|
|
|
|||
|
|
@ -65,9 +65,9 @@ All [Shared Overlay Variables](../overlay_variables) are available with the defa
|
|||
| `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` |
|
||||
| `font` | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
|
||||
| `font_style` | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `55`<br>**Values:** Any Number greater then 0 |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `55`<br>**Values:** Any number greater than 0 |
|
||||
| `font_color` | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any Number greater then 0 |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any number greater than 0 |
|
||||
| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `text_<<key>>`<sup>1</sup> | **Description:** Choose the text for the Overlay.<br>**Default:** <table class="clearTable"><tr><th>Key</th><th>Default</th></tr><tr><td>`remux`</td><td>`REMUX`</td></tr><tr><td>`bluray`</td><td>`BLU-RAY`</td></tr><tr><td>`web`</td><td>`WEB`</td></tr><tr><td>`hdtv`</td><td>`HDTV`</td></tr><tr><td>`dvd`</td><td>`DVD`</td></tr><tr><td>`sdtv`</td><td>`SDTV`</td></tr></table>**Values:** Any String |
|
||||
| `weight_<<key>>`<sup>1</sup> | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number |
|
||||
|
|
|
|||
|
|
@ -43,8 +43,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** List of Content Ratings found in your library |
|
||||
|
|
|
|||
|
|
@ -48,8 +48,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
| Variable | Description & Values |
|
||||
|:--------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `style` | **Description:** Controls the visual theme of the collections created<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>white</code></td><td>White Theme</td></tr><tr><td><code>color</code></td><td>Color Theme</td></tr></table> |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
|
|
|
|||
|
|
@ -48,8 +48,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
| Variable | Description & Values |
|
||||
|:--------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `style` | **Description:** Controls the visual theme of the collections created<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>white</code></td><td>White Theme</td></tr><tr><td><code>color</code></td><td>Color Theme</td></tr></table> |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
|
|
|
|||
|
|
@ -40,8 +40,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `100`<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `100`<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `critic_rating.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `exclude` | **Description:** Exclude these Decades from creating a Dynamic Collection.<br>**Values:** List of Decades found in your library |
|
||||
|
|
|
|||
|
|
@ -38,8 +38,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `include` | **Description:** Overrides the [default include list](#default-include).<br>**Values:** List of Networks found in your library |
|
||||
|
|
@ -90,6 +90,7 @@ These are lists provided for reference to show what values will be in use if you
|
|||
- ALTBalaji
|
||||
- Amazon Kids+
|
||||
- AMC
|
||||
- AMC+
|
||||
- Animal Planet
|
||||
- Antena 3
|
||||
- Apple TV+
|
||||
|
|
@ -188,6 +189,10 @@ These are lists provided for reference to show what values will be in use if you
|
|||
- ITV
|
||||
- ITV Encore
|
||||
- ITV1
|
||||
- ITV2
|
||||
- ITV3
|
||||
- ITV4
|
||||
- ITVBe
|
||||
- ITVX
|
||||
- joyn
|
||||
- Kan 11
|
||||
|
|
|
|||
|
|
@ -48,8 +48,8 @@ This file contains a [Separator](../separators) so all [Shared Separator Variabl
|
|||
| Variable | Description & Values |
|
||||
|:--------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `style` | **Description:** Controls the visual theme of the collections created<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>white</code></td><td>White Theme</td></tr><tr><td><code>color</code></td><td>Color Theme</td></tr></table> |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
|
|
|
|||
|
|
@ -2,7 +2,106 @@
|
|||
|
||||
This is a quick walkthrough of setting up the Plex-Meta-Manager Docker container in the QNAP "Container Station" UI.
|
||||
|
||||
Steps.
|
||||
The "Container Station" UI on your QNAP may differ from these screenshots, but the concepts are the same:
|
||||
|
||||
1. Create a container based on the `meisnate12/plex-meta-manager` image.
|
||||
2. Set environment variables to control the container's behavior [optional].
|
||||
3. Point the container to the directory where your configuration files are to be stored.
|
||||
|
||||
Detailed steps:
|
||||
|
||||
````{tab} Container Station v. 3.0.5.623
|
||||
1. Open Container Station; click “Images”
|
||||
|
||||
|
||||
|
||||
1. Select “Pull” from the top-right
|
||||
|
||||
|
||||
|
||||
1. Leave Mode set to “Basic Mode”
|
||||
|
||||
For the Registry select “Docker Hub”
|
||||
|
||||
Under the "Image" section you will be typing in the name and version of the docker image you wish to pull. Type in the image you wish to use as follows:
|
||||
|
||||
```
|
||||
meisnate12/plex-meta-manager:latest
|
||||
meisnate12/plex-meta-manager:develop
|
||||
meisnate12/plex-meta-manager:nightly
|
||||
```
|
||||
|
||||
Then click Pull.
|
||||
|
||||
|
||||
|
||||
Note: You can repeat this step for each of the different versions and you’ll end up with this:
|
||||
|
||||
|
||||
|
||||
After the pull is complete the image(s) will now be available for use.
|
||||
|
||||
1. From the "Images" menu under the "Actions" column click the "play" button to bring up the “Create Container” option.
|
||||
|
||||
|
||||
|
||||
1. "Create Container" Step 1: "Select Image" – you’ve already done this so just click "Next".
|
||||
|
||||
|
||||
|
||||
1. "Create Container" Step 2: "Configure Container" - you can edit the name if you wish. From here on you’ll be working in the Advanced Settings sub-menu. Click on "Advanced Settings".
|
||||
|
||||
|
||||
|
||||
1. You can add [command-line switches](../environmental) to the "Command" field here. Do not edit the "Entrypoint" field.
|
||||
|
||||
|
||||
|
||||
For example, if you wanted to run the collections you have defined as tests, add the `--run-tests` command-line flag:
|
||||
|
||||
|
||||
|
||||
Generally speaking, editing these is not recommended as it is easy to render the container non-functional by doing so.
|
||||
|
||||
It is more typical in Docker contexts to set these things with environment variables.
|
||||
|
||||
Anything you can do via command-line arguments can be done with [Environment Variables](../environmental), which is more typical in Docker environments.
|
||||
|
||||
For example, you could add an environment variable named `PMM_TESTS` with a value of `true` to run the collections you have defined as tests.
|
||||
|
||||
Click "Environments" on the left to set environment variables.
|
||||
|
||||
1. Select "Storage":
|
||||
|
||||
|
||||
|
||||
1. Click the Trash Can icon to remove the default Storage Mapping:
|
||||
|
||||
|
||||
|
||||
1. Click "Add Volume" then choose “Bind Mount Host Path”:
|
||||
|
||||
|
||||
|
||||
1. Select the Yellow Folder icon
|
||||
|
||||
|
||||
|
||||
“Select Host Path” will appear as seen below, letting you select the folder you want to use.
|
||||
|
||||
|
||||
|
||||
After selecting your folder and choosing "Apply" the "Host" path will be filled in. For the "Container" path you MUST use `/config`:
|
||||
|
||||
|
||||
|
||||
1. Select Next to advance to “Step 3 Summary”
|
||||
|
||||
1. Select Finish
|
||||
|
||||
````
|
||||
````{tab} Container Station v. unknown
|
||||
|
||||
1. Open Container Station; click "Create" in the left column.
|
||||
|
||||
|
||||
|
|
@ -30,11 +129,15 @@ Steps.
|
|||
|
||||
2. Change the container name if you wish.
|
||||
|
||||
Command line arguments can be entered in the "Entrypoint" field after `/tini -s python3 plex_meta_manager.py --` IMPORTANT: DO NOT REMOVE ANY ELEMENT OF THAT COMMAND.
|
||||
Command line arguments can be entered in the "Entrypoint" field after `/tini -s python3 plex_meta_manager.py --`
|
||||
|
||||
For example: `/tini -s python3 plex_meta_manager.py -- --run`
|
||||
IMPORTANT: **DO NOT REMOVE** ANY ELEMENT OF THAT TEXT. DO NOT ENTER ANYTHING INTO THE "Command" FIELD.
|
||||
|
||||
Information on available command line argument can be found [here](../environmental)
|
||||
For example, you could enter the following into the "Entrypoint" field to make PMM run immediately when the container starts up: `/tini -s python3 plex_meta_manager.py -- --run`
|
||||
|
||||
Typically, in a Docker environment, this sort of thing is done via Environment Variables [the next step here]. Editing the "Entrypoint" is not recommended, as it's easy to render the container non-functional if you are not sure what you're doing.
|
||||
|
||||
Information on available command line arguments can be found [here](../environmental)
|
||||
|
||||
Click "Advanced Settings >>"
|
||||
|
||||
|
|
@ -44,6 +147,10 @@ Steps.
|
|||
|
||||
3. Environment Variables can be added here:
|
||||
|
||||
Anything you can do via command-line arguments can be done with Environment Variables, which is more typical in Docker environments.
|
||||
|
||||
For example, you could add an environment variable named `PMM_RUN` with a value of `True` to make PMM run immediately when the container starts up.
|
||||
|
||||
Information on available Environment Variables can be found [here](../environmental)
|
||||
|
||||
|
||||
|
|
@ -55,6 +162,7 @@ Steps.
|
|||
Click "Add" in the middle section "Volume from host".
|
||||
|
||||
"Volume from host" is the location on your QNAP where you want to store the config files.
|
||||
|
||||
"Mount Point" must be `/config`
|
||||
|
||||
When finished, click "Create".
|
||||
|
|
@ -62,3 +170,4 @@ Steps.
|
|||
|
||||
|
||||
|
||||
````
|
||||
|
|
|
|||
BIN
docs/home/guides/qnap/qnap3-01.png
Normal file
BIN
docs/home/guides/qnap/qnap3-01.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 327 KiB |
BIN
docs/home/guides/qnap/qnap3-02.png
Normal file
BIN
docs/home/guides/qnap/qnap3-02.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 317 KiB |
BIN
docs/home/guides/qnap/qnap3-03.png
Normal file
BIN
docs/home/guides/qnap/qnap3-03.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 330 KiB |
BIN
docs/home/guides/qnap/qnap3-03a.png
Normal file
BIN
docs/home/guides/qnap/qnap3-03a.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 327 KiB |
BIN
docs/home/guides/qnap/qnap3-04.png
Normal file
BIN
docs/home/guides/qnap/qnap3-04.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 319 KiB |
BIN
docs/home/guides/qnap/qnap3-05.png
Normal file
BIN
docs/home/guides/qnap/qnap3-05.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 190 KiB |
BIN
docs/home/guides/qnap/qnap3-06.png
Normal file
BIN
docs/home/guides/qnap/qnap3-06.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 203 KiB |
BIN
docs/home/guides/qnap/qnap3-07.png
Normal file
BIN
docs/home/guides/qnap/qnap3-07.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 197 KiB |
BIN
docs/home/guides/qnap/qnap3-08.png
Normal file
BIN
docs/home/guides/qnap/qnap3-08.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 202 KiB |
BIN
docs/home/guides/qnap/qnap3-09.png
Normal file
BIN
docs/home/guides/qnap/qnap3-09.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 190 KiB |
BIN
docs/home/guides/qnap/qnap3-10.png
Normal file
BIN
docs/home/guides/qnap/qnap3-10.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 197 KiB |
BIN
docs/home/guides/qnap/qnap3-11.png
Normal file
BIN
docs/home/guides/qnap/qnap3-11.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 193 KiB |
BIN
docs/home/guides/qnap/qnap3-12.png
Normal file
BIN
docs/home/guides/qnap/qnap3-12.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 196 KiB |
BIN
docs/home/guides/qnap/qnap3-13.png
Normal file
BIN
docs/home/guides/qnap/qnap3-13.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 196 KiB |
BIN
docs/home/guides/qnap/qnap3-14.png
Normal file
BIN
docs/home/guides/qnap/qnap3-14.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 201 KiB |
|
|
@ -1,4 +1,4 @@
|
|||
# Synology Walthrough
|
||||
# Synology Walkthrough
|
||||
|
||||
This is a quick walkthrough of setting up the Plex-Meta-Manager Docker container in the Synology UI.
|
||||
|
||||
|
|
|
|||
|
|
@ -81,7 +81,8 @@ docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex
|
|||
|
||||
### Docker Compose:
|
||||
|
||||
Example Docker Compose file:
|
||||
This is an example docker-compose which will have to be edited to suit your environment before use, but illustrates the minimal contents:
|
||||
|
||||
```yaml
|
||||
version: "2.1"
|
||||
services:
|
||||
|
|
@ -99,11 +100,16 @@ services:
|
|||
|
||||
A `Dockerfile` is included within the GitHub repository for those who require it, although this is only suggested for those with knowledge of dockerfiles. The official Plex Meta Manager build is available on the [Dockerhub Website](https://hub.docker.com/r/meisnate12/plex-meta-manager).
|
||||
|
||||
## Runtime flags and ENV vars
|
||||
## Customizing the docker-compose file with runtime flags and ENV vars
|
||||
|
||||
Plex Meta Manager's behavior can be modified in a variety of ways using either runtime flags or environnment variables. These flags and vars are detailed [here](environmental).
|
||||
|
||||
For example, this docker-compose would create a container that runs immediately upon start (rather than waiting until 5AM), uses a particular config file, processes only overlays on only one library, and exits when done:
|
||||
This is optional, and is not necessary to run PMM. Many if not most users will have no reason to do this and can use something more like the basic docker-compose just above.
|
||||
|
||||
This example docker-compose would create a container that runs immediately upon start (rather than waiting until 5AM), uses a particular config file, processes only overlays on only one library, and exits when done. Those four changes are made by the four `environment:` entries, which are discussed in detail after the example:
|
||||
|
||||
As with the one above, this is an example docker-compose which will have to be edited to suit your environment before use.
|
||||
|
||||
```yaml
|
||||
version: "2.1"
|
||||
services:
|
||||
|
|
@ -118,3 +124,13 @@ services:
|
|||
volumes:
|
||||
- /path/to/config:/config
|
||||
```
|
||||
|
||||
`- PMM_RUN=true` tells PMM to run right away,
|
||||
|
||||
`- PMM_CONFIG=/config/special-config.yml` points PMM at a particular config file,
|
||||
|
||||
`- PMM_OVERLAYS=true` tells PMM to run overlays only, and
|
||||
|
||||
`- PMM_LIBRARIES=Movies` tells PMM to process only a library called "Movies"
|
||||
|
||||
Again, a list of the available enviroment variables can be found [here](environmental).
|
||||
|
|
@ -11,9 +11,9 @@
|
|||
[](https://github.com/sponsors/meisnate12)
|
||||
[](https://github.com/sponsors/meisnate12)
|
||||
|
||||
Your Plex folders are growing out of control. You use overlays from [Plex Meta Manager](https://github.com/meisnate12/Plex-Meta-Manager) (PMM) or upload lots of custom art from [Title Card Maker](https://github.com/CollinHeist/TitleCardMaker) (TCM) that you no longer want to use or need to eliminate. You don't want to perform the [plex dance](https://www.plexopedia.com/plex-media-server/general/plex-dance/) if you can avoid it. This script will free up gigs of space....
|
||||
Your Plex folders are growing out of control. You use overlays from [Plex Meta Manager](https://github.com/meisnate12/Plex-Meta-Manager) (PMM) or upload lots of custom art from [Title Card Maker](https://github.com/CollinHeist/TitleCardMaker) (TCM) that you no longer want to use or need to eliminate. You don't want to perform the [plex dance](https://www.plexopedia.com/plex-media-server/general/plex-dance/) if you can avoid it. This script can be a solution, and may free up gigs of space....
|
||||
|
||||
As well as being able to clean the PhotoTranscoder Directory and running the Plex operations Empty Trash, Clean Bundles, and Optimize DB.
|
||||
I can also clean the PhotoTranscoder Directory and run the Plex operations Empty Trash, Clean Bundles, and Optimize DB.
|
||||
|
||||
Special Thanks to [bullmoose20](https://github.com/bullmoose20) for the original [Plex Bloat Fix](https://github.com/bullmoose20/Plex-Stuff#plex-bloat-fix) (PBF) Script this is based on.
|
||||
|
||||
|
|
@ -30,6 +30,8 @@ Generally, Plex Image Cleanup can be installed in one of two ways:
|
|||
|
||||
GENERALLY SPEAKING, running as a Docker container is simpler, as you won't have to be concerned about installing Python, or support libraries, or any possible system conflicts generated by those actions.
|
||||
|
||||
HOWEVER, you will have to give careful consideration to mapping directories into the container.
|
||||
|
||||
For this reason, it's generally recommended that you install via Docker rather than directly on the host.
|
||||
|
||||
If you have some specific reason to avoid Docker, or you prefer running it as a Python script for some particular reason, then this general recommendation is not aimed at you. It's aimed at someone who doesn't have an existing compelling reason to choose one over the other.
|
||||
|
|
@ -76,7 +78,7 @@ docker run -v <PATH_TO_CONFIG>:/config:rw -v <PATH_TO_PLEX>:/plex:rw meisnate12/
|
|||
```
|
||||
* The `-v <PATH_TO_CONFIG>:/config:rw` and `-v <PATH_TO_PLEX>:/plex:rw` flags mount the location you choose as a persistent volumes to store your files and give access to plex.
|
||||
* Change `<PATH_TO_CONFIG>` to a folder where your .env and other files are.
|
||||
* Change `<PATH_TO_PLEX>` to the folder where your Plex Folder is (It contains folders: Cache, Metadata, Plug-in Support).
|
||||
* Change `<PATH_TO_PLEX>` to the "Plex Media Server" folder inside the Plex app data folder (this is the folder that contains `Cache`, `Metadata`, `Plug-in Support`).
|
||||
* If your directory has spaces (such as "My Documents"), place quotation marks around your directory pathing as shown here: `-v "<PATH_TO_CONFIG>:/config:rw"`
|
||||
|
||||
Example Docker Run command:
|
||||
|
|
@ -155,6 +157,8 @@ TRACE=False
|
|||
LOG_REQUESTS=False
|
||||
```
|
||||
|
||||
IMPORTANT: If you are running this in Docker, remember that these settings are being read *inside the container*, so, for example, `PLEX_PATH` cannot be a path on the host. You will need to map directories into the container [as shown in the docker run command above], then use those mapped directories in the `.env`. Similarly, the URL may need to change depnding on how you have Docker networking set up. An address on your LAN may not work.
|
||||
|
||||
### Base Options
|
||||
|
||||
#### Plex Path
|
||||
|
|
|
|||
|
|
@ -116,7 +116,7 @@ Each option can be applied in three ways:
|
|||
| TMDb V3 API Key | TMDb V3 API Key for restoring posters from TMDb.<br>**Shell Command:** `-ta` or `--tmdbapi 123456789123456789`<br>**Environment Variable:** `TMDBAPI=123456789123456789` | ❌ |
|
||||
| Start From | Plex Item Title to Start restoring posters from.<br>**Shell Command:** `-st` or `--start "Mad Max"`<br>**Environment Variable:** `START=Mad Max` | ❌ |
|
||||
| Items | Restore specific Plex Items by Title. Can use a bar-separated (<code>|</code>) list.<br>**Shell Command:** `-it` or <code>--items "Mad Max|Mad Max 2"</code><br>**Environment Variable:** <code>ITEMS=Mad Max|Mad Max 2</code> | ❌ |
|
||||
| Timeout | Timeout can be any number greater then 0. **Default:** `600`<br>**Shell Command:** `-ti` or `--timeout 1000`<br>**Environment Variable:** `TIMEOUT=1000` | ❌ |
|
||||
| Timeout | Timeout can be Any number greater than 0. **Default:** `600`<br>**Shell Command:** `-ti` or `--timeout 1000`<br>**Environment Variable:** `TIMEOUT=1000` | ❌ |
|
||||
| Dry Run | Run as a Dry Run without making changes in Plex.<br>**Shell Command:** `-d` or `--dry`<br>**Environment Variable:** `DRY_RUN=True` | ❌ |
|
||||
| Flat Assets | PMM Asset Folder uses [Flat Assets Image Paths](https://metamanager.wiki/en/latest/home/guides/assets.html#asset-naming).<br>**Shell Command:** `-f` or `--flat`<br>**Environment Variable:** `PMM_FLAT=True` | ❌ |
|
||||
| Reset Season Posters | Restore Season posters during run.<br>**Shell Command:** `-s` or `--season`<br>**Environment Variable:** `SEASON=True` | ❌ |
|
||||
|
|
|
|||
|
|
@ -99,7 +99,7 @@ Each option can be applied in three ways:
|
|||
|:------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------:|
|
||||
| List URL | TMDb List, TMDb Collection, IMDb List, Trakt List, or MDbList List URL. <br>**Shell Command:** `-u` or `--url "https://trakt.tv/users/movistapp/lists/christmas-movies"` <br>**Environment Variable:** `URL=https://trakt.tv/users/movistapp/lists/christmas-movies` | ✅ |
|
||||
| PMM Config | Path to PMM Config with TMDb/Trakt configured. **Default:** `config/config.yml`<br>**Shell Command:** `-pm` or `--pmm-config "C:\Plex Meta Manager\config\config.yml"`<br>**Environment Variable:** `PMM_CONFIG=C:\Plex Meta Manager\config\config.yml` | ❌ |
|
||||
| Timeout | Timeout can be any number greater then 0. **Default:** `600`<br>**Shell Command:** `-ti` or `--timeout 1000`<br>**Environment Variable:** `TIMEOUT=1000` | ❌ |
|
||||
| Timeout | Timeout can be Any number greater than 0. **Default:** `600`<br>**Shell Command:** `-ti` or `--timeout 1000`<br>**Environment Variable:** `TIMEOUT=1000` | ❌ |
|
||||
| TPDb Placeholders | Add TPDb placeholders over url placeholders.<br>**Shell Command:** `-tp` or `--tpdb`<br>**Environment Variable:** `TPDB=True` | ❌ |
|
||||
| Background Placeholders | Add Background placeholders.<br>**Shell Command:** `-b` or `--background`<br>**Environment Variable:** `BACKGROUND=True` | ❌ |
|
||||
| Season Placeholders | Add Season posters placeholders.<br>**Shell Command:** `-s` or `--season`<br>**Environment Variable:** `SEASON=True` | ❌ |
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue