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 |
|
|
Disney+ |
|
|
MAX |
|
|
Hulu |
|
|
Paramount+ |
|
|
Prime Video |
|
|
Apple+ |
|
|
Config¶
The below YAML in your config.yml will create the overlays:
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 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 |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Variable |
Description & Values |
---|---|
|
Description: Changes the position of the Overlays. |
|
Description: Changes the style of the Logo Image. |
|
Description: Changes the text before the number. |
|
Description: Changes the Builder Limit for all overlays in a Defaults file. |
|
Description: Changes the Builder Limit of the specified key’s overlay. |
|
Description: Changes the Builder Location for all overlays in a Defaults file. |
|
Description: Changes the Builder Location of the specified key’s overlay. |
|
Description: Changes the Builder Time Window for all overlays in a Defaults file. |
|
Description: Changes the Builder Time Window of the specified key’s overlay. |
|
Description: Controls the weight of the Overlay. Higher numbers have priority. |
|
Description: Choose the font for the Overlay. |
|
Description: Font style for Variable Fonts. |
|
Description: Choose the font size for the Overlay. |
|
Description: Choose the font color for the Overlay. |
|
Description: Font Stroke Width for the Text Overlay. |
|
Description: Font Stroke Color for the Text Overlay. |
|
Description: Text Addon Image Offset from the text. |
|
Description: Text Addon Image Alignment in relation to the text. |
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.
libraries:
Movies:
overlay_path:
- pmm: flixpatrol
template_variables:
location: united_states