[50] update max docs

pull/1418/head
meisnate12 2 years ago
parent e79f77c32f
commit 88f99f6be9

@ -1 +1 @@
1.19.0-develop49 1.19.0-develop50

@ -21,7 +21,7 @@ templates:
default: <<library_type>> default: <<library_type>>
conditions: conditions:
- originals_only: true - originals_only: true
key: [appletv, disney, hbomax, hulu, netflix, paramount, peacock, amazon] key: [appletv, disney, max, hulu, netflix, paramount, peacock, amazon]
value: "original" value: "original"
allowed_streaming: allowed_streaming:
conditions: conditions:
@ -35,7 +35,7 @@ templates:
key: [crave] key: [crave]
value: False value: False
- region: ca - region: ca
key: [hbomax, showtime] key: [max, showtime]
value: False value: False
watch_region: watch_region:
default: "" default: ""
@ -101,7 +101,7 @@ dynamic_collections:
discovery: discovery+ discovery: discovery+
disney: Disney+ disney: Disney+
hayu: hayu hayu: hayu
hbomax: Max max: Max
hulu: Hulu hulu: Hulu
netflix: Netflix netflix: Netflix
now: NOW now: NOW

@ -60,7 +60,7 @@ templates:
default: <<library_type>> default: <<library_type>>
conditions: conditions:
- originals_only: true - originals_only: true
key: [appletv, disney, hbomax, hulu, netflix, paramount, peacock, amazon] key: [appletv, disney, max, hulu, netflix, paramount, peacock, amazon]
value: "original" value: "original"
allowed_streaming: allowed_streaming:
conditions: conditions:
@ -74,7 +74,7 @@ templates:
key: [crave] key: [crave]
value: False value: False
- region: ca - region: ca
key: [hbomax, showtime] key: [max, showtime]
value: False value: False
watch_region: watch_region:
default: "" default: ""
@ -121,7 +121,7 @@ overlays:
template: [name: standard, name: mdb_streaming] template: [name: standard, name: mdb_streaming]
Max: Max:
variables: {key: hbomax, weight: 130} variables: {key: max, weight: 130}
template: [name: standard, name: mdb_streaming] template: [name: standard, name: mdb_streaming]
Crunchyroll: Crunchyroll:

