diff --git a/VERSION b/VERSION index 596c2e58..9076d6d2 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.19.1-develop60 +1.19.1-develop61 diff --git a/defaults/both/content_rating_de.yml b/defaults/both/content_rating_de.yml new file mode 100644 index 00000000..86c13097 --- /dev/null +++ b/defaults/both/content_rating_de.yml @@ -0,0 +1,137 @@ +############################################################################## +# DE Content Rating Collections # +# Created by Yozora, Bullmoose20, & Sohjiro # +# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # +# https://metamanager.wiki/en/latest/defaults/both/content_rating_de.html # +############################################################################## + +external_templates: + pmm: templates + template_variables: + collection_section: "110" + +collections: + Ratings Collections: + template: + - name: separator + separator: content_rating + key_name: Ratings + translation_key: separator + +dynamic_collections: + DE Content Rating: + type: content_rating + title_format: <> <>s + other_name: Not Rated <>s + template: + - smart_filter + - shared + other_template: + - other_collection + - smart_filter + - shared + template_variables: + search_term: + default: content_rating + image: + default: content_rating/de/<> + other: content_rating/de/NR + translation_key: + default: content_rating + other: content_rating_other + dynamic: + default: true + include: + - 0 + - 6 + - 12 + - 16 + - 18 + - BJPM + addons: + 0: + - de/0 + - U + - 1 + - 2 + - 3 + - 4 + - 5 + - "01" + - "02" + - "03" + - "04" + - "05" + - G + - TV-G + - TV-Y + - G - All Ages + - gb/U + - gb/0+ + - E + - gb/E + - A + - no/A + - no/5 + - no/05 + 6: + - de/6 + - gb/9+ + - TV-PG + - TV-Y7 + - TV-Y7-FV + - PG + - 7 + - 8 + - 9 + - 10 + - 11 + - "07" + - "08" + - "09" + - PG - Children + - no/6 + - no/06 + - no/7 + - no/07 + - no/9 + - no/09 + - no/10 + - no/11 + 12: + - de/12 + - gb/12 + - no/12 + - gb/15 + - gb/14+ + - TV-14 + - 13 + - 14 + - 15 + - PG-13 - Teens 13 or older + - PG-13 + - no/15 + 16: + - de/16 + - no/16 + - A-17 + - TVMA + - TV-MA + - R + - 17 + - M/PG + 18: + - de/18 + - gb/18 + - M + - no/18 + - R18 + - gb/R18 + - gb/X + - X + - NC-17 + - R+ - Mild Nudity + - Rx - Hentai + BJPM: + - de/BPjM Restricted + - BPjM Restricted diff --git a/defaults/overlays/content_rating_de.yml b/defaults/overlays/content_rating_de.yml new file mode 100644 index 00000000..65b3d29e --- /dev/null +++ b/defaults/overlays/content_rating_de.yml @@ -0,0 +1,80 @@ +############################################################################## +# DE Content Rating Overlay # +# Created by Yozora, Bullmoose20, & Sohjiro # +# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # +# https://metamanager.wiki/en/latest/defaults/overlays/content_rating_de.html# +############################################################################## + +external_templates: + pmm: templates + template_variables: + default: + key: <> + horizontal_offset: 15 + horizontal_align: left + vertical_offset: 270 + vertical_align: bottom + back_width: 305 + back_height: 105 + back_radius: 30 + back_color: '#00000099' + conditionals: + inside_color: + default: "c" + conditions: + - color: false + value: "" + pmm: + conditions: + - file.exists: false + file_<>.exists: false + url.exists: false + url_<>.exists: false + git.exists: false + git_<>.exists: false + repo.exists: false + repo_<>.exists: false + value: cr/de<><> + +templates: + cr_de: + ignore_blank_results: true + plex_search: + validate: false + any: + content_rating: <> + +overlays: + 0: + template: + - name: standard + - {name: cr_de, rating: "de/0, U, 0, 1, 01, 2, 02, 3, 03, 4, 04, 5, 05, G, TV-G, TV-Y, G - All Ages, gb/U, gb/0+, E, gb/E, A, no/A, no/5, no/05"} + + 6: + template: + - name: standard + - {name: cr_de, rating: "de/6, 6, gb/9+, TV-PG, TV-Y7, TV-Y7-FV, PG, 7, 07, 8, 08, 9, 09, 10, 11, PG - Children, no/6, no/06, no/7, no/07, no/9, no/09, no/10, no/11"} + + 12: + template: + - name: standard + - {name: cr_de, rating: "de/12, gb/12, 12, no/12, gb/15, gb/14+, TV-14, 13, 14, 15, PG-13 - Teens 13 or older, PG-13, no/15"} + + 16: + template: + - name: standard + - {name: cr_de, rating: "de/16, no/16, A-17, TVMA, TV-MA, R, 16, 17, M/PG"} + + 18: + template: + - name: standard + - {name: cr_de, rating: "de/18, gb/18, M, 18, R - 17+ (violence & profanity), no/18, R18, gb/R18, gb/X, X, NC-17, R+ - Mild Nudity, Rx - Hentai"} + + bpjm: + template: + - name: standard + - {name: cr_de, rating: "de/BPjM Restricted, BPjM Restricted"} + nr: + template: + - {name: standard, key: nr} + - {name: cr_de, rating: "None, NR, Not Rated, Unrated, de/Unrated, de/Not Rated"} diff --git a/defaults/overlays/images/cr/de0.png b/defaults/overlays/images/cr/de0.png index a6134e9b..3df8da07 100644 Binary files a/defaults/overlays/images/cr/de0.png and b/defaults/overlays/images/cr/de0.png differ diff --git a/defaults/overlays/images/cr/de0c.png b/defaults/overlays/images/cr/de0c.png index 3b66ef15..3df8da07 100644 Binary files a/defaults/overlays/images/cr/de0c.png and b/defaults/overlays/images/cr/de0c.png differ diff --git a/defaults/overlays/images/cr/de0cw.png b/defaults/overlays/images/cr/de0cw.png new file mode 100644 index 00000000..f1da3129 Binary files /dev/null and b/defaults/overlays/images/cr/de0cw.png differ diff --git a/defaults/overlays/images/cr/de12.png b/defaults/overlays/images/cr/de12.png index cad9595a..1b7e0b82 100644 Binary files a/defaults/overlays/images/cr/de12.png and b/defaults/overlays/images/cr/de12.png differ diff --git a/defaults/overlays/images/cr/de12c.png b/defaults/overlays/images/cr/de12c.png index 72e2f665..482a6073 100644 Binary files a/defaults/overlays/images/cr/de12c.png and b/defaults/overlays/images/cr/de12c.png differ diff --git a/defaults/overlays/images/cr/de12cw.png b/defaults/overlays/images/cr/de12cw.png new file mode 100644 index 00000000..887b6534 Binary files /dev/null and b/defaults/overlays/images/cr/de12cw.png differ diff --git a/defaults/overlays/images/cr/de16.png b/defaults/overlays/images/cr/de16.png index 6f515a05..dcaee1a3 100644 Binary files a/defaults/overlays/images/cr/de16.png and b/defaults/overlays/images/cr/de16.png differ diff --git a/defaults/overlays/images/cr/de16c.png b/defaults/overlays/images/cr/de16c.png index bc06999c..64544ce4 100644 Binary files a/defaults/overlays/images/cr/de16c.png and b/defaults/overlays/images/cr/de16c.png differ diff --git a/defaults/overlays/images/cr/de16cw.png b/defaults/overlays/images/cr/de16cw.png new file mode 100644 index 00000000..91928c15 Binary files /dev/null and b/defaults/overlays/images/cr/de16cw.png differ diff --git a/defaults/overlays/images/cr/de18.png b/defaults/overlays/images/cr/de18.png index dce33589..5d24b2cf 100644 Binary files a/defaults/overlays/images/cr/de18.png and b/defaults/overlays/images/cr/de18.png differ diff --git a/defaults/overlays/images/cr/de18c.png b/defaults/overlays/images/cr/de18c.png index 4890f9e7..65a1595f 100644 Binary files a/defaults/overlays/images/cr/de18c.png and b/defaults/overlays/images/cr/de18c.png differ diff --git a/defaults/overlays/images/cr/de18cw.png b/defaults/overlays/images/cr/de18cw.png new file mode 100644 index 00000000..15e7b49b Binary files /dev/null and b/defaults/overlays/images/cr/de18cw.png differ diff --git a/defaults/overlays/images/cr/de6.png b/defaults/overlays/images/cr/de6.png index 2bb59f17..a558e1db 100644 Binary files a/defaults/overlays/images/cr/de6.png and b/defaults/overlays/images/cr/de6.png differ diff --git a/defaults/overlays/images/cr/de6c.png b/defaults/overlays/images/cr/de6c.png index 4e547d81..09a9458b 100644 Binary files a/defaults/overlays/images/cr/de6c.png and b/defaults/overlays/images/cr/de6c.png differ diff --git a/defaults/overlays/images/cr/de6cw.png b/defaults/overlays/images/cr/de6cw.png new file mode 100644 index 00000000..9b06a9ed Binary files /dev/null and b/defaults/overlays/images/cr/de6cw.png differ diff --git a/defaults/overlays/images/cr/debpjm.png b/defaults/overlays/images/cr/debpjm.png index 34cd01c0..d501ca61 100644 Binary files a/defaults/overlays/images/cr/debpjm.png and b/defaults/overlays/images/cr/debpjm.png differ diff --git a/defaults/overlays/images/cr/debpjmc.png b/defaults/overlays/images/cr/debpjmc.png index 81563f40..a040764d 100644 Binary files a/defaults/overlays/images/cr/debpjmc.png and b/defaults/overlays/images/cr/debpjmc.png differ diff --git a/defaults/overlays/images/cr/debpjmcw.png b/defaults/overlays/images/cr/debpjmcw.png new file mode 100644 index 00000000..28ccbd3b Binary files /dev/null and b/defaults/overlays/images/cr/debpjmcw.png differ diff --git a/docs/defaults/both/content_rating_de.md b/docs/defaults/both/content_rating_de.md new file mode 100644 index 00000000..d6a7d50e --- /dev/null +++ b/docs/defaults/both/content_rating_de.md @@ -0,0 +1,206 @@ +# DE Content Rating Collections + +The `content_rating_de` Default Collection File is used to dynamically create collections based on the content ratings available in your library. + +If you do not use the German-based rating system within Plex, this file will attempt to match the ratings in your library to the respective rating system. + +![](../images/content_rating_de.png) + +## Requirements & Recommendations + +Supported Library Types: Movie, Show + +Recommendation: Set the Certification Country within your library's advanced settings to "United Kingdom" + +## Collections Section 110 + +| Collection | Key | Description | +|:------------------------------------------------------------------|:--------------------------------------------|:----------------------------------------------------------------------------------------| +| `Ratings Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. | +| `<> Movies/Shows`
**Example:** `BJPM Movies` | `<>`
**Example:** `BJPM` | Collection of Movies/Shows that have this Content Rating. | +| `Not Rated Movies/Shows` | `other` | Collection of Movies/Shows that are Unrated, Not Rated or any other uncommon Ratings. | + +## Config + +The below YAML in your config.yml will create the collections: + +```yaml +libraries: + Movies: + collection_files: + - pmm: content_rating_de + TV Shows: + collection_files: + - pmm: content_rating_de +``` + +## Template Variable Default Values + +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. + +This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. + +| Variable | Description & Values | +|:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | +| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | +| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | +| `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | +| `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** List of Content Ratings found in your library | +| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.
**Values:** List of Content Ratings found in your library | +| `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Content Ratings found in your library | +| `append_include` | **Description:** Appends to the [default include list](#default-include).
**Values:** List of Content Ratings found in your library | +| `remove_include` | **Description:** Removes from the [default include list](#default-include).
**Values:** List of Content Ratings found in your library | +| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Content Ratings found in your library | +| `remove_addons` | **Description:** Removes from the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Content Ratings found in your library | +| `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | +| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s that are rated <>.`
**Values:** Any string. | + +1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. + +{% + include-markdown "../collection_variables.md" +%} + +### Example Template Variable Amendments + +The below is an example config.yml extract with some Template Variables added in to change how the file works. + +???+ tip + + Anywhere you see this icon: + + > :fontawesome-solid-circle-plus: + + That's a tooltip, you can press them to get more information. + +```yaml +libraries: + Movies: + collection_files: + - pmm: content_rating_cs + template_variables: + sep_style: stb #(1)! + use_other: false #(2)! + append_addons: + BJPM: #(3)! + - X #(4)! + sort_by: title.asc +``` + +1. Use the stb [Separator Style](../separators.md#separator-styles) +2. Do not create a "Not Rated Movies/Shows" collection +3. Defines a collection which will be called "BJPM", this does not need to already exist in your library +4. Adds the "X" content rating to the "BJPM" addon list, "X" must exist in your library if the "BJPM" content rating does not + +## Default values + +???+ tip + + These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.** + + If you want to customize these values, use the methods described above. + +### Default `include` + +```yaml +include: + - 0 + - 6 + - 12 + - 16 + - 18 + - BJPM +``` + +### Default `addons` + +```yaml + addons: + 0: + - de/0 + - U + - 1 + - 2 + - 3 + - 4 + - 5 + - "01" + - "02" + - "03" + - "04" + - "05" + - G + - TV-G + - TV-Y + - G - All Ages + - gb/U + - gb/0+ + - E + - gb/E + - A + - no/A + - no/5 + - no/05 + 6: + - de/6 + - gb/9+ + - TV-PG + - TV-Y7 + - TV-Y7-FV + - PG + - 7 + - 8 + - 9 + - 10 + - 11 + - "07" + - "08" + - "09" + - PG - Children + - no/6 + - no/06 + - no/7 + - no/07 + - no/9 + - no/09 + - no/10 + - no/11 + 12: + - de/12 + - gb/12 + - no/12 + - gb/15 + - gb/14+ + - TV-14 + - 13 + - 14 + - 15 + - PG-13 - Teens 13 or o + - PG-13 + - no/15 + 16: + - de/16 + - no/16 + - A-17 + - TVMA + - TV-MA + - R + - 17 + - M/PG + 18: + - de/18 + - gb/18 + - M + - no/18 + - R18 + - gb/R18 + - gb/X + - X + - NC-17 + - R+ - Mild Nudity + - Rx - Hentai + BJPM: + - de/BPjM Restricted + - BPjM Restricted +``` \ No newline at end of file diff --git a/docs/defaults/images/content_rating_de.png b/docs/defaults/images/content_rating_de.png new file mode 100644 index 00000000..08fa6d29 Binary files /dev/null and b/docs/defaults/images/content_rating_de.png differ diff --git a/docs/defaults/overlays/content_rating_de.md b/docs/defaults/overlays/content_rating_de.md new file mode 100644 index 00000000..14980a3b --- /dev/null +++ b/docs/defaults/overlays/content_rating_de.md @@ -0,0 +1,83 @@ +# Content Rating DE Overlay + +The `content_rating_de` Default Overlay File is used to create an overlay based on the FSK Rating on each item within your library. + +![](images/content_rating_de.png) + +## Requirements & Recommendations + +Supported library types: Movie & Show + +Requirements: Use the [Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with either `mdb` or `omdb` to update Plex to the BBFC Rating. + +## Supported Content Rating DE + +| Rating | Key | +|:-------|:-------| +| 0 | `0` | +| 6 | `6` | +| 12 | `12` | +| 16 | `16` | +| 18 | `18` | +| BPJM | `bpjm` | +| NR | `nr` | + +## Config + +The below YAML in your config.yml will create the overlays: + +```yaml +libraries: + Movies: + overlay_files: + - pmm: content_rating_de + TV Shows: + overlay_files: + - pmm: content_rating_de + - pmm: content_rating_de + template_variables: + builder_level: season + - pmm: content_rating_de + template_variables: + builder_level: episode +``` + +## Template Variable Default Values + +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. + +| Variable | Default / Values | +|:--------------------|:-----------------| +| `color` | `` | +| `horizontal_offset` | `15` | +| `horizontal_align` | `left` | +| `vertical_offset` | `270` | +| `vertical_align` | `bottom` | + +| Variable | Description & Values | +|:------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `color` | **Description:** Color version of the content rating images
**Default:**`` Set to `false` if you want b&w version. | +| `back_color` | **Description:** Choose the back color in RGBA for the overlay lozenge.
**Default:**`#00000099` | +| `back_radius` | **Description:** Choose the back radius for the overlay lozenge.
**Default:**`30` | +| `back_width` | **Description:** Choose the back width for the overlay lozenge.
**Default:**`305` | +| `back_height` | **Description:** Choose the back height for the overlay lozenge.
**Default:**`105` | +| `addon_offset` | **Description:** Text Addon Image Offset from the text.
**Default:** `15`
**Values:** Any number greater than 0 | +| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.
**Default:** `left`
**Values:** `left`, `right`, `top`, `bottom` | +| `builder_level` | **Description:** Choose the Overlay Level.
**Values:** `season` or `episode` | + +{% + include-markdown "../overlay_variables.md" +%} + +## Example Template Variable Amendments + +The below is an example config.yml extract with some Template Variables added in to change how the file works. + +```yaml +libraries: + Movies: + overlay_files: + - pmm: content_rating_de + template_variables: + color: false +``` diff --git a/docs/defaults/overlays/images/content_rating_de.png b/docs/defaults/overlays/images/content_rating_de.png new file mode 100644 index 00000000..db043076 Binary files /dev/null and b/docs/defaults/overlays/images/content_rating_de.png differ diff --git a/mkdocs.yml b/mkdocs.yml index 0f3209ab..e672ccaa 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -197,6 +197,7 @@ nav: - US Content Ratings (Movie): defaults/movie/content_rating_us.md - US Content Ratings (Show): defaults/show/content_rating_us.md - UK Content Ratings: defaults/both/content_rating_uk.md + - DE Content Ratings: defaults/both/content_rating_de.md - MyAnimeList Content Ratings: defaults/both/content_rating_mal.md - Common Sense Media Content Ratings: defaults/both/content_rating_cs.md - Location: @@ -243,6 +244,7 @@ nav: - US Content Ratings (Movie): defaults/overlays/content_rating_us_movie.md - US Content Ratings (Show): defaults/overlays/content_rating_us_show.md - UK Content Ratings: defaults/overlays/content_rating_uk.md + - DE Content Ratings: defaults/overlays/content_rating_de.md - Common Sense Age Ratings: defaults/overlays/commonsense.md - Media: - Aspect Ratio: defaults/overlays/aspect.md