Update Streaming Overlay to allow for Regional variants. Add Crave and discovery overlay image.

defaults/overlays/streaming.yml

@@ -9,6 +9,10 @@
 external_templates:
   pmm: templates
   template_variables:
+    allowed_library_types:
+      - <<use_<<key>>>>
+      - <<use_<<alt>>>>
+      - <<allowed_libraries>>
     group: streaming
     default:
       horizontal_align: left
@@ -35,75 +39,124 @@ external_templates:
     back_color: "#00000099"
     back_width: 305
     back_height: 105
-    pmm: streaming/<<overlay_name>>
+    file: config/streaming/<<overlay_name>>.png
 
 templates:
-  streaming:
+  mdb_streaming:
+    allowed_library_types:
+      - <<allowed_streaming>>
     ignore_blank_results: true
-    mdblist_list: https://mdblist.com/lists/plexmetamanager/<<key>>-<<library_type>>s
+    mdblist_list: https://mdblist.com/lists/plexmetamanager/<<key>>-<<library_type>>s<<watch_region>>
+    conditionals:
+      allowed_streaming:
+        conditions:
+          - region.not: uk
+            key: [all4, britbox, hayu, now]
+            value: False
+          - region.not: ca
+            key: [crave]
+            value: False
+          - region: ca
+            key: [hbomax, showtime]
+            value: False
+      watch_region:
+        default: ""
+        conditions:
+          - region: ca
+            key: [amazon, disney, netflix]
+            value: "-ca"
+          - region: da
+            key: [amazon, disney, netflix]
+            value: "-da"
+          - region: de
+            key: [amazon, disney, netflix]
+            value: "-de"
+          - region: es
+            key: [amazon, disney, netflix]
+            value: "-es"
+          - region: fr
+            key: [amazon, disney, netflix]
+            value: "-fr"
+          - region: it
+            key: [amazon, disney, netflix]
+            value: "-it"
+          - region: pt-br
+            key: [amazon, disney, netflix]
+            value: "-pt-br"
+          - region: uk
+            key: [amazon, disney, netflix]
+            value: "-uk"
 
 overlays:
 
   Netflix:
     variables: {key: netflix, weight: 160}
-    template: [name: standard, name: streaming]
+    template: [name: standard, name: mdb_streaming]
 
   Prime:
     variables: {key: amazon, weight: 150}
-    template: [name: standard, name: streaming]
+    template: [name: standard, name: mdb_streaming]
 
   Disney:
     variables: {key: disney, weight: 140}
-    template: [name: standard, name: streaming]
+    template: [name: standard, name: mdb_streaming]
 
   HBO-Max:
     variables: {key: hbomax, weight: 130}
-    template: [name: standard, name: streaming]
+    template: [name: standard, name: mdb_streaming]
 
   Crunchyroll:
     variables: {key: crunchyroll, weight: 120, allowed_libraries: show}
-    template: [name: standard, name: streaming]
+    template: [name: standard, name: mdb_streaming]
 
   YouTube:
     variables: {key: youtube, weight: 110}
-    template: [name: standard, name: streaming]
+    template: [name: standard, name: mdb_streaming]
 
   Hulu:
     variables: {key: hulu, weight: 100}
-    template: [name: standard, name: streaming]
+    template: [name: standard, name: mdb_streaming]
 
   Paramount:
     variables: {key: paramount, weight: 90}
-    template: [name: standard, name: streaming]
+    template: [name: standard, name: mdb_streaming]
 
   AppleTV:
     variables: {key: appletv, weight: 80}
-    template: [name: standard, name: streaming]
+    template: [name: standard, name: mdb_streaming]
 
   Peacock:
     variables: {key: peacock, weight: 70}
-    template: [name: standard, name: streaming]
+    template: [name: standard, name: mdb_streaming]
 
   Showtime:
     variables: {key: showtime, weight: 60}
-    template: [name: standard, name: streaming]
+    template: [name: standard, name: mdb_streaming]
+
+  discovery+:
+    variables: {key: discovery, weight: 58, allowed_libraries: show}
+    template: [name: standard, name: mdb_streaming]
+
+  Crave:
+    variables: {key: crave, weight: 55}
+    template: [name: standard, name: mdb_streaming]
 
   NOW:
     variables: {key: now, weight: 50}
-    template: [name: standard, name: streaming]
+    template: [name: standard, name: mdb_streaming]
 
   All 4:
     variables: {key: all4, weight: 40}
-    template: [name: standard, name: streaming]
+    template: [name: standard, name: mdb_streaming]
 
   britbox:
     variables: {key: britbox, weight: 30}
-    template: [name: standard, name: streaming]
+    template: [name: standard, name: mdb_streaming]
 
   BET+:
     variables: {key: bet, weight: 20}
-    template: [name: standard, name: streaming]
+    template: [name: standard, name: mdb_streaming]
 
   hayu:
-    variables: {key: hayu, weight: 10}
+    variables: {key: hayu, weight: 10, allowed_libraries: show}
-    template: [name: standard, name: streaming]
+    template: [name: standard, name: mdb_streaming]

docs/defaults/overlays/streaming.md

@@ -10,8 +10,9 @@ Supported Overlay Level: Movie, Show
 
 ## Supported Streaming Services
 
+
 | Streaming Service | Key            | Weight |
-|:------------------|:--------------|:-------|
+|:------------------|:---------------|:-------|
 | Netflix           | `netflix`      | `160`  |
 | Prime Video       | `amazon`       | `150`  |
 | Disney+           | `disney`       | `140`  |
@@ -23,6 +24,8 @@ Supported Overlay Level: Movie, Show
 | AppleTV           | `appletv`      | `80`   |
 | Peacock           | `peacock`      | `70`   |
 | Showtime          | `showtime`     | `60`   |
+| discovery+        | `discovery`    | `58`   |
+| Crave             | `crave`        | `55`   |
 | NOW               | `now`          | `50`   |
 | All 4             | `all4`         | `40`   |
 | britbox           | `britbox`      | `30`   |
@@ -69,6 +72,17 @@ All [Shared Overlay Variables](../overlay_variables) are available with the defa
 
 1. Each default overlay has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
 
+## Regional Variants
+
+Some logic is applied to allow for regional streaming service lists to be available to users depending on where they are, as detailed below:
+
+| Region           | Key                              | Description                                                                                                                               |
+|:-----------------|:---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
+| 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 `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 |
+
 The below is an example config.yml extract with some Template Variables added in to change how the file works.
 
 ```yaml
@@ -77,6 +91,7 @@ libraries:
     overlay_path:
       - pmm: streaming
         template_variables:
+          region: ca
           use_peacock: false
           use_youtube: false
           weight_youtube: 5