forked from Kometa-Team/Kometa
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7c33510
commit 01ba1ed
Showing
5 changed files
with
482 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,151 @@ | ||
############################################################################## | ||
# NZ Content Rating Collections # | ||
# Adapted by nzvengeance # | ||
# Created by Yozora, Bullmoose20, & Sohjiro # | ||
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # | ||
# https://metamanager.wiki/en/latest/defaults/overlays/content_rating_nz # | ||
############################################################################## | ||
|
||
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: | ||
NZ Content Rating: | ||
type: content_rating | ||
title_format: <<key_name>> <<library_typeU>>s | ||
other_name: Not Rated <<library_typeU>>s | ||
template: | ||
- smart_filter | ||
- shared | ||
other_template: | ||
- other_collection | ||
- smart_filter | ||
- shared | ||
template_variables: | ||
search_term: | ||
default: content_rating | ||
image: | ||
default: content_rating/nz/<<key_name>> | ||
other: content_rating/nz/NR | ||
translation_key: | ||
default: content_rating | ||
other: content_rating_other | ||
dynamic: | ||
default: true | ||
include: | ||
- G | ||
- PG | ||
- M | ||
- MA15+ | ||
- R18+ | ||
- X18+ | ||
addons: | ||
G: | ||
- au/G | ||
- de/0 | ||
- U | ||
- 0 | ||
- 1 | ||
- 2 | ||
- 3 | ||
- 4 | ||
- 5 | ||
- 6 | ||
- "01" | ||
- "02" | ||
- "03" | ||
- "04" | ||
- "05" | ||
- "06" | ||
- G | ||
- TV-G | ||
- TV-Y | ||
- G - All Ages | ||
- gb/U | ||
- gb/0+ | ||
- E | ||
- gb/E | ||
- A | ||
- no/A | ||
- no/5 | ||
- no/05 | ||
PG: | ||
- au/PG | ||
- 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 | ||
M: | ||
- au/M | ||
- de/12 | ||
- gb/12 | ||
- no/12 | ||
- gb/15 | ||
- gb/14+ | ||
- TV-14 | ||
- 12 | ||
- 13 | ||
- 14 | ||
- 15 | ||
- PG-13 - Teens 13 or older | ||
- PG-13 | ||
- no/15 | ||
MA15+: | ||
- au/MA15+ | ||
- de/16 | ||
- no/16 | ||
- A-17 | ||
- TVMA | ||
- TV-MA | ||
- R | ||
- 16 | ||
- 17 | ||
- M/PG | ||
R18+: | ||
- au/R 18+ | ||
- 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 | ||
X18+: | ||
- au/X 18+ | ||
- de/BPjM Restricted | ||
- BPjM Restricted |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
############################################################################## | ||
# NZ Content Rating Overlay # | ||
# Adapted by nzvengeance # | ||
# Created by Yozora, Bullmoose20, & Sohjiro # | ||
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # | ||
# https://metamanager.wiki/en/latest/defaults/overlays/content_rating_nz # | ||
############################################################################## | ||
|
||
external_templates: | ||
pmm: templates | ||
template_variables: | ||
default: | ||
key: <<overlay_name>> | ||
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_<<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: cr/nz_<<overlay_name>><<inside_color>> | ||
|
||
templates: | ||
cr_nz: | ||
ignore_blank_results: true | ||
plex_search: | ||
validate: false | ||
any: | ||
content_rating: <<rating>> | ||
|
||
overlays: | ||
g: | ||
template: | ||
- name: standard | ||
- {name: cr_nz, rating: "au/G, de/0, U, 0, 1, 01, 2, 02, 3, 03, 4, 04, 5, 05, 6, 06, G, TV-G, TV-Y, G - All Ages, gb/U, gb/0+, E, gb/E, A, no/A, no/5, no/05"} | ||
|
||
pg: | ||
template: | ||
- name: standard | ||
- {name: cr_nz, rating: "au/PG, de/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"} | ||
|
||
m: | ||
template: | ||
- name: standard | ||
- {name: cr_nz, rating: "au/M, de/12, gb/12, 12, no/12, gb/15, gb/14+, TV-14, 12, 13, 14, 15, PG-13 - Teens 13 or older, PG-13, no/15"} | ||
|
||
ma: | ||
template: | ||
- name: standard | ||
- {name: cr_nz, rating: "au/MA15+, de/16, no/16, A-17, TVMA, TV-MA, R, 16, 17, M/PG"} | ||
|
||
r: | ||
template: | ||
- name: standard | ||
- {name: cr_nz, rating: "au/R 18+, 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"} | ||
|
||
x: | ||
template: | ||
- name: standard | ||
- {name: cr_nz, rating: "au/X 18+, de/BPjM Restricted, BPjM Restricted"} | ||
nr: | ||
template: | ||
- {name: standard, key: nr} | ||
- {name: cr_nz, rating: "None, NR, Not Rated, Unrated, de/Unrated, de/Not Rated, au/Unrated, au/Not Rated"} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,147 @@ | ||
# NZ Content Rating Collections | ||
|
||
The `content_rating_nz` Default Collection File is used to dynamically create collections based on the content ratings | ||
available in your library. | ||
|
||
If you do not use the New Zealand-based rating system within Plex, this file will attempt to match the ratings in your | ||
library to the respective rating system. | ||
|
||
![](../images/content_rating_nz.png) | ||
|
||
## Requirements & Recommendations | ||
|
||
Supported Library Types: Movie, Show | ||
|
||
Recommendation: Set the Certification Country within your library's advanced settings to "New Zealand" | ||
|
||
## Collections Section 110 | ||
|
||
| Collection | Key | Description | | ||
|:-------------------------------------------------------------|:-----------------------------------------|:--------------------------------------------------------------------------------------| | ||
| `Ratings Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. | | ||
| `<<Content Rating>> Movies/Shows`<br>**Example:** `G Movies` | `<<Content Rating>>`<br>**Example:** `G` | 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_nz | ||
TV Shows: | ||
collection_files: | ||
- pmm: content_rating_nz | ||
``` | ||
## 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 will use its default value if it has one if not it's just ignored. | ||
|
||
??? abstract "Variable Lists (click to expand)" | ||
|
||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file. | ||
|
||
* **Shared Template Variables** are additional variables shared across the PMM Defaults. | ||
|
||
* **Shared Separator Variables** are additional variables available since this Default contains a | ||
[Separator](../separators.md). | ||
|
||
=== "File-Specific Template Variables" | ||
|
||
| Variable | Description & Values | | ||
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| `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](../../files/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](../../files/builders/smart.md#sort-options) | | ||
| `include` | **Description:** Overrides the [default include list](#include).<br>**Values:** List of Content Ratings found in your library | | ||
| `append_include` | **Description:** Appends to the [default include list](#include).<br>**Values:** List of Content Ratings found in your library | | ||
| `remove_include` | **Description:** Removes from the [default include list](#include).<br>**Values:** List of Content Ratings found in your library | | ||
| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.<br>**Values:** List of Content Ratings found in your library | | ||
| `addons` | **Description:** Overrides the [default addons dictionary](#addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Dictionary List of Content Ratings found in your library | | ||
| `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Content Ratings found in your library | | ||
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Content Ratings found in your library | | ||
| `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 that are rated <<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. | ||
|
||
=== "Shared Template Variables" | ||
|
||
{% | ||
include-markdown "../collection_variables.md" | ||
%} | ||
|
||
=== "Shared Separator Variables" | ||
|
||
{% | ||
include-markdown "../separator_variables.md" | ||
%} | ||
|
||
???+ example "Example Template Variable Amendments" | ||
|
||
The below is an example config.yml extract with some Template Variables added in to change how the file works. | ||
|
||
Click the :fontawesome-solid-circle-plus: icon to learn more | ||
|
||
```yaml | ||
libraries: | ||
Movies: | ||
collection_files: | ||
- pmm: content_rating_cs | ||
template_variables: | ||
sep_style: stb #(1)! | ||
use_other: false #(2)! | ||
append_addons: | ||
BPjM: #(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 "BPjM", this does not need to already exist in your library | ||
4. Adds the "X" content rating to the "BPjM" addon list, "X" must exist in your library if the "BPjM" content | ||
rating does not | ||
|
||
## Default Values | ||
|
||
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. | ||
|
||
??? example "Default `include` (click to expand) <a class="headerlink" href="#include" title="Permanent link">¶</a>" | ||
|
||
<div id="include" /> | ||
|
||
```yaml | ||
include: {% | ||
include-markdown "../../../defaults/both/content_rating_nz.yml" | ||
comments=false | ||
preserve-includer-indent=false | ||
start="include:" | ||
end="addons:" | ||
%} | ||
``` | ||
|
||
??? example "Default `addons` (click to expand) <a class="headerlink" href="#addons" title="Permanent link">¶</a>" | ||
|
||
<div id="addons" /> | ||
|
||
```yaml | ||
addons: {% | ||
include-markdown "../../../defaults/both/content_rating_nz.yml" | ||
comments=false | ||
preserve-includer-indent=false | ||
start="addons:" | ||
%} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.