Mirrors/Plex-Meta-Manager
2
0
Fork 0
mirror of https://github.com/meisnate12/Plex-Meta-Manager synced 2024-11-10 06:54:21 +00:00
Code Issues Projects Releases Packages Wiki Activity

[183] finalize wiki for 1.18.0

Browse source
This commit is contained in:
meisnate12 2022-11-03 15:44:01 -04:00
parent 1a9df0f38d
commit 8415a5fe43
58 changed files with 596 additions and 343 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
CHANGELOG
View file

@ -5,6 +5,21 @@ Updated pathvalidate requirement to 2.5.2
**New Site to request and vote for Features Requests on at [features.metamanager.wiki](https://features.metamanager.wiki/)**
# New Packaged Defaults System
All the old PMM Defaults (i.e. `- git: PMM\...` Files) are now packaged into PMM locally and can be accessed using `- pmm: ...`
Added Common Sense Selection [Movie](https://www.commonsensemedia.org/reviews/category/movie/tag/common-sense-selections-31822)] and [Show](https://www.commonsensemedia.org/reviews/category/tv/tag/common-sense-selections-31822) collections to [`chart/other`](https://metamanager.wiki/en/nightly/defaults/chart/other.html)
Added [Common Sense Media Content Rating Collections](https://metamanager.wiki/en/nightly/defaults/both/content_rating_cs.html), called with `- pmm: content_rating_cs` and to be used in combination with operation [`mass_content_rating_update: mdb_commonsense`](https://metamanager.wiki/en/nightly/config/operations.html#mass-content-rating-update).
Added [Common Sense Media Content Rating Collections](https://metamanager.wiki/en/nightly/defaults/both/content_rating_cs.html), called with `- pmm: content_rating_cs` and to be used in combination with operation [`mass_content_rating_update: mdb_commonsense`](https://metamanager.wiki/en/nightly/config/operations.html#mass-content-rating-update).
Added several [visual styles for Separators](https://metamanager.wiki/en/nightly/defaults/separators.html#separator-styles) to match PLEX's Categories theming. Called using `sep_style` template variable.
Removed special_release and incorporated it into [resolution](https://metamanager.wiki/en/nightly/defaults/overlays/resolution.html).
Enhanced [resolution](https://metamanager.wiki/en/nightly/defaults/overlays/resolution.html) to support both dovetail overlays with resolutions and box overlays when resolutions are not being used. Regexes were enhanced to support the new TRaSH naming guides with the `{edition-` naming scheme.
Added [Common Sense Age Rating](https://metamanager.wiki/en/nightly/defaults/overlays/commonsense.html) overlays, called with `- pmm: commonsense` and to be used in combination with operation [`mass_content_rating_update: mdb_commonsense`](https://metamanager.wiki/en/nightly/config/operations.html#mass-content-rating-update).
Added [mediastinger](https://metamanager.wiki/en/nightly/defaults/overlays/mediastinger.html) overlays to indicate mid-credits and post-credits scenes, called with `- pmm: mediastinger`
Removed `imdb_top_250`, `oscars`, `mc_must_see`, `rt_cert_fresh` and `commonsense_selection` Overlays in favor of adding them all into the new combined [Ribbon Overlay](https://metamanager.wiki/en/nightly/defaults/overlays/ribbon.html).
Added the new [Versions Overlay](https://metamanager.wiki/en/nightly/defaults/overlays/versions.html) which adds a visual indicator of multiple versions of media, called with `- pmm: versions`
Removed the `audio_languages` Overlay and replaced it with the [Audio/Subtitle Language Count Overlay](https://metamanager.wiki/en/nightly/defaults/overlays/language_count.html), called with `- pmm: language_count`.
Added Translations for the default collection name and summary (we're working on images). Currently we have `en`, `fr`, `de`, `da`, and `pt-br` if anyone wants to translate pmm to another language ping a team member on discord and let them know you wanna contribute.
# New Features
Added support for editions in `plex_search`, `smart_filter`, `filters`, special text overlays, and metadata editing.
Added `item_edition` [item metadata detail](https://metamanager.wiki/en/latest/metadata/details/metadata.html#item-metadata-details) to update the edition of items in a collection
@ -21,29 +36,17 @@ Adds `mass_original_title_update` [library operation](https://metamanager.wiki/e
Adds many new options to the various mass_update [library operations](https://metamanager.wiki/en/latest/config/operations.html)
Added the ability to give a list of sorts with `plex_search` and `smart_filter` to create a tiered sort
Added `edition_filter` to [Movie metadata edits](https://metamanager.wiki/en/latest/metadata/metadata/movie.html#special-attributes) to allow searching for an item to include an edition.
# Default Metadata Changes
Added Common Sense Selection [Movie](https://www.commonsensemedia.org/reviews/category/movie/tag/common-sense-selections-31822)] and [Show](https://www.commonsensemedia.org/reviews/category/tv/tag/common-sense-selections-31822) collections to `PMM/chart/other`
Added several [visual styles for Separators](https://github.com/meisnate12/Plex-Meta-Manager-Images/tree/master/separators) to match PLEX's Categories theming. Called using `sep_style` template variable
# Default Overlay Changes
Enhanced resolution.yml and special_release.yml to add International Cut, Ultimate Cut, Anniversary Cut, Theatrical Cut, Collectors Edition for both dovetail overlays with resolutions and box overlays
Enhanced resolution.yml and special_release.yml to support both dovetail overlays with resolutions and box overlays when resolutions are not being used. Regexes were enhanced to support the new TRaSH naming guides with the `{edition-` naming scheme
Added [Common Sense Age Rating](https://www.commonsensemedia.org/) overlays, called with `- git: PMM/overlays/commonsense` and to be used in combination with operation `mass_content_rating_update: mdb_commonsense`
- See [this image](https://media.discordapp.net/attachments/1018513616653262908/1020094756329623624/unknown.png)
Added Common Sense Selection overlays, called with `- git: PMM/overlays/commonsense_selection`
- See [this image](https://i.ibb.co/2cyjM1c/Untitled.png)
Added [mediastinger](http://www.mediastinger.com/) overlays to indicate mid-credits and post-credits scenes, called with `- git: PMM/overlays/mediastinger`
- See #3 on "Jurassic World: Fallen Kingdom" in [this image](https://metamanager.wiki/en/nightly/_images/movie-overlays1-annotated.png)
Added Oscars Ribbon overlay for [Best Picture Winners](https://www.imdb.com/search/title/?groups=best_picture_winner), called with `- git: PMM/overlays/oscars`
- See #11 on "Schindler's List" in [this image](https://metamanager.wiki/en/nightly/_images/movie-overlays1-annotated.png)
Added visual indicator of multiple versions of media, called with `- git: PMM/overlays/versions`
- See "The Incredible Hulk" and "Thor" in [this image]([https://cdn.discordapp.com/attachments/927936511238869042/1021788091037519892/unknown.png)
# Other Default Changes
Changed various [template names](https://github.com/meisnate12/Plex-Meta-Manager-Configs/blob/master/PMM/templates.yml). If you are running local copies of the PMM default files which call the git version of the templates file , it is strongly recommended you check template names on all your local file collections.
Added `--delete-labels` Run Commands to delete all labels in any library run.
Added `season_label`, `episode_label`, `artist_label`, and `track_label` as `plex_search` options
Moved alot of System Message to Trace Mode only to help declutter the meta.log file.
Added Redacted Config File to the meta.log
# Bug Fixes
Fixes #1014 Fix metadata assets
Fixes #1067 `.yaml` can be used
Fixes #1095 report file doesn't have to exist
Fixes `plex_search`s with `episode_collection`
Fixes Album Overlays
Fixes Addon Images
Fix Configs Repo Versioning
Fixes codec and profile filters

2
VERSION
View file

@ -1 +1 @@
1.17.3-develop182
1.17.3-develop183

18
defaults/templates.yml
View file

@ -8,10 +8,26 @@ templates:
optional:
- use_separator
- collection_mode
- placeholder_tmdb_movie
- placeholder_tvdb_show
- placeholder_imdb_id
conditionals:
use_blank:
default: true
conditions:
- placeholder_tmdb_movie.exists: true
value: false
- placeholder_tvdb_show.exists: true
value: false
- placeholder_imdb_id.exists: true
value: false
allowed_library_types: <<use_separator>>
collection_mode: <<collection_mode>>
sort_title: "!<<collection_section>>_!<<collection_name>>"
blank_collection: true
tmdb_movie: <<placeholder_tmdb_movie>>
tvdb_show: <<placeholder_tvdb_show>>
imdb_id: <<placeholder_imdb_id>>
blank_collection: <<use_blank>>
url_poster: <<url_poster_<<key>>>>
shared:

2
defaults/translations/da.yml
View file

@ -1,4 +1,4 @@
version: 1.18.0.5
version: 1.18.0.7
variables:
library_translation:
# For Movie Libraries

20
docs/_templates/navbar.html vendored
View file

@ -32,24 +32,28 @@
<li class="divider"></li>
{% elif sublink[0] == "_menu" %}
<li class="dropdown-submenu">
{% if sublink[2] == "#" %}
<a tabindex="-1" href="#">{{ sublink[1] }}</a>
{% else %}
{% if sublink|length == 4 %}
<a tabindex="-1" href="{{ pathto(sublink[2]) }}">{{ sublink[1] }}</a>
{% elif sublink|length == 5 %}
<a tabindex="-1" href="{{ pathto(sublink[2]) }}{{ sublink[3] }}">{{ sublink[1] }}</a>
{% else %}
<a tabindex="-1" href="#">{{ sublink[1] }}</a>
{% endif %}
<ul class="dropdown-menu">
{%- for subsublink in sublink[3] %}
{%- for subsublink in sublink[-1] %}
{% if subsublink[0] == "_divider" %}
<li class="divider"></li>
{% elif subsublink[0] == "_menu" %}
<li class="dropdown-submenu">
{% if subsublink[2] == "#" %}
<a tabindex="-1" href="#">{{ subsublink[1] }}</a>
{% else %}
{% if subsublink|length == 4 %}
<a tabindex="-1" href="{{ pathto(subsublink[2]) }}">{{ subsublink[1] }}</a>
{% elif subsublink|length == 5 %}
<a tabindex="-1" href="{{ pathto(subsublink[2]) }}{{ subsubsublink[3] }}">{{ subsublink[1] }}</a>
{% else %}
<a tabindex="-1" href="#">{{ subsubsublink[1] }}</a>
{% endif %}
<ul class="dropdown-menu">
{%- for subsubsublink in subsublink[3] %}
{%- for subsubsublink in subsublink[-1] %}
{% if subsubsublink[0] == "_divider" %}
<li class="divider"></li>
{% elif subsubsublink|length > 2 %}

30
docs/conf.py
View file

@ -100,7 +100,9 @@ html_show_sourcelink = False
redirects = {
"redact": "https://regex101.com/r/DMo1DQ/latest",
"home/guides/alternative-docker": "images.html",
"home/guides/defaults": "../../defaults/guide.html"
"home/guides/defaults": "../../defaults/guide.html",
"metadata/details/setting": "definition.html",
"metadata/details/details": "update.html",
}
# Theme options are theme-specific and customize the look and feel of a
@ -137,6 +139,7 @@ html_theme_options = {
("Run Commands & Environment Variables", "home/environmental"),
("Knowledgebase/FAQ", "home/kb"),
("_divider", ),
("YAML File Guide", "home/guides/yaml"),
("Scheduling Guide", "home/guides/scheduling"),
("Image Asset Directory Guide", "home/guides/assets"),
("Formula 1 Metadata Guide", "home/guides/formula"),
@ -202,7 +205,7 @@ html_theme_options = {
("Shared Variables", "defaults/variables"),
("_divider", ),
("Separators", "defaults/separators"),
("_menu", "Award", "defaults/award/separator", [
("_menu", "Award", "defaults/defaults", "#award-collections", [
("Awards Separator", "defaults/award/separator"),
("_divider",),
("Academy Awards (Oscars)", "defaults/award/oscars"),
@ -215,7 +218,7 @@ html_theme_options = {
("Sundance File Festival Awards", "defaults/award/sundance"),
("Other Awards", "defaults/award/other"),
]),
("_menu", "Chart", "defaults/chart/separator", [
("_menu", "Chart", "defaults/defaults", "#chart-collections", [
("Chart Separator", "defaults/chart/separator"),
("_divider",),
("Basic Charts", "defaults/chart/basic"),
@ -228,7 +231,7 @@ html_theme_options = {
("Trakt Charts", "defaults/chart/trakt"),
("Other Charts", "defaults/chart/other"),
]),
("_menu", "Movie", "defaults/separators", [
("_menu", "Movie", "defaults/defaults", "#general-collections", [
("Actors", "defaults/both/actor"),
("Audio Languages", "defaults/both/audio_language"),
("Collectionless", "defaults/both/collectionless"),
@ -252,7 +255,7 @@ html_theme_options = {
("Writers", "defaults/movie/writer"),
("Years", "defaults/both/year"),
]),
("_menu", "Show", "defaults/separators", [
("_menu", "Show", "defaults/defaults", "#general-collections", [
("Actors", "defaults/both/actor"),
("Audio Languages", "defaults/both/audio_language"),
("Collectionless", "defaults/both/collectionless"),
@ -344,7 +347,9 @@ html_theme_options = {
("Editing TV Metadata", "metadata/metadata/show"),
("Editing Music Metadata", "metadata/metadata/music"),
]),
("_menu", "Builders", "#", [
("_menu", "Builders", "metadata/builders", [
("Builders", "metadata/builders"),
("_divider", ),
("_menu", "Plex Builders", "metadata/builders/plex", [
("Plex All", "metadata/builders/plex", "#plex-all"),
("Plex Watchlist", "metadata/builders/plex", "#plex-watchlist"),
@ -462,11 +467,14 @@ html_theme_options = {
("MyAnimeList Seasonal", "metadata/builders/myanimelist", "#myanimelist-seasonal"),
]),
]),
("_menu", "Details", "#", [
("Setting Details", "metadata/details/setting"),
("Schedule Details", "metadata/details/schedule"),
("Metadata Details", "metadata/details/metadata"),
("Radarr/Sonarr Details", "metadata/details/arr"),
("_menu", "Settings/Updates", "metadata/update", [
("Settings/Updates", "metadata/update"),
("_divider",),
("Definition Settings", "metadata/details/definition"),
("Schedule Settings", "metadata/details/schedule"),
("Radarr/Sonarr Definition Settings", "metadata/details/arr"),
("Collection/Playlist Metadata Updates", "metadata/details/metadata"),
("Item Metadata Updates", "metadata/details/item_metadata"),
])
]),
("&#10084", "https://github.com/sponsors/meisnate12", True),

18
docs/config/operations.md
View file

@ -234,7 +234,7 @@ Updates every item's labels in the library to match the IMDb Parental Guide
**Attribute:** `mass_imdb_parental_labels`
**Values** `with_none` or `without_none` |
**Values** `with_none` or `without_none`
## Mass Collection Mode
@ -242,7 +242,7 @@ Updates every Collection in your library to the specified Collection Mode.
**Attribute:** `mass_collection_mode`
**Values:** `default`: Library default<br>`hide`: Hide Collection<br>`hide_items`: Hide Items in this Collection<br>`show_items`: Show this Collection and its Items<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`hide`</td><td>Hide Collection</td></tr><tr><td>`hide_items`</td><td>Hide Items in this Collection</td></tr><tr><td>`show_items`</td><td>Show this Collection and its Items</td></tr></table> |
**Values:** `default`: Library default<br>`hide`: Hide Collection<br>`hide_items`: Hide Items in this Collection<br>`show_items`: Show this Collection and its Items<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`hide`</td><td>Hide Collection</td></tr><tr><td>`hide_items`</td><td>Hide Items in this Collection</td></tr><tr><td>`show_items`</td><td>Show this Collection and its Items</td></tr></table>
## Update Blank Track Titles`
@ -250,7 +250,7 @@ Search though every track in a music library and replace any blank track titles
**Attribute:** `update_blank_track_titles`
**Values:** `true` or `false` |
**Values:** `true` or `false`
## Remove Title Parentheses
@ -258,7 +258,7 @@ Search through every title and remove all ending parentheses in an items title i
**Attribute:** `remove_title_parentheses`
**Values:** `true` or `false` |
**Values:** `true` or `false`
## Split Duplicates
@ -266,7 +266,7 @@ Splits all duplicate movies/shows found in this library.
**Attribute:** `split_duplicates`
**Values:** `true` or `false` |
**Values:** `true` or `false`
## Radarr Add All
@ -274,7 +274,7 @@ Adds every item in the library to Radarr. The existing paths in plex will be use
**Attribute:** `radarr_add_all`
**Values:** `true` or `false` |
**Values:** `true` or `false`
## Radarr Remove By Tag`
@ -282,7 +282,7 @@ Removes every item from Radarr with the Tags given.
**Attribute:** `radarr_remove_by_tag`
**Values:** List or comma separated string of tags |
**Values:** List or comma separated string of tags
## Sonarr Add All
@ -290,7 +290,7 @@ Adds every item in the library to Sonarr. The existing paths in plex will be use
**Attribute:** `sonarr_add_all`
**Values:** `true` or `false` |
**Values:** `true` or `false`
## Sonarr Remove By Tag
@ -298,7 +298,7 @@ Removes every item from Sonarr with the Tags given.
**Attribute:** `sonarr_remove_by_tag`
**Values:** List or comma separated string of tags |
**Values:** List or comma separated string of tags
## Genre Mapper

6
docs/config/settings.md
View file

@ -10,7 +10,7 @@ Examples of these settings include the ability to:
The settings attribute and attributes can be specified individually per library, or can be inherited from the global value if it has been set. If an attribute is specified at both the library and global level, then the library level attribute will take priority.
There are some attributes which can be specified at the collection level using [Setting Details](../metadata/details/setting).
There are some attributes which can be specified at the collection level using [Setting Details](../metadata/details/definition).
Attributes set at the collection level will take priority over any library or global-level attribute.
@ -320,7 +320,7 @@ If a collection is skipped due to it not being scheduled, delete the collection.
## Run Again Delay
Set the number of minutes to delay running `run_again` collections after daily run is finished.
* A collection is a `run_again` collection if it has the `run_again` [Setting Detail](../metadata/details/setting) attribute set to true.
* A collection is a `run_again` collection if it has the `run_again` [Setting Detail](../metadata/details/definition) attribute set to true.
<table class="dualTable colwidths-auto align-default table">
<tr>
@ -334,7 +334,7 @@ Set the number of minutes to delay running `run_again` collections after daily r
</table>
## Missing Only Released
Whilst running a collection, all unreleased missing items will be filtered out from the [missing YAML file](../metadata/details/setting)
Whilst running a collection, all unreleased missing items will be filtered out from the [missing YAML file](../metadata/details/definition)
<table class="dualTable colwidths-auto align-default table">
<tr>

12
docs/defaults/award/separator.md
View file

@ -4,7 +4,7 @@ The `separator_award` Default Metadata File is used to create a seperator collec
**This file works with Movie and Show Libraries.**
![](../images/separators2.jpg)
![](../images/awardseparator.png)
## Collections Section 16
@ -34,15 +34,7 @@ Note that the `templates_variables:` section only needs to be used if you do wan
**[Shared Collection Variables](../variables) are NOT available to this default file.**
| Variable | Description & Values |
|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `name_separator` | **Description:** Changes the name of the specified key's collection.<br>**Values:** New Collection Name |
| `summary_separator` | **Description:** Changes the summary of the specified key's collection.<br>**Values:** New Collection Summary |
| `collection_section` | **Description:** Changes the sort order of the collection sections against other default collection sections.<br>**Values:** Any number |
| `collection_mode` | **Description:** Controls the collection mode of all collections in a Defaults file.<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`hide`</td><td>Hide Collection</td></tr><tr><td>`hide_items`</td><td>Hide Items in this Collection</td></tr><tr><td>`show_items`</td><td>Show this Collection and its Items</td></tr></table> |
| `url_poster_separator` | **Description:** Changes the poster url of the specified key's collection.<br>**Values:** URL directly to the Image |
This file contains only a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available.
The below is an example config.yml extract with some Template Variables added in to change how the file works.

4
docs/defaults/both/actor.md
View file

@ -41,11 +41,11 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
| Variable | Description & Values |
|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `style` | **Description:** Controls the visual theme of the collections created.<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>bw</code></td><td>Black & White Theme</td></tr><tr><td><code>rainier</code></td><td>Rainier Theme</td></tr></table> |
| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `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 |
| `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) |

4
docs/defaults/both/audio_language.md
View file

@ -36,10 +36,10 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
| Variable | Description & Values |
|:-------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `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 |
| `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) |

4
docs/defaults/both/content_rating_cs.md
View file

@ -40,10 +40,10 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
| Variable | Description & Values |
|:-------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `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 |
| `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) |

4
docs/defaults/both/content_rating_mal.md
View file

@ -38,10 +38,10 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
| Variable | Description & Values |
|:-------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `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 |
| `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) |

4
docs/defaults/both/content_rating_uk.md
View file

@ -38,10 +38,10 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
| Variable | Description & Values |
|:-------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `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 |
| `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) |

4
docs/defaults/both/genre.md
View file

@ -37,10 +37,10 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
| Variable | Description & Values |
|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `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 |
| `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) |

4
docs/defaults/both/resolution.md
View file

@ -44,11 +44,11 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
| Variable | Description & Values |
|:------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `style` | **Description:** Controls the visual theme of the collections created.<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>default</code></td><td>Default Theme</td></tr><tr><td><code>standards</code></td><td>Standards Theme</td></tr></table> |
| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `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 |
| `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) |

4
docs/defaults/both/streaming.md
View file

@ -49,10 +49,10 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
| Variable | Description & Values |
|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `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 |
| `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) |

4
docs/defaults/both/studio.md
View file

@ -37,10 +37,10 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
| Variable | Description & Values |
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `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 |
| `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) |

4
docs/defaults/both/studio_anime.md
View file

@ -35,10 +35,10 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
| Variable | Description & Values |
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `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 |
| `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) |

4
docs/defaults/both/subtitle_language.md
View file

@ -36,10 +36,10 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
| Variable | Description & Values |
|:----------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `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 |
| `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) |

4
docs/defaults/both/year.md
View file

@ -35,10 +35,10 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
| Variable | Description & Values |
|:------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `10`<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) |

12
docs/defaults/chart/separator.md
View file

@ -4,7 +4,7 @@ The `separator_chart` Default Metadata File is used to create a seperator collec
**This file works with Movie and Show Libraries.**
![](../images/separators2.jpg)
![](../images/chartseparator.png)
## Collections Section 01
@ -34,15 +34,7 @@ Note that the `templates_variables:` section only needs to be used if you do wan
**[Shared Collection Variables](../variables) are NOT available to this default file.**
| Variable | Description & Values |
|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `name_separator` | **Description:** Changes the name of the specified key's collection.<br>**Values:** New Collection Name |
| `summary_separator` | **Description:** Changes the summary of the specified key's collection.<br>**Values:** New Collection Summary |
| `collection_section` | **Description:** Changes the sort order of the collection sections against other default collection sections.<br>**Values:** Any number |
| `collection_mode` | **Description:** Controls the collection mode of all collections in a Defaults file.<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`hide`</td><td>Hide Collection</td></tr><tr><td>`hide_items`</td><td>Hide Items in this Collection</td></tr><tr><td>`show_items`</td><td>Show this Collection and its Items</td></tr></table> |
| `url_poster_separator` | **Description:** Changes the poster url of the specified key's collection.<br>**Values:** URL directly to the Image |
This file contains only a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available.
The below is an example config.yml extract with some Template Variables added in to change how the file works.

BIN
docs/defaults/images/awardseparator.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 216 KiB

BIN
docs/defaults/images/chartseparator.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 150 KiB

BIN
docs/defaults/images/collectionless.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 54 KiB

4
docs/defaults/movie/content_rating_us.md
View file

@ -35,10 +35,10 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
| Variable | Description & Values |
|:--------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `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 |
| `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) |

4
docs/defaults/movie/country.md
View file

@ -39,10 +39,10 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
| Variable | Description & Values |
|:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `style` | **Description:** Controls the visual theme of the collections created<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>white</code></td><td>White Theme</td></tr><tr><td><code>color</code></td><td>Color Theme</td></tr></table> |
| `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 |

4
docs/defaults/movie/decade.md
View file

@ -32,10 +32,10 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
| Variable | Description & Values |
|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `100`<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:** `critic_rating.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |

4
docs/defaults/movie/director.md
View file

@ -38,10 +38,10 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
| Variable | Description & Values |
|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `style` | **Description:** Controls the visual theme of the collections created<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>bw</code></td><td>Black & White Theme</td></tr><tr><td><code>rainier</code></td><td>Rainier Theme</td></tr></table> |
| `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 |

4
docs/defaults/movie/producer.md
View file

@ -38,10 +38,10 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
| Variable | Description & Values |
|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `style` | **Description:** Controls the visual theme of the collections created<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>bw</code></td><td>Black & White Theme</td></tr><tr><td><code>rainier</code></td><td>Rainier Theme</td></tr></table> |
| `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 |

4
docs/defaults/movie/seasonal.md
View file

@ -43,10 +43,10 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
| Variable | Description & Values |
|:--------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.<br>**Values:** `true` to turn on the collection |
| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `tmdb_collection_<<key>>`<sup>1</sup> | **Description:** Adds the TMDb Collection IDs given to the specified key's collection. Overrides the [default tmdb_collection](#default-tmdb_collection) for that collection if used.<br>**Values:** List of TMDb Collection IDs |
| `tmdb_movie_<<key>>`<sup>1</sup> | **Description:** Adds the TMDb Movie IDs given to the specified key's collection. Overrides the [default tmdb_movie](#default-tmdb_movie) for that collection if used.<br>**Values:** List of TMDb Movie IDs | |
| `imdb_list_<<key>>`<sup>1</sup> | **Description:** Adds the Movies in the IMDb List to the specified key's collection. Overrides the [default imdb_list](#default-imdb_list) for that collection if used.<br>**Values:** List of IMDb List URLs | | |

4
docs/defaults/movie/universe.md
View file

@ -45,10 +45,10 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
| Variable | Description & Values |
|:---------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
| `minimum_items` | **Description:** Controls the minimum items that the collection must have to be created.<br>**Default:** `2`<br>**Values:** Any number |

4
docs/defaults/movie/writer.md
View file

@ -38,10 +38,10 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
| Variable | Description & Values |
|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `style` | **Description:** Controls the visual theme of the collections created<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>bw</code></td><td>Black & White Theme</td></tr><tr><td><code>rainier</code></td><td>Rainier Theme</td></tr></table> |
| `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 |

BIN
docs/defaults/overlays/images/audio_codec2.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 712 KiB

0
docs/defaults/overlays/images/audio_language.png → docs/defaults/overlays/images/language_count.png
View file

Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 318 KiB

After

Width:  |  Height:  |  Size: 318 KiB

23
docs/defaults/separators.md
View file

@ -34,7 +34,7 @@ These are all the files that contain a separator.
| Producers Collections | `producer` | `19` |
| Writers Collections | `writer` | `20` |
## Template 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.
@ -42,15 +42,18 @@ Note that the `templates_variables:` section only needs to be used if you do wan
**[Shared Variables](variables) are NOT available to separator collections in any default file.**
| Variable | Description & Values |
|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_separator` | **Description:** Turn the [Separator Collection](#use-separators) off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Choose the [Separator Style](#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `name_separator` | **Description:** Changes the name of the specified key's collection.<br>**Values:** New Collection Name |
| `summary_separator` | **Description:** Changes the summary of the specified key's collection.<br>**Values:** New Collection Summary |
| `collection_section` | **Description:** Changes the sort order of the collection sections against other default collection sections.<br>**Values:** Any number |
| `collection_mode` | **Description:** Controls the collection mode of all collections in a Defaults file.<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`hide`</td><td>Hide Collection</td></tr><tr><td>`hide_items`</td><td>Hide Items in this Collection</td></tr><tr><td>`show_items`</td><td>Show this Collection and its Items</td></tr></table> |
| `url_poster_separator` | **Description:** Changes the poster url of the specified key's collection.<br>**Values:** URL directly to the Image |
| Variable | Description & Values |
|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_separator` | **Description:** Turn the [Separator Collection](#use-separators) off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Choose the [Separator Style](#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `placeholder_tmdb_movie` | **Description:** Add a placeholder Movie to the Separator.<br>**Values:** TMDb Movie ID |
| `placeholder_tvdb_show` | **Description:** Add a placeholder Show to the Separator.<br>**Values:** TVDb Show ID |
| `placeholder_imdb_id` | **Description:** Add a placeholder Movie/Show to the Separator.<br>**Values:** IMDb ID |
| `name_separator` | **Description:** Changes the name of the specified key's collection.<br>**Values:** New Collection Name |
| `summary_separator` | **Description:** Changes the summary of the specified key's collection.<br>**Values:** New Collection Summary |
| `collection_section` | **Description:** Changes the sort order of the collection sections against other default collection sections.<br>**Values:** Any number |
| `collection_mode` | **Description:** Controls the collection mode of all collections in a Defaults file.<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`hide`</td><td>Hide Collection</td></tr><tr><td>`hide_items`</td><td>Hide Items in this Collection</td></tr><tr><td>`show_items`</td><td>Show this Collection and its Items</td></tr></table> |
| `url_poster_separator` | **Description:** Changes the poster url of the specified key's collection.<br>**Values:** URL directly to the Image |
## Use Separators

4
docs/defaults/show/content_rating_us.md
View file

@ -35,10 +35,10 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
| Variable | Description & Values |
|:-------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `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 |
| `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) |

4
docs/defaults/show/country.md
View file

@ -39,10 +39,10 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
| Variable | Description & Values |
|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `style` | **Description:** Controls the visual theme of the collections created<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>white</code></td><td>White Theme</td></tr><tr><td><code>color</code></td><td>Color Theme</td></tr></table> |
| `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 |

4
docs/defaults/show/decade.md
View file

@ -32,10 +32,10 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
| Variable | Description & Values |
|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `100`<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:** `critic_rating.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |

4
docs/defaults/show/network.md
View file

@ -32,10 +32,10 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
| Variable | Description & Values |
|:------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_separator` | **Description:** Turn the [Separator Collection](../separators) off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Choose the [Separator Style](../separators.md#separator-styles).<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `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 |
| `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) |

2
docs/defaults/variables.md
View file

@ -41,4 +41,4 @@ Below are the available variables which can be used to customize the file.
| `item_sonarr_tag` | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags |
| `item_sonarr_tag_<<key>>`<sup>1</sup> | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr of the specified key's collection.<br>**Default:** `item_sonarr_tag`<br>**Values:** List or comma-separated string of tags |
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.

257
docs/home/guides/yaml.md Normal file
View file

@ -0,0 +1,257 @@
# YAML Tutorial
All of Plex Meta Manager's Config, Metadata, Overlay, and Playlist Files are written in the YAML data structure.
This tutorial will help you understand the specific parts of the files.
## Example YAML File We're working with
```yaml
libraries:
Movies:
metadata_path:
- pmm: basic
- pmm: imdb
overlay_path:
- pmm: ribbon
template_variables:
use_metacritic: false
use_common: false
TV Shows:
metadata_path:
- pmm: basic
- pmm: imdb
overlay_path:
- pmm: ribbon
settings:
cache: true
cache_expiration: 60
asset_directory:
- config/movie assets
- config/tv assets
```
## Basic YAML Syntax
A YAML format primarily uses 3 node types:
1. Dictionaries/Mappings:
The content of a mapping node is an unordered set of key/value node pairs, with the restriction that each of the keys is unique. YAML places no further restrictions on the nodes.
2. Lists/Arrays:
The content of a list node is an ordered series of zero or more nodes. In particular, a sequence may contain the same node more than once. It could even contain itself.
3. Literals (Strings, numbers, boolean, etc.):
The content of a scalar node is an opaque datum that can be presented as a series of zero or more Unicode characters.
Let us try and identify where these appear in the sample YAML file we saw earlier.
```yaml
# Strats with a top level Dictionary with keys `libraries` and `settings`
libraries: # Value is a Dictionary with keys `Movies` and `TV Shows`
Movies: # Value is a Dictionary with keys `metadata_path` and `overlay_path`
metadata_path: # Value is a List with two Items
- pmm: basic # List Item is a Dictionary with one key pair whose value is a String Literal
- pmm: imdb # List Item is a Dictionary with one key pair whose value is a String Literal
overlay_path: # Value is a List with one Item
- pmm: ribbon # List Item is a Dictionary with keys `pmm` and `template_variables` with `pmm`'s value a String Literal
template_variables: # Value is a Dictionary with keys `use_metacritic` and `use_common`
use_metacritic: false # Value is a Boolean Literal
use_common: false # Value is a Boolean Literal
TV Shows: # Value is a Dictionary with keys `metadata_path` and `overlay_path`
metadata_path: # Value is a List with two Items
- pmm: basic # List Item is a Dictionary with one key pair whose value is a String Literal
- pmm: imdb # List Item is a Dictionary with one key pair whose value is a String Literal
overlay_path: # Value is a List with one Item
- pmm: ribbon # List Item is a Dictionary with one key pair whose value is a String Literal
settings: # Value is a Dictionary with keys `cache` and `cache_expiration`
cache: true # Value is a Boolean Literal
cache_expiration: 60 # Value is a Number Literal
asset_directory: # Value is a List with two Items
- config/movie assets # List Item is a String Literal
- config/tv assets # List Item is a String Literal
```
## Indentation
A YAML file relies on whitespace and indentation to indicate nesting. The number of spaces used for indentation doesn’t matter as long as they are consistent.
**It is critical to note that tab characters cannot be used for indentation in YAML files; only spaces can be used.**
```yaml
libraries: # Nesting Level 1
Movies: # Nesting Level 2
metadata_path: # Nesting Level 3
- pmm: basic # Nesting Level 4
- pmm: imdb # Nesting Level 4
overlay_path: # Nesting Level 3
- pmm: ribbon # Nesting Level 4
template_variables: # Nesting Level 5
use_metacritic: false # Nesting Level 6
use_common: false # Nesting Level 6
TV Shows: # Nesting Level 2
metadata_path: # Nesting Level 3
- pmm: basic # Nesting Level 4
- pmm: imdb # Nesting Level 4
overlay_path: # Nesting Level 3
- pmm: ribbon # Nesting Level 4
settings: # Nesting Level 1
cache: true # Nesting Level 2
cache_expiration: 60 # Nesting Level 2
```
## Dictionaries
Dictionaries are used to associate key/value pairs that are unordered. Dictionaries can be nested by increasing the indentation, or new dictionaries can be created at the same level by resolving the previous one.
```yaml
cache: true
cache_expiration: 60
```
The "keys" are `cache` and `cache_expiration` and the "values" are `true` and `60` respectively.
### In-Line Dictionaries
you can represent a dictionary on a single line by using `{` and `}`
```yaml
settings:
cache: true
cache_expiration: 60
```
is equivalent to
```yaml
settings: {cache: true, cache_expiration: 60}
```
## Lists
Lists in YAML are represented by using the hyphen (-) and space. They are ordered and can be embedded inside a map using indentation.
```yaml
asset_directory:
- config/movie assets
- config/tv assets
```
The first item in the list is `config/movie assets` and the second is `config/tv assets`.
### In-Line Lists
you can represent a dictionary on a single line by using `{` and `}`
```yaml
settings:
asset_directory:
- config/movie assets
- config/tv assets
```
is equivalent to
```yaml
settings:
asset_directory: [config/movie assets, config/tv assets]
```
## Literals
Literals can come in multiple types:
* String: any sequence of characters
* Number: any representation of a number
* Boolean: `true` or `false`
### String Literals
The string literals do not require to be quoted. It is only important to quote them when they contain a value that can be mistaken as a special character.
Here is an example where the string has to be quoted as `&` and `:` are special characters.
YAML Special Characters: `{`, `}`, `[`, `]`, `,`, `&`, `:`, `*`, `#`, `?`, `|`. `-`, `<`. `>`, `=`, `!`, `%`, `@`, `\`
There are many occurrences of these special characters where quotes are not needed but if the YAML fails to load it could easily be because one of these are unquoted.
```yaml
message1: YAML & JSON # breaks as a & is a special character
message2: "YAML & JSON" # Works as the string is quoted
message3: YAML: Let's Get Started # breaks as a : is a special character
message4: "YAML: Let's Get Started" # Works as the string is quoted
```
#### Multiline Strings
Strings can be interpreted as multiline using the pipe (`|`) character.
```yaml
message: |
this is
a real multiline
message
```
This would be read as `this is\na real multiline\nmessage`
## Comments
YAML file also supports comments, unlike JSON. A comment starts with #.
```yaml
# Strats with a top level Dictionary with keys `libraries` and `settings`
libraries: # Value is a Dictionary with keys `Movies` and `TV Shows`
```
Everything after `#` on a line is ignored.
## Anchors and Alias
With a lot of configuration, configuration files can become quite large.
In YAML files, anchors (`&`) and aliases (`*`) are used to avoid duplication. When writing large configurations in YAML, it is common for a specific configuration to be repeated. For example, the vars config is repeated for all three services in the following YAML snippet.
```yaml
libraries:
Movies:
metadata_path:
- pmm: basic
- pmm: imdb
overlay_path:
- pmm: ribbon
template_variables:
use_metacritic: false
use_common: false
TV Shows:
metadata_path:
- pmm: basic
- pmm: imdb
overlay_path:
- pmm: ribbon
```
As more and more things are repeated for large configuration files, this becomes tedious.
Anchors and aliases allow us to rewrite the same snippet without having to repeat any configuration.
Anchors (`&`) are used to define a chunk of configuration, and aliases (`*`) are used to refer to that chunk at a different part of the configuration.
```yaml
libraries:
Movies:
metadata_path: &metadata_path # Anchor called metadata_path
- pmm: basic
- pmm: imdb
overlay_path:
- pmm: ribbon
template_variables:
use_metacritic: false
use_common: false
TV Shows:
metadata_path: *metadata_path # Alias to call the above section
overlay_path:
- pmm: ribbon
```

24
docs/metadata/builders.md Normal file
View file

@ -0,0 +1,24 @@
# Builders
Builders use third-party services to source items to be added to the collection. Multiple builders can be used in the same collection from a variety of sources listed below.
| Name | Description | Requires Config |
|:--------------------------------------|:----------------------------------------------------------------------------------------------|:---------------:|
| [Plex](builders/plex) | Grabs items based on the metadata inside your Plex Server. | &#10060; |
| [Smart](builders/smart) | Creates Smart Collections based on the metadata inside your Plex Server. (Collections Only) | &#10060; |
| [TMDb](builders/tmdb) | Grabs items based on metadata and lists on [TheMovieDb.org](https://www.themoviedb.org/). | &#10060; |
| [TVDb](builders/tvdb) | Grabs items based on metadata and lists on [TheTVDb.com](https://www.thetvdb.com/). | &#9989; |
| [IMDb](builders/imdb) | Grabs items based on metadata and lists on [IMDb.com](https://www.imdb.com/). | &#9989; |
| [Trakt](builders/trakt) | Grabs items based on metadata and lists on [Trakt.tv](https://trakt.tv/). | &#10060; |
| [Tautulli](builders/tautulli) | Grabs items based on metadata and lists in your [Tautulli](https://tautulli.com/). | &#10060; |
| [Radarr](builders/radarr) | Grabs items based on metadata and lists in your [Radarr](https://radarr.video/) . | &#10060; |
| [Sonarr](builders/sonarr) | Grabs items based on metadata and lists in your [Sonarr](https://sonarr.tv/). | &#10060; |
| [MdbList](builders/mdblist) | Grabs items based on metadata and lists on [MdbList.com](https://mdblist.com/). | &#9989; |
| [Letterboxd](builders/letterboxd) | Grabs items based on metadata and lists on [Letterboxd.com](https://letterboxd.com/). | &#9989; |
| [ICheckMovies](builders/icheckmovies) | Grabs items based on metadata and lists on [ICheckMovies.com](https://www.icheckmovies.com/). | &#9989; |
| [FlixPatrol](builders/flixpatrol) | Grabs items based on metadata and lists on [FlixPatrol.com](https://flixpatrol.com/). | &#9989; |
| [Reciperr](builders/reciperr) | Grabs items based on metadata and lists on [reciperr.com](https://reciperr.com/). | &#9989; |
| [StevenLu](builders/stevenlu) | Grabs items based on metadata and lists on [StevenLu.com](https://movies.stevenlu.com/). | &#9989; |
| [AniDB](builders/anidb) | Grabs items based on metadata and lists on [AniDB.net](https://anidb.net/). | &#9989; |
| [AniList](builders/anilist) | Grabs items based on metadata and lists on [AniList.co](https://anilist.co/). | &#9989; |
| [MyAnimeList](builders/myanimelist) | Grabs items based on metadata and lists on [MyAnimeList.net](https://myanimelist.net/). | &#10060; |

2
docs/metadata/builders/icheckmovies.md
View file

@ -1,6 +1,6 @@
# ICheckMovies Builders
You can find items using the lists on [icheckmovies.com](https://www.icheckmovies.com/) (ICheckMovies).
You can find items using the lists on [ICheckMovies.com](https://www.icheckmovies.com/) (ICheckMovies).
No configuration is required for these builders.

6
docs/metadata/details/arr.md
View file

@ -1,6 +1,6 @@
# Radarr/Sonarr Details
# Radarr/Sonarr Definition Settings
## Radarr Details
## Radarr Definition Settings
All the following attributes can override the global/library [Radarr](../../config/radarr) attributes which are the default unless otherwise specified.
@ -19,7 +19,7 @@ All the following attributes can override the global/library [Radarr](../../conf
| `item_radarr_tag.remove` | **Description:** Used to remove existing tags in Radarr for every movie found by the builders that's in Radarr<br>**Values:** List or comma-separated string of tags |
| `item_radarr_tag.sync` | **Description:** Matches the tags in Radarr for every movie found by the builders that's in Radarr with the provided tags<br>**Values:** List or comma-separated string of tags |
## Sonarr Details
## Sonarr Definition Settings
All the following attributes can override the global/library [Sonarr](../../config/sonarr) attributes which are the default unless otherwise specified.

66
docs/metadata/details/setting.md → docs/metadata/details/definition.md
View file

@ -1,35 +1,35 @@
# Setting Details
# Definition Settings
All the following attributes serve various functions as how the collection/playlist functions inside of Plex Meta Manager.
All the following attributes serve various functions as how the definition functions inside of Plex Meta Manager.
| Attribute | Description & Values |
|:-----------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `name` | **Description:** Used to specify the name of the collection/playlist in Plex as different than the mapping name.<br>**Values:** Any String |
| `limit` | **Description:** Used to specify the max number of items for the collection/playlist<br>**Values:** Number greater than 0 |
| `template` | **Description:** Used to specify a template and template variables to use for this collection/playlist. See the [Templates Page](../templates) for more information.<br>**Values:** Dictionary |
| `run_again` | **Description:** Used to try and add all the missing items to the collection/playlist again after the daily run.<br>**Default:** `false`<br>**Values:** `true` or `false` |
| `sync_mode` | **Description:** Used to change how builders sync with this collection/playlist.<br>**Default:** `sync_mode` [settings value](../../config/settings) in the Configuration File<br>**Values:**<table class="clearTable"><tr><td>`append`</td><td>Only Add Items to the Collection</td></tr><tr><td>`sync`</td><td>Add & Remove Items from the Collection</td></tr></table> |
| `minimum_items` | **Description:** Minimum items that must be found to add to a collection/playlist.<br>**Default:** `minimum_items` [settings value](../../config/settings) in the Configuration File<br>**Values:** number greater than 0 |
| `delete_below_minimum` | **Description:** Deletes the collection/playlist if below the minimum.<br>**Default:** `delete_below_minimum` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
| `delete_not_scheduled` | **Description:** Deletes the collection/playlist if its skipped because its not scheduled.<br>**Default:** `delete_not_scheduled` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
| `tmdb_region` | **Description:** Sets the region for `tmdb_popular`, `tmdb_now_playing`, `tmdb_top_rated`, and `tmdb_upcoming` |
| `validate_builders` | **Description:** When set to false the collection/playlist will not fail if one builder fails.<br>**Default:** `true`<br>**Values:** `true` or `false` |
| `cache_builders` | **Description:** Caches the items found by the builders for a number of days. This is useful if you run the same configuration on multiple libraries/servers in one run just set the value to `1`.<br>**Default:** `0` <br>**Values:** number 0 or greater |
| `blank_collection` | **Description:** When set to true the collection will be created with no builders and no items added.<br>**Default:** `false`<br>**Values:** `true` or `false` |
| `build_collection` | **Description:** When set to false the collection won't be created but items can still be added to Radarr/Sonarr. Does not work for playlists.<br>**Default:** `true`<br>**Values:** `true` or `false` |
| `server_preroll` | **Description:** Used to set the `Movie pre-roll video` Text box in Plex under Settings -> Extras.<br>You can run this with a [schedule](schedule) to change the pre-rolls automatically.<br>**Values:** Any String |
| `missing_only_released` | **Description:** Collection/Playlist Level `missing_only_released` toggle.<br>**Default:** `missing_only_released` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
| `only_filter_missing` | **Description:** Collection/Playlist Level `only_filter_missing` toggle.<br>**Default:** `only_filter_missing` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
| `show_filtered` | **Description:** Collection/Playlist level `show_filtered` toggle.<br>**Default:** `show_filtered` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
| `show_missing` | **Description:** Collection/Playlist level `show_missing` toggle.<br>**Default:** `show_missing` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
| `save_report` | **Description:** Collection/Playlist level `save_report` toggle.<br>**Default:** `save_report` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
| `ignore_ids` | **Description:** Collection/Playlist level `ignore_ids` which is combined with the library and global `ignore_ids`.<br>**Default:** `ignore_ids` [settings value](../../config/settings) in the Configuration File<br>**Values:** List or comma-separated String of TMDb/TVDb IDs |
| `ignore_imdb_ids` | **Description:** Collection/Playlist level `ignore_imdb_ids` which is combined with the library and global `ignore_imdb_ids`.<br>**Default:** `ignore_imdb_ids` [settings value](../../config/settings) in the Configuration File<br>**Values:** List or comma-separated String of IMDb IDs |
| `name_mapping` | **Description:** Used to specify the folder name in the [Image Assets Directory](../../home/guides/assets) i.e. if your collection/playlist name contains characters that are not allowed in file paths (i.e. for windows `<`, `>`, `:`, `"`, `/`, `\`, `?`, `*` cannot be in the file path), but you want them in your name you can this to specify the name in the file system.<br>**Values:** Any String |
| `test` | **Description:** When running in Test Mode (`--run-tests` [option](../../home/environmental)) only collections/playlists with `test: true` will be run.<br>**Default:** `false`<br>**Values:** `true` or `false` |
| `changes_webhooks` | **Description:** Used to specify a collection/playlist changes webhook for just this collection/playlist.<br>**Values:** List of webhooks |
| `sync_to_trakt_list` | **Description:** Used to specify a trakt list you want the collection/playlist synced to.<br>**Values:** Trakt List Slug you want to sync to |
| `sync_missing_to_trakt_list` | **Description:** Used to also sync missing items to the Trakt List specified by `sync_to_trakt_list`.<br>**Default:** `false`<br>**Values:** `true` or `false` |
| `allowed_library_types` | **Description:** Used to specify the types of libraries that this definition can work with.<br>Multiple can be used for one definition as a list or comma separated string. One `false` will cause it to fail.<br>**Values:** `movie`, `show`, `artist`, `true`, `false` |
| `default_percent` | **Description:** Used to declare the default percent for `episodes`, `seasons`, `tracks`, and `albums` [special filters](../filters.md#special-filters). Default is 50.<br>**Values:** Integer between 1 and 100 |
| `ignore_blank_results` | **Description:** Used to not have Errors resulting from blank results from builders<br>**Default:** `false`<br>**Values:** `true` or `false` |
| Attribute | Description & Values |
|:-----------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `name` | **Description:** Used to specify the name of the definition in Plex as different than the mapping name.<br>**Values:** Any String |
| `limit` | **Description:** Used to specify the max number of items for the definition<br>**Values:** Number greater than 0 |
| `template` | **Description:** Used to specify a template and template variables to use for this definition. See the [Templates Page](../templates) for more information.<br>**Values:** Dictionary |
| `run_again` | **Description:** Used to try and add all the missing items to the definition again after the daily run.<br>**Default:** `false`<br>**Values:** `true` or `false` |
| `sync_mode` | **Description:** Used to change how builders sync with this definition.<br>**Default:** `sync_mode` [settings value](../../config/settings) in the Configuration File<br>**Values:**<table class="clearTable"><tr><td>`append`</td><td>Only Add Items to the Collection</td></tr><tr><td>`sync`</td><td>Add & Remove Items from the Collection</td></tr></table> |
| `minimum_items` | **Description:** Minimum items that must be found to add to a definition.<br>**Default:** `minimum_items` [settings value](../../config/settings) in the Configuration File<br>**Values:** number greater than 0 |
| `delete_below_minimum` | **Description:** Deletes the definition if below the minimum.<br>**Default:** `delete_below_minimum` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
| `delete_not_scheduled` | **Description:** Deletes the definition if its skipped because its not scheduled.<br>**Default:** `delete_not_scheduled` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
| `tmdb_region` | **Description:** Sets the region for `tmdb_popular`, `tmdb_now_playing`, `tmdb_top_rated`, and `tmdb_upcoming` |
| `validate_builders` | **Description:** When set to false the definition will not fail if one builder fails.<br>**Default:** `true`<br>**Values:** `true` or `false` |
| `cache_builders` | **Description:** Caches the items found by the builders for a number of days. This is useful if you run the same configuration on multiple libraries/servers in one run just set the value to `1`.<br>**Default:** `0` <br>**Values:** number 0 or greater |
| `blank_collection` | **Description:** When set to true the collection will be created with no builders and no items added.<br>**Default:** `false`<br>**Values:** `true` or `false` |
| `build_collection` | **Description:** When set to false the collection won't be created but items can still be added to Radarr/Sonarr. Does not work for playlists.<br>**Default:** `true`<br>**Values:** `true` or `false` |
| `server_preroll` | **Description:** Used to set the `Movie pre-roll video` Text box in Plex under Settings -> Extras.<br>You can run this with a [schedule](schedule) to change the pre-rolls automatically.<br>**Values:** Any String |
| `missing_only_released` | **Description:** definition Level `missing_only_released` toggle.<br>**Default:** `missing_only_released` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
| `only_filter_missing` | **Description:** definition Level `only_filter_missing` toggle.<br>**Default:** `only_filter_missing` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
| `show_filtered` | **Description:** definition level `show_filtered` toggle.<br>**Default:** `show_filtered` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
| `show_missing` | **Description:** definition level `show_missing` toggle.<br>**Default:** `show_missing` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
| `save_report` | **Description:** definition level `save_report` toggle.<br>**Default:** `save_report` [settings value](../../config/settings) in the Configuration File<br>**Values:** `true` or `false` |
| `ignore_ids` | **Description:** definition level `ignore_ids` which is combined with the library and global `ignore_ids`.<br>**Default:** `ignore_ids` [settings value](../../config/settings) in the Configuration File<br>**Values:** List or comma-separated String of TMDb/TVDb IDs |
| `ignore_imdb_ids` | **Description:** definition level `ignore_imdb_ids` which is combined with the library and global `ignore_imdb_ids`.<br>**Default:** `ignore_imdb_ids` [settings value](../../config/settings) in the Configuration File<br>**Values:** List or comma-separated String of IMDb IDs |
| `name_mapping` | **Description:** Used to specify the folder name in the [Image Assets Directory](../../home/guides/assets) i.e. if your definition name contains characters that are not allowed in file paths (i.e. for windows `<`, `>`, `:`, `"`, `/`, `\`, `?`, `*` cannot be in the file path), but you want them in your name you can this to specify the name in the file system.<br>**Values:** Any String |
| `test` | **Description:** When running in Test Mode (`--run-tests` [option](../../home/environmental)) only definitions with `test: true` will be run.<br>**Default:** `false`<br>**Values:** `true` or `false` |
| `changes_webhooks` | **Description:** Used to specify a definition changes webhook for just this definition.<br>**Values:** List of webhooks |
| `sync_to_trakt_list` | **Description:** Used to specify a trakt list you want the definition synced to.<br>**Values:** Trakt List Slug you want to sync to |
| `sync_missing_to_trakt_list` | **Description:** Used to also sync missing items to the Trakt List specified by `sync_to_trakt_list`.<br>**Default:** `false`<br>**Values:** `true` or `false` |
| `allowed_library_types` | **Description:** Used to specify the types of libraries that this definition can work with.<br>Multiple can be used for one definition as a list or comma separated string. One `false` will cause it to fail.<br>**Values:** `movie`, `show`, `artist`, `true`, `false` |
| `default_percent` | **Description:** Used to declare the default percent for `episodes`, `seasons`, `tracks`, and `albums` [special filters](../filters.md#special-filters). Default is 50.<br>**Values:** Integer between 1 and 100 |
| `ignore_blank_results` | **Description:** Used to not have Errors resulting from blank results from builders<br>**Default:** `false`<br>**Values:** `true` or `false` |

34
docs/metadata/details/item_metadata.md Normal file
View file

@ -0,0 +1,34 @@
# Item Metadata Updates
All the following attributes update various details of the metadata for every item in the collection.
**None of these updates work with Playlists or Overlays.**
| Attribute | Description & Values |
|:--------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `item_label` | **Description:** Appends new labels to every movie/show in the collection<br>**Values:** Comma-separated string of labels to append |
| `item_label.remove` | **Description:** Removes existing labels from every movie/show in the collection<br>**Values:** Comma-separated string of labels to remove |
| `item_label.sync` | **Description:** Matches the labels of every movie/show in the collection to the labels provided (Leave blank to remove all labels)<br>**Values:** Comma-separated string of labels to sync |
| `item_genre` | **Description:** Appends new genres to every movie/show in the collection<br>**Values:** Comma-separated string of genres to append |
| `item_genre.remove` | **Description:** Removes existing genres from every movie/show in the collection<br>**Values:** Comma-separated string of genres to remove |
| `item_genre.sync` | **Description:** Matches the genres of every movie/show in the collection to the genres provided (Leave blank to remove all genres)<br>**Values:** Comma-separated string of genres to sync |
| `item_edition` | **Description:** Replaced the edition of every movie in the collection<br>**Values:** Edition Name |
| `non_item_remove_label` | **Description:** Matches every movie/show that has the given label and is not in the collection and removes the label<br>**Values:** Comma-separated string of labels to remove |
| `item_lock_poster` | **Description:** Locks/Unlocks the poster of every movie/show in the collection<br>**Default:** `None`<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Lock</td></tr><tr><td>`false`</td><td>Unlock</td></tr></table> |
| `item_lock_background` | **Description:** Locks/Unlocks the background of every movie/show in the collection<br>**Default:** `None`<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Lock</td></tr><tr><td>`false`</td><td>Unlock</td></tr></table> |
| `item_lock_title` | **Description:** Locks/Unlocks the title of every movie/show in the collection<br>**Default:** `None`<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Lock</td></tr><tr><td>`false`</td><td>Unlock</td></tr></table> |
| `item_assets` | **Description:** Checks your assets folders for assets of every movie/show in the collection<br>**Default:** `false`<br>**Values:** `true` or `false` |
| `item_refresh` | **Description:** Refreshes the metadata of every movie/show in the collection<br>**Default:** `false`<br>**Values:** `true` or `false` |
| `item_refresh_delay` | **Description:** Amount of time to wait between each `item_refresh` of every movie/show in the collection<br>**Default:** `0`<br>**Values:** Number greater than `0` |
| `item_tmdb_season_titles` | **Description:** Changes the season titles of every show in the collection to match TMDb<br>**Default:** `false`<br>**Values:** `true` or `false` |
| `item_episode_sorting`<sup>1</sup> | **Description:** Changes the episode sorting of every show in the collection<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`oldest`</td><td>Oldest first</td></tr><tr><td>`newest`</td><td>Newest first</td></tr></table> |
| `item_keep_episodes`<sup>1</sup> | **Description:** Changes the keep episodes of every show in the collection<br>**Values:**<table class="clearTable"><tr><td>`all`</td><td>All episodes</td></tr><tr><td>`5_latest`</td><td>5 latest episodes</td></tr><tr><td>`3_latest`</td><td>3 latest episodes</td></tr><tr><td>`latest`</td><td>Latest episodes</td></tr><tr><td>`past_3`</td><td>Episodes added in the past 3 days</td></tr><tr><td>`past_7`</td><td>Episodes added in the past 7 days</td></tr><tr><td>`past_30`</td><td>Episodes added in the past 30 days</td></tr></table> |
| `item_delete_episodes`<sup>1</sup> | **Description:** Changes the delete episodes of every show in the collection<br>**Values:**<table class="clearTable"><tr><td>`never`</td><td>Never</td></tr><tr><td>`day`</td><td>After a day</td></tr><tr><td>`week`</td><td>After a week</td></tr><tr><td>`refresh`</td><td>On next refresh</td></tr></table> |
| `item_season_display`<sup>1</sup> | **Description:** Changes the season display of every show in the collection<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`show`</td><td>Show</td></tr><tr><td>`hide`</td><td>Hide</td></tr></table> |
| `item_episode_ordering`<sup>1</sup> | **Description:** Changes the episode ordering of every show in the collection<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`tmdb_aired`</td><td>The Movie Database (Aired)</td></tr><tr><td>`tvdb_aired`</td><td>TheTVDb (Aired)</td></tr><tr><td>`tvdb_dvd`</td><td>TheTVDb (DVD)</td></tr><tr><td>`tvdb_absolute`</td><td>TheTVDb (Absolute)</td></tr></table> |
| `item_metadata_language`<sup>2</sup> | **Description:** Changes the metadata language of every movie/show in the collection<br>**Values:** `default`, `ar-SA`, `ca-ES`, `cs-CZ`, `da-DK`, `de-DE`, `el-GR`, `en-AU`, `en-CA`, `en-GB`, `en-US`, `es-ES`, `es-MX`, `et-EE`, `fa-IR`, `fi-FI`, `fr-CA`, `fr-FR`, `he-IL`, `hi-IN`, `hu-HU`, `id-ID`, `it-IT`, `ja-JP`, `ko-KR`, `lt-LT`, `lv-LV`, `nb-NO`, `nl-NL`, `pl-PL`, `pt-BR`, `pt-PT`, `ro-RO`, `ru-RU`, `sk-SK`, `sv-SE`, `th-TH`, `tr-TR`, `uk-UA`, `vi-VN`, `zh-CN`, `zh-HK`, `zh-TW` |
| `item_use_original_title`<sup>2</sup> | **Description:** Changes the use original title of every movie/show in the collection<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`no`</td><td>No</td></tr><tr><td>`yes`</td><td>Yes</td></tr></table> |
<sup>1</sup> Only works with TV Show Libraries
<sup>2</sup> Must be using the **New Plex Movie Agent** or the **New Plex TV Agent**

55
docs/metadata/details/metadata.md
View file

@ -1,10 +1,8 @@
# Metadata Details
# Collection/Playlist Metadata Updates
## Collection/Playlist Metadata Details
All the following attributes update various details of the definition's Metadata.
All the following attributes update various details of the collection/playlist's Metadata.
Only `tmdb_person` works with Playlists.
**Only `tmdb_person` works with Playlists.**
| Attribute | Description & Values |
|:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@ -30,46 +28,11 @@ Only `tmdb_person` works with Playlists.
![Display](display.png)
## Item Metadata Details
All the following attributes update various details of the metadata for every item in the collection.
None of these details work with Playlists.
| Attribute | Description & Values |
|:--------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `item_label` | **Description:** Appends new labels to every movie/show in the collection<br>**Values:** Comma-separated string of labels to append |
| `item_label.remove` | **Description:** Removes existing labels from every movie/show in the collection<br>**Values:** Comma-separated string of labels to remove |
| `item_label.sync` | **Description:** Matches the labels of every movie/show in the collection to the labels provided (Leave blank to remove all labels)<br>**Values:** Comma-separated string of labels to sync |
| `item_genre` | **Description:** Appends new genres to every movie/show in the collection<br>**Values:** Comma-separated string of genres to append |
| `item_genre.remove` | **Description:** Removes existing genres from every movie/show in the collection<br>**Values:** Comma-separated string of genres to remove |
| `item_genre.sync` | **Description:** Matches the genres of every movie/show in the collection to the genres provided (Leave blank to remove all genres)<br>**Values:** Comma-separated string of genres to sync |
| `item_edition` | **Description:** Replaced the edition of every movie in the collection<br>**Values:** Edition Name |
| `non_item_remove_label` | **Description:** Matches every movie/show that has the given label and is not in the collection and removes the label<br>**Values:** Comma-separated string of labels to remove |
| `item_lock_poster` | **Description:** Locks/Unlocks the poster of every movie/show in the collection<br>**Default:** `None`<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Lock</td></tr><tr><td>`false`</td><td>Unlock</td></tr></table> |
| `item_lock_background` | **Description:** Locks/Unlocks the background of every movie/show in the collection<br>**Default:** `None`<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Lock</td></tr><tr><td>`false`</td><td>Unlock</td></tr></table> |
| `item_lock_title` | **Description:** Locks/Unlocks the title of every movie/show in the collection<br>**Default:** `None`<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Lock</td></tr><tr><td>`false`</td><td>Unlock</td></tr></table> |
| `item_assets` | **Description:** Checks your assets folders for assets of every movie/show in the collection<br>**Default:** `false`<br>**Values:** `true` or `false` |
| `item_refresh` | **Description:** Refreshes the metadata of every movie/show in the collection<br>**Default:** `false`<br>**Values:** `true` or `false` |
| `item_refresh_delay` | **Description:** Amount of time to wait between each `item_refresh` of every movie/show in the collection<br>**Default:** `0`<br>**Values:** Number greater than `0` |
| `item_tmdb_season_titles` | **Description:** Changes the season titles of every show in the collection to match TMDb<br>**Default:** `false`<br>**Values:** `true` or `false` |
| `item_episode_sorting`<sup>1</sup> | **Description:** Changes the episode sorting of every show in the collection<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`oldest`</td><td>Oldest first</td></tr><tr><td>`newest`</td><td>Newest first</td></tr></table> |
| `item_keep_episodes`<sup>1</sup> | **Description:** Changes the keep episodes of every show in the collection<br>**Values:**<table class="clearTable"><tr><td>`all`</td><td>All episodes</td></tr><tr><td>`5_latest`</td><td>5 latest episodes</td></tr><tr><td>`3_latest`</td><td>3 latest episodes</td></tr><tr><td>`latest`</td><td>Latest episodes</td></tr><tr><td>`past_3`</td><td>Episodes added in the past 3 days</td></tr><tr><td>`past_7`</td><td>Episodes added in the past 7 days</td></tr><tr><td>`past_30`</td><td>Episodes added in the past 30 days</td></tr></table> |
| `item_delete_episodes`<sup>1</sup> | **Description:** Changes the delete episodes of every show in the collection<br>**Values:**<table class="clearTable"><tr><td>`never`</td><td>Never</td></tr><tr><td>`day`</td><td>After a day</td></tr><tr><td>`week`</td><td>After a week</td></tr><tr><td>`refresh`</td><td>On next refresh</td></tr></table> |
| `item_season_display`<sup>1</sup> | **Description:** Changes the season display of every show in the collection<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`show`</td><td>Show</td></tr><tr><td>`hide`</td><td>Hide</td></tr></table> |
| `item_episode_ordering`<sup>1</sup> | **Description:** Changes the episode ordering of every show in the collection<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`tmdb_aired`</td><td>The Movie Database (Aired)</td></tr><tr><td>`tvdb_aired`</td><td>TheTVDb (Aired)</td></tr><tr><td>`tvdb_dvd`</td><td>TheTVDb (DVD)</td></tr><tr><td>`tvdb_absolute`</td><td>TheTVDb (Absolute)</td></tr></table> |
| `item_metadata_language`<sup>2</sup> | **Description:** Changes the metadata language of every movie/show in the collection<br>**Values:** `default`, `ar-SA`, `ca-ES`, `cs-CZ`, `da-DK`, `de-DE`, `el-GR`, `en-AU`, `en-CA`, `en-GB`, `en-US`, `es-ES`, `es-MX`, `et-EE`, `fa-IR`, `fi-FI`, `fr-CA`, `fr-FR`, `he-IL`, `hi-IN`, `hu-HU`, `id-ID`, `it-IT`, `ja-JP`, `ko-KR`, `lt-LT`, `lv-LV`, `nb-NO`, `nl-NL`, `pl-PL`, `pt-BR`, `pt-PT`, `ro-RO`, `ru-RU`, `sk-SK`, `sv-SE`, `th-TH`, `tr-TR`, `uk-UA`, `vi-VN`, `zh-CN`, `zh-HK`, `zh-TW` |
| `item_use_original_title`<sup>2</sup> | **Description:** Changes the use original title of every movie/show in the collection<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`no`</td><td>No</td></tr><tr><td>`yes`</td><td>Yes</td></tr></table> |
<sup>1</sup> Only works with TV Show Libraries
<sup>2</sup> Must be using the **New Plex Movie Agent** or the **New Plex TV Agent**
## Summary Details
## Summary Collection/Playlist Metadata Updates
All the following attributes update the summary of the collection/playlist from various sources.
All of these details work with Playlists.
**All of these details work with Playlists.**
| Attribute | Description & Values |
|:-------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@ -82,11 +45,11 @@ All of these details work with Playlists.
| `trakt_description` | **Description:** Changes summary to the Trakt List Description<br>**Values:** Trakt List URL |
| `letterboxd_description` | **Description:** Changes summary to the Letterboxd List Description<br>**Values:** Letterboxd List URL |
## Poster Details
## Poster Collection/Playlist Metadata Updates
All the following attributes update the poster of the collection/playlist from various sources.
All of these details work with Playlists.
**All of these details work with Playlists.**
If no poster is specified the script will look in the library's [Image Asset Directories](../../home/guides/assets) for a folder named either the collection/playlist name or the `name_mapping` if specified and look for a `poster.ext` file in that folder (replacing .ext with the image extension).
@ -99,11 +62,11 @@ If no poster is specified the script will look in the library's [Image Asset Dir
| `tvdb_poster` | **Description:** Changes poster to the TVDb Movie poster for a movie library or the TVDb Show poster for a show library<br>**Values:** TVDb Movie/Show ID or URL |
| `file_poster` | **Description:** Changes poster to the image in the file system<br>**Values:** Path to image in the file system |
## Background Details
## Background Collection/Playlist Metadata Updates
All the following attributes update the background of the collection/playlist from various sources.
All of these details work with Playlists.
**All of these details work with Playlists.**
If no background is specified the script will look in the library's [Image Asset Directories](../../home/guides/assets) for a folder named either the collection/playlist name or the `name_mapping` if specified and look for a `background.ext` file in that folder (replacing .ext with the image extension).

2
docs/metadata/details/schedule.md
View file

@ -1,4 +1,4 @@
# Schedule Detail
# Schedule Setting
The script is designed to run continuously and certain attributes can be scheduled using these attributes.

40
docs/metadata/filters.md
View file

@ -1,14 +1,38 @@
# Filters
Filters allow for you to filter every item added to the collection/playlist from every builder using the `filters` attribute.
Filters allow for you to filter every item added to the collection/overlay/playlist from every builder using the `filters` attribute.
You can have multiple filters but an item must match at least one value from **each** filter to be added to a collection/playlist. The values for each must match what Plex has including special characters in order to match.
## Using Filters
All filter options are listed below. To display items filtered out add `show_filtered: true` to the collection.
Filters cannot do anything alone they require the use of at least one [Builder](builders) to function.
You can have multiple filters in each set but an item must match at least one value from **each** filter to not be ignored. The values for each must match what Plex has including special characters in order to match.
```yaml
filters:
genre: Action
country: Germany
```
Anything that doesn't have both the Genre `Action` and the Country `Germany` will be ignored.
Multiple Filter Sets can be given as a list. With multiple sets only one of the sets must pass for the item to not be ignored.
```yaml
filters:
- genre: Action
country: Germany
- genre: Comedy
country: France
```
Anything that doesn't have either both the Genre `Action` and the Country `Germany` or the Genre `Comedy` and the Country `France` will be ignored.
All filter options are listed below. To display items filtered out add `show_filtered: true` to the definition.
You can use the `plex_all: true` builder to filter from your entire library.
**Filters can be very slow. Try to build or narrow your items using [Plex Search](builders/plex.md#plex-search) if possible.**
**Filters can be very slow. Try to build or narrow your items using [Plex Search](builders/plex.md#plex-search) or another [Builder](builders) if possible.**
## String Filters
@ -46,7 +70,7 @@ String filters can take multiple values **only as a list**.
| `audio_codec` | Uses the audio codec tags to match | &#9989; | &#9989;<sup>1</sup> | &#9989;<sup>1</sup> | &#9989; | &#10060; | &#10060; | &#10060; |
| `audio_profile` | Uses the audio profile tags to match | &#9989; | &#9989;<sup>1</sup> | &#9989;<sup>1</sup> | &#9989; | &#10060; | &#10060; | &#10060; |
<sup>1</sup> Filters using the special `episodes`/`tracks` [filter](#special-filters) with the [default percent](details/setting).
<sup>1</sup> Filters using the special `episodes`/`tracks` [filter](#special-filters) with the [default percent](details/definition).
<sup>2</sup> Also filters out missing movies/shows from being added to Radarr/Sonarr. These Values also cannot use the `count` modifiers.
@ -90,7 +114,7 @@ Tag filters can take multiple values as a **list or a comma-separated string**.
| `tmdb_keyword`<sup>2</sup> | Uses the keyword from TMDb to match | &#9989; | &#9989; | &#10060; | &#10060; | &#10060; | &#10060; | &#10060; |
| `origin_country`<sup>2</sup> | Uses TMDb origin country [ISO 3166-1 alpha-2 codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) to match<br>Example: `origin_country: us` | &#10060; | &#9989; | &#10060; | &#10060; | &#10060; | &#10060; | &#10060; |
<sup>1</sup> Filters using the special `episodes` [filter](#special-filters) with the [default percent](details/setting).
<sup>1</sup> Filters using the special `episodes` [filter](#special-filters) with the [default percent](details/definition).
<sup>2</sup> Also filters out missing movies/shows from being added to Radarr/Sonarr. These Values also cannot use the `count` modifiers.
@ -106,7 +130,7 @@ Boolean Filters have no modifiers.
| `has_dolby_vision` | Matches every item that has or does not have a dolby vision | &#9989; | &#9989;<sup>1</sup> | &#9989;<sup>1</sup> | &#9989; | &#10060; | &#10060; | &#10060; |
| `has_overlay` | Matches every item that has or does not have an overlay | &#9989; | &#9989; | &#9989; | &#9989; | &#9989; | &#9989; | &#10060; |
<sup>1</sup> Filters using the special `episodes` [filter](#special-filters) with the [default percent](details/setting).
<sup>1</sup> Filters using the special `episodes` [filter](#special-filters) with the [default percent](details/definition).
## Date Filters
@ -172,7 +196,7 @@ Number filters can **NOT** take multiple values.
| `aspect` | Uses the aspect attribute to match<br>minimum: `0.0` | &#9989; | &#9989;<sup>1</sup> | &#9989;<sup>1</sup> | &#9989; | &#10060; | &#10060; | &#10060; |
| `versions` | Uses the number of versions found to match<br>minimum: `0` | &#9989; | &#9989;<sup>1</sup> | &#9989;<sup>1</sup> | &#9989; | &#9989;<sup>1</sup> | &#9989;<sup>1</sup> | &#9989; |
<sup>1</sup> Filters using the special `episodes` [filter](#special-filters) with the [default percent](details/setting).
<sup>1</sup> Filters using the special `episodes` [filter](#special-filters) with the [default percent](details/definition).
<sup>2</sup> Also filters out missing movies/shows from being added to Radarr/Sonarr.

40
docs/metadata/metadata.md
View file

@ -40,44 +40,10 @@ collections:
# ... builders, details, and filters for this collection
```
There are three types of attributes that can be utilized within a collection:
### Builders
Builders use third-party services to source items to be added to the collection. Multiple builders can be used in the same collection from a variety of sources listed below.
* [Plex Builders](builders/plex)
* [Smart Builders](builders/smart) (Collections Only)
* [TMDb Builders](builders/tmdb)
* [TVDb Builders](builders/tvdb)
* [IMDb Builders](builders/imdb)
* [Trakt Builders](builders/trakt)
* [Tautulli Builders](builders/tautulli)
* [Radarr Builders](builders/radarr)
* [Sonarr Builders](builders/sonarr)
* [MdbList Builders](builders/mdblist)
* [Letterboxd Builders](builders/letterboxd)
* [ICheckMovies Builders](builders/icheckmovies)
* [FlixPatrol Builders](builders/flixpatrol)
* [Reciperr Builders](builders/reciperr)
* [StevenLu Builders](builders/stevenlu)
* [AniDB Builders](builders/anidb)
* [AniList Builders](builders/anilist)
* [MyAnimeList Builders](builders/myanimelist)
### Details
These can alter any aspect of the collection or the media items within them.
* [Setting Details](details/setting)
* [Schedule Detail](details/schedule)
* [Metadata Details](details/metadata)
* [Arr Details](details/arr)
### Filters
These filter media items added to the collection by any of the Builders.
There are multiple types of attributes that can be utilized within a collection:
* [Builders](builders)
* [Settings/Updates](details)
* [Filters](filters)
### Example

41
docs/metadata/overlay.md
View file

@ -36,6 +36,12 @@ overlays:
# ... builders, details, and filters for this overlay
```
There are multiple types of attributes that can be utilized within an overlay:
* [Builders](builders)
* [Settings/Updates](details)
* [Filters](filters)
## Overlay
Each overlay definition needs to specify what overlay to use. This can happen in 3 ways.
@ -405,41 +411,6 @@ overlays:
hdr: true
```
## Builders
Builders use third-party services to source items for overlays. Multiple builders can be used in the same overlay from a variety of sources listed below.
* [Plex Builders](builders/plex)
* [TMDb Builders](builders/tmdb)
* [TVDb Builders](builders/tvdb)
* [IMDb Builders](builders/imdb)
* [Trakt Builders](builders/trakt)
* [Tautulli Builders](builders/tautulli)
* [Radarr Builders](builders/radarr)
* [Sonarr Builders](builders/sonarr)
* [MdbList Builders](builders/mdblist)
* [Letterboxd Builders](builders/letterboxd)
* [ICheckMovies Builders](builders/icheckmovies)
* [FlixPatrol Builders](builders/flixpatrol)
* [Reciperr Builders](builders/reciperr)
* [StevenLu Builders](builders/stevenlu)
* [AniDB Builders](builders/anidb)
* [AniList Builders](builders/anilist)
* [MyAnimeList Builders](builders/myanimelist)
## Details
Only a few details can be used with overlays: `limit`, `show_missing`, `save_report`, `missing_only_released`, `minimum_items`, `cache_builders`, `tmdb_region`
* [Setting Details](details/setting)
* [Metadata Details](details/metadata)
## Filters
These filter media items that would have an overlay applied by any of the Builders.
* [Filters](filters)
## Examples
### Example Overlay File

45
docs/metadata/playlist.md
View file

@ -36,6 +36,12 @@ playlists:
# ... builder, details, and filters for this playlist
```
There are multiple types of attributes that can be utilized within a playlist:
* [Builders](builders)
* [Settings/Updates](details)
* [Filters](filters)
### Special Playlist Attributes
| Attribute | Description | Required |
@ -46,45 +52,6 @@ playlists:
* Any defined playlist will be always be visible by The Plex Media Server owner, so it doesn't need to be defined within `sync_to_users`.
There are three types of attributes that can be utilized within a playlist:
### Builders
Builders use third-party services to source items to be added to the playlist. Multiple builders can be used in the same playlist from a variety of sources listed below.
* [Plex Builders](builders/plex)
* [TMDb Builders](builders/tmdb)
* [TVDb Builders](builders/tvdb)
* [IMDb Builders](builders/imdb)
* [Trakt Builders](builders/trakt)
* [Tautulli Builders](builders/tautulli)
* [Radarr Builders](builders/radarr)
* [Sonarr Builders](builders/sonarr)
* [MdbList Builders](builders/mdblist)
* [Letterboxd Builders](builders/letterboxd)
* [ICheckMovies Builders](builders/icheckmovies)
* [FlixPatrol Builders](builders/flixpatrol)
* [Reciperr Builders](builders/reciperr)
* [StevenLu Builders](builders/stevenlu)
* [AniDB Builders](builders/anidb)
* [AniList Builders](builders/anilist)
* [MyAnimeList Builders](builders/myanimelist)
### Details
These can alter any aspect of the playlist or the media items within them.
* [Setting Details](details/setting)
* [Schedule Detail](details/schedule)
* [Metadata Details](details/metadata)
* [Arr Details](details/arr)
### Filters
These filter media items added to the playlist by any of the Builders.
* [Filters](filters)
## Example
In the following example, media is pulled from the `Movies` and `TV Shows` libraries into the one Playlist, and the playlist is shared with a specific set of users:

10
docs/metadata/templates.md
View file

@ -1,6 +1,6 @@
# Templates
Collections often share a lot of common [or generalizable] configuration details. Templates allow you to define these details so they can be used across multiple collections.
Collection and Overlay Definitions often share a lot of common or generalizable configuration details. Templates allow you to define these details so they can be used across multiple definitions.
For example, an actor collection might look like this:
@ -166,9 +166,13 @@ Each conditional is identified by its mapping name and has one required attribut
Each set of conditions must have the `value` attribute which is the value of the variable if the condition is met.
All other attribute pairs in the set of conditions will check a variable of the attribute key and see if the variable is the attribute value or in the list of attribute values.
All other attribute pairs in the set of conditions will check some condition of the value of the attribute key:
Here's an example from the [PMM default ratings file](https://github.com/meisnate12/Plex-Meta-Manager-Configs/blob/master/PMM/overlays/ratings.yml).
* If the attribute key ends with `.not` the value must not equal the attribute value or not be in the list of attribute values.
* If the attribute key ends with `.exists` and the attribute value is `true` then the attribute key must be a given template variable and if the value is anything else then the attribute key must not be a given template variable.
* Otherwise, the value must equal the attribute value or be in the list of attribute values.
Here's an example from the [PMM Default ratings file](https://github.com/meisnate12/Plex-Meta-Manager/blob/master/defaults/overlays/ratings.yml).
```yaml
templates:

11
docs/metadata/update.md Normal file
View file

@ -0,0 +1,11 @@
# Settings/Updates
The settings will change how Plex Meta Manager functions with the Definition while updates change the actual metadata stored in plex.
| Name | Description |
|:---------------------------------------------------------|:---------------------------------------------------------------------------------------|
| [Definition Settings](details/definition) | These are settings to change of Plex Meta Manager deals with the definition. |
| [Schedule Settings](details/schedule) | These are settings to change how the definition is scheduled to run. |
| [Arr Definition Settings](details/arr) | These are settings to change how Radarr/Sonarr is handled in this specific definition. |
| [Collection/Playlist Metadata Updates](details/metadata) | These are settings to change an aspect of a collection/playlist's metadata. |
| [Item Metadata Updates](details/item_metadata) | These are settings to change an aspect of metadata for all items in the collection. |

16
modules/meta.py
View file

@ -359,7 +359,21 @@ class DataFile:
continue
var_key = replace_var(var_key, [variables, default])
var_value = replace_var(var_value, [variables, default])
if var_key in variables:
if var_key.endswith(".exists"):
var_value = util.parse(self.data_type, var_key, var_value, datatype="bool", default=False)
if (not var_value and var_key[:-7] in variables and variables[var_key[:-7]]) or (var_value and (var_key[:-7] not in variables or not variables[var_key[:-7]])):
logger.debug(f"Condition {i} Failed: {var_key}: {'true does not exist' if var_value else 'false exists'}")
condition_passed = False
elif var_key.endswith(".not"):
if (isinstance(var_value, list) and variables[var_key] in var_value) or \
(not isinstance(var_value, list) and str(variables[var_key]) == str(var_value)):
if isinstance(var_value, list):
logger.debug(f'Condition {i} Failed: {var_key} "{variables[var_key]}" in {var_value}')
else:
logger.debug(f'Condition {i} Failed: {var_key} "{variables[var_key]}" is "{var_value}"')
condition_passed = False
break
elif var_key in variables:
if (isinstance(var_value, list) and variables[var_key] not in var_value) or \
(not isinstance(var_value, list) and str(variables[var_key]) != str(var_value)):
if isinstance(var_value, list):

2
modules/overlay.py
View file

@ -134,7 +134,7 @@ class Overlay:
raise Failed(f"Overlay Error: overlay attribute's queue requires the weight attribute")
elif self.group and self.queue_name:
raise Failed(f"Overlay Error: overlay attribute's group and queue cannot be used together")
self.horizontal_align, self.horizontal_offset, self.vertical_align, self.vertical_offset = util.parse_cords(self.data, "overlay")
self.horizontal_offset, self.horizontal_align, self.vertical_offset, self.vertical_align = util.parse_cords(self.data, "overlay")
if (self.horizontal_offset is None and self.vertical_offset is not None) or (self.vertical_offset is None and self.horizontal_offset is not None):
raise Failed(f"Overlay Error: overlay attribute's horizontal_offset and vertical_offset must be used together")

2
modules/util.py
View file

@ -828,7 +828,7 @@ def parse_cords(data, parent, required=False):
if required and vertical_offset is None:
raise Failed(f"Overlay Error: {parent} vertical_offset is required")
return horizontal_align, horizontal_offset, vertical_align, vertical_offset
return horizontal_offset, horizontal_align, vertical_offset, vertical_align
def replace_label(_label, _data):
replaced = False