@ -22,7 +22,7 @@ Supported Library Types: Movie, Show
| `discovery+ Shows` | `discovery` | Collection of Shows Streaming on discovery+. | | `discovery+ Shows` | `discovery` | Collection of Shows Streaming on discovery+. |
| `Disney+ Movies/Shows` | `disney` | Collection of Movies/Shows Streaming on Disney+. | | `Disney+ Movies/Shows` | `disney` | Collection of Movies/Shows Streaming on Disney+. |
| `hayu Shows` | `hayu` | Collection of Shows Streaming on hayu. | | `hayu Shows` | `hayu` | Collection of Shows Streaming on hayu. |
| `Max Movies/Shows` | `hbomax` | Collection of Movies/Shows Streaming on Max. | | `Max Movies/Shows` | `max` | Collection of Movies/Shows Streaming on Max. |
| `Hulu Movies/Shows` | `hulu` | Collection of Movies/Shows Streaming on Hulu. | | `Hulu Movies/Shows` | `hulu` | Collection of Movies/Shows Streaming on Hulu. |
| `Netflix Movies/Shows` | `netflix` | Collection of Movies/Shows Streaming on Netflix. | | `Netflix Movies/Shows` | `netflix` | Collection of Movies/Shows Streaming on Netflix. |
| `NOW Movies/Shows` | `now` | Collection of Movies/Shows Streaming on NOW. | | `NOW Movies/Shows` | `now` | Collection of Movies/Shows Streaming on NOW. |
@ -55,19 +55,19 @@ All [Shared Collection Variables](../collection_variables) are available as well
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
| Variable | Description & Values | | Variable | Description & Values |
|:--------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |:--------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 | | `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_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 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` | **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) | | `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> | | `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> | | `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> |
| `exclude` | **Description:** Exclude these Streaming Services from creating a Dynamic Collection.<br>**Values:** List of Streaming Service Keys | | `exclude` | **Description:** Exclude these Streaming Services from creating a Dynamic Collection.<br>**Values:** List of Streaming Service Keys |
| `region` | **Description:** Changes some Streaming Service lists to regional variants (see below table for more information.<br>**Default:** `us`<br>**Values:** `us`,`uk`,`ca`, `da`, `de`, `es`, `fr`, `it`, `pt-br` | | `region` | **Description:** Changes some Streaming Service lists to regional variants (see below table for more information.<br>**Default:** `us`<br>**Values:** `us`,`uk`,`ca`, `da`, `de`, `es`, `fr`, `it`, `pt-br` |
| `originals_only` | **Description:** Changes Streaming Service lists to only show original content produced by the service.<br>**Note**: Cannot be used with `region`, and only produces collections for `amazon`, `appletv`, `disney`, `hbomax`, `hulu`, `netflix`, `paramount`, `peacock`<br>**Default:** `false`<br>**Values:** `true`, `false` | | `originals_only` | **Description:** Changes Streaming Service lists to only show original content produced by the service.<br>**Note**: Cannot be used with `region`, and only produces collections for `amazon`, `appletv`, `disney`, `max`, `hulu`, `netflix`, `paramount`, `peacock`<br>**Default:** `false`<br>**Values:** `true`, `false` |
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. |
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s streaming on <<key_name>>.`<br>**Values:** Any string. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s streaming on <<key_name>>.`<br>**Values:** Any string. |
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
@ -80,7 +80,7 @@ Some logic is applied to allow for regional streaming service lists to be availa
| any besides `us` | `amazon`, `disney`, `netflix` | These collections will use regional variant lists to ensure the lists populate with what is available in the region specified | | any besides `us` | `amazon`, `disney`, `netflix` | These collections will use regional variant lists to ensure the lists populate with what is available in the region specified |
| any besides `uk` | `all4`, `britbox`, `hayu`, `now` | These collections will not be created if the region is not `uk` as these streaming services are UK-focused | | any besides `uk` | `all4`, `britbox`, `hayu`, `now` | These collections will not be created if the region is not `uk` as these streaming services are UK-focused |
| any besides `ca` | `crave` | These collections will not be created if the region is not `ca` as these streaming services are Canada-focused | | any besides `ca` | `crave` | These collections will not be created if the region is not `ca` as these streaming services are Canada-focused |
| `ca` | `hbomax`, `showtime` | These collections will not be created if the region is `ca` as these streaming services are part of the Crave streaming service in Canada | | `ca` | `max`, `showtime` | These collections will not be created if the region is `ca` as these streaming services are part of the Crave streaming service in Canada |
The below is an example config.yml extract with some Template Variables added in to change how the file works. The below is an example config.yml extract with some Template Variables added in to change how the file works.

@ -28,7 +28,7 @@ These collections are applied by calling the below paths into the `metadata_path
| [Chart Separator](chart/separator) | `separator_chart` | Chart Collections | &#9989; | &#9989; | | [Chart Separator](chart/separator) | `separator_chart` | Chart Collections | &#9989; | &#9989; |
| [AniList](chart/anilist) | `anilist` | AniList Popular, AniList Season | &#9989; | &#9989; | | [AniList](chart/anilist) | `anilist` | AniList Popular, AniList Season | &#9989; | &#9989; |
| [Basic](chart/basic) | `basic` | Newly Released, New Episodes | &#9989; | &#9989; | | [Basic](chart/basic) | `basic` | Newly Released, New Episodes | &#9989; | &#9989; |
| [FlixPatrol](chart/flixpatrol) | `flixpatrol` | Top Disney, Top Hbo, Top Hulu, Top Netflix | &#9989; | &#9989; | | [FlixPatrol](chart/flixpatrol) | `flixpatrol` | Top Disney, Top Max, Top Hulu, Top Netflix | &#9989; | &#9989; |
| [IMDb](chart/imdb) | `imdb` | IMDb Popular, IMDb Top 250 | &#9989; | &#9989; | | [IMDb](chart/imdb) | `imdb` | IMDb Popular, IMDb Top 250 | &#9989; | &#9989; |
| [MyAnimeList](chart/myanimelist) | `myanimelist` | MyAnimeList Popular, MyAnimeList Top Rated | &#9989; | &#9989; | | [MyAnimeList](chart/myanimelist) | `myanimelist` | MyAnimeList Popular, MyAnimeList Top Rated | &#9989; | &#9989; |
| [Other](chart/other) | `other_chart` | AniDB Popular, Common Sense Selection | &#9989; | &#9989; | | [Other](chart/other) | `other_chart` | AniDB Popular, Common Sense Selection | &#9989; | &#9989; |
@ -60,7 +60,7 @@ These collections are applied by calling the below paths into the `metadata_path
| [Producer](movie/producer) | `producer` | James Cameron (Producer), Reese Witherspoon (Producer) | &#9989; | &#10060; | | [Producer](movie/producer) | `producer` | James Cameron (Producer), Reese Witherspoon (Producer) | &#9989; | &#10060; |
| [Resolution](both/resolution) | `resolution` | 4K Movies, 1080p Movies, 720p Movies | &#9989; | &#9989; | | [Resolution](both/resolution) | `resolution` | 4K Movies, 1080p Movies, 720p Movies | &#9989; | &#9989; |
| [Seasonal](movie/seasonal) | `seasonal` | Easter, Christmas | &#9989; | &#10060; | | [Seasonal](movie/seasonal) | `seasonal` | Easter, Christmas | &#9989; | &#10060; |
| [Streaming](both/streaming) | `streaming` | Disney+ Movies, Max Shows | &#9989; | &#9989; | | [Streaming](both/streaming) | `streaming` | Disney+ Movies, Max Shows | &#9989; | &#9989; |
| [Studio](both/studio) | `studio` | DreamWorks Studios, Walt Disney Pictures | &#9989; | &#9989; | | [Studio](both/studio) | `studio` | DreamWorks Studios, Walt Disney Pictures | &#9989; | &#9989; |
| [Anime Studio](both/studio_anime) | `studio_anime` | Bones, Studio Ghibli, Toei Animation | &#9989; | &#9989; | | [Anime Studio](both/studio_anime) | `studio_anime` | Bones, Studio Ghibli, Toei Animation | &#9989; | &#9989; |
| [Subtitle Language](both/subtitle_language) | `subtitle_language` | German Subtitles, Swedish Subtitles | &#9989; | &#9989; | | [Subtitle Language](both/subtitle_language) | `subtitle_language` | German Subtitles, Swedish Subtitles | &#9989; | &#9989; |

@ -11,26 +11,26 @@ Supported Overlay Level: Movie, Show
## Supported Streaming Services ## Supported Streaming Services
| Streaming Service | Key | Weight | | Streaming Service | Key | Weight |
|:------------------|:---------------|:-------| |:------------------|:--------------|:-------|
| Netflix | `netflix` | `160` | | Netflix | `netflix` | `160` |
| Prime Video | `amazon` | `150` | | Prime Video | `amazon` | `150` |
| Disney+ | `disney` | `140` | | Disney+ | `disney` | `140` |
| Max | `hbomax` | `130` | | Max | `max` | `130` |
| Crunchyroll | `Crunchyroll` | `120` | | Crunchyroll | `Crunchyroll` | `120` |
| YouTube | `youtube` | `110` | | YouTube | `youtube` | `110` |
| Hulu | `hulu` | `100` | | Hulu | `hulu` | `100` |
| Paramount+ | `paramount` | `90` | | Paramount+ | `paramount` | `90` |
| AppleTV | `appletv` | `80` | | AppleTV | `appletv` | `80` |
| Peacock | `peacock` | `70` | | Peacock | `peacock` | `70` |
| Showtime | `showtime` | `60` | | Showtime | `showtime` | `60` |
| discovery+ | `discovery` | `58` | | discovery+ | `discovery` | `58` |
| Crave | `crave` | `55` | | Crave | `crave` | `55` |
| NOW | `now` | `50` | | NOW | `now` | `50` |
| All 4 | `all4` | `40` | | All 4 | `all4` | `40` |
| britbox | `britbox` | `30` | | britbox | `britbox` | `30` |
| BET+ | `bet` | `20` | | BET+ | `bet` | `20` |
| hayu | `hayu` | `10` | | hayu | `hayu` | `10` |
## Config ## Config
@ -66,7 +66,7 @@ All [Shared Overlay Variables](../overlay_variables) are available with the defa
| `back_width` | **Description:** Change the back (lozenge) width.<br>**Default Value:** `305` | | `back_width` | **Description:** Change the back (lozenge) width.<br>**Default Value:** `305` |
| `back_height` | **Description:** Change the back (lozenge) height.<br>**Default Value:** `105` | | `back_height` | **Description:** Change the back (lozenge) height.<br>**Default Value:** `105` |
| `region` | **Description:** Changes some Streaming Service lists to regional variants (see below table for more information.<br>**Default:** `us`<br>**Values:** `us`,`uk`,`ca`, `da`, `de`, `es`, `fr`, `it`, `pt-br` | | `region` | **Description:** Changes some Streaming Service lists to regional variants (see below table for more information.<br>**Default:** `us`<br>**Values:** `us`,`uk`,`ca`, `da`, `de`, `es`, `fr`, `it`, `pt-br` |
| `originals_only` | **Description:** Changes Streaming Service overlays to only apply to original content produced by the service.<br>**Note**: Cannot be used with `region`, and only produces overlays for `amazon`, `appletv`, `disney`, `hbomax`, `hulu`, `netflix`, `paramount`, `peacock`<br>**Default:** `false`<br>**Values:** `true`, `false` | | `originals_only` | **Description:** Changes Streaming Service overlays to only apply to original content produced by the service.<br>**Note**: Cannot be used with `region`, and only produces overlays for `amazon`, `appletv`, `disney`, `max`, `hulu`, `netflix`, `paramount`, `peacock`<br>**Default:** `false`<br>**Values:** `true`, `false` |
| `weight_<<key>>`<sup>1</sup> | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number | | `weight_<<key>>`<sup>1</sup> | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number |
1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` with when calling. 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` with when calling.
@ -80,7 +80,7 @@ Some logic is applied to allow for regional streaming service lists to be availa
| any besides `us` | `amazon`, `disney`, `netflix` | These overlays will use regional variant lists to ensure the overlays are applied to what is available in the region specified | | any besides `us` | `amazon`, `disney`, `netflix` | These overlays will use regional variant lists to ensure the overlays are applied to what is available in the region specified |
| any besides `uk` | `all4`, `britbox`, `hayu`, `now` | These overlays will not be used if the region is not `uk` as these streaming services are UK-focused | | any besides `uk` | `all4`, `britbox`, `hayu`, `now` | These overlays will not be used if the region is not `uk` as these streaming services are UK-focused |
| any besides `ca` | `crave` | These overlays will not be used if the region is not `ca` as these streaming services are Canada-focused | | any besides `ca` | `crave` | These overlays will not be used if the region is not `ca` as these streaming services are Canada-focused |
| `ca` | `hbomax`, `showtime` | These overlays will not be used if the region is `ca` as these streaming services are part of the Crave streaming service in Canada | | `ca` | `max`, `showtime` | These overlays will not be used if the region is `ca` as these streaming services are part of the Crave streaming service in Canada |
The below is an example config.yml extract with some Template Variables added in to change how the file works. The below is an example config.yml extract with some Template Variables added in to change how the file works.

@ -35,7 +35,7 @@ These are all the files that contain a separator
| Writers Collections | `writer` | | Writers Collections | `writer` |
| Based On... Collections | `based` | | Based On... Collections | `based` |
## Shared Separator Variables ## Shared Separator 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. 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.

@ -2083,7 +2083,7 @@ dynamic_collections:
bet: BET+ bet: BET+
britbox: BritBox britbox: BritBox
disney: Disney+ disney: Disney+
hbo-max: Max max: Max
hulu: Hulu hulu: Hulu
netflix: Netflix netflix: Netflix
now: NOW now: NOW

Loading…
Cancel
Save