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

Doc changes 8 28 (#2209)

Browse source
This commit is contained in:
Chaz Larson 2024-08-28 13:27:28 -05:00 committed by GitHub
parent 8b52e7dc1f
commit 4990c91590
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
43 changed files with 525 additions and 186 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/config/libraries.md
View file

@ -13,7 +13,7 @@ Attributes are used to instruct Kometa what actions to take, such as "load the f
be inherited from the global value if it has been set. If an attribute is specified at both the library and global 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. level, then the library level attribute will take priority.
### Attributes ## Attributes
The available attributes for each library are as follows: The available attributes for each library are as follows:

4
docs/config/schedule.md
View file

@ -36,7 +36,7 @@ The scheduling options are:
??? blank "Scheduling a Library<a class="headerlink" href="#schedule-library" title="Permanent link"></a>" ??? blank "Scheduling a Library<a class="headerlink" href="#schedule-library" title="Permanent link"></a>"
<div id="schedule-library" />Uses the `schedule` [Library Attribute](libraries.md#Attributes) to set when a library will be run. <div id="schedule-library" />Uses the `schedule` [Library Attribute](libraries.md#attributes) to set when a library will be run.
Other schedule rules for files, overlays, collections, and any other attribute that can be scheduled must also be Other schedule rules for files, overlays, collections, and any other attribute that can be scheduled must also be
met. met.
@ -61,7 +61,7 @@ The scheduling options are:
??? blank "Scheduling Collection, Playlist, and Metadata Files<a class="headerlink" href="#schedule-files" title="Permanent link"></a>" ??? blank "Scheduling Collection, Playlist, and Metadata Files<a class="headerlink" href="#schedule-files" title="Permanent link"></a>"
<div id="schedule-files" />Uses the `schedule` [Block Attribute](files.md#Other-Block-Attributes) to set when a file <div id="schedule-files" />Uses the `schedule` [Block Attribute](files.md#other-block-attributes) to set when a file
will be run. will be run.
Other schedule rules for collections and any other attribute that can be scheduled must also be met. Other schedule rules for collections and any other attribute that can be scheduled must also be met.

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

@ -98,7 +98,7 @@ work. Any value not specified will use its default value if it has one if not it
1. Check the first 10 casting credits in each movie 1. Check the first 10 casting credits in each movie
2. Create 20 collections maximum 2. Create 20 collections maximum
3. use the [diiivoy Color Style](#diiivoy-color-style) 3. use the [diiivoy Color Style](#poster-styles)
4. Do not create an "Actors Collections" separator 4. Do not create an "Actors Collections" separator
5. There are two Richard Brooks, so use the 2nd 5. There are two Richard Brooks, so use the 2nd
[Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb [Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb

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

@ -60,7 +60,7 @@ work. Any value not specified will use its default value if it has one if not it
| `append_include` | **Description:** Appends to the [default include list](#include)<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)<br>**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | | `append_include` | **Description:** Appends to the [default include list](#include)<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)<br>**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) |
| `remove_include` | **Description:** Removes from the [default include list](#include)<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)<br>**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | | `remove_include` | **Description:** Removes from the [default include list](#include)<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)<br>**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) |
| `exclude` | **Description:** Exclude these Audio Languages from creating a Dynamic Collection.<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)<br>**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | | `exclude` | **Description:** Exclude these Audio Languages from creating a Dynamic Collection.<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)<br>**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) |
| `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#default-key_name_override).<br>**Values:** Dictionary with `key: new_key_name` entries | | `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#key-name-override).<br>**Values:** Dictionary with `key: new_key_name` entries |
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> Audio`<br>**Values:** Any string with `<<key_name>>` in it. | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> Audio`<br>**Values:** Any string with `<<key_name>>` in it. |
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s filmed in the <<key_name>> Language.`<br>**Values:** Any string. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s filmed in the <<key_name>> Language.`<br>**Values:** Any string. |
@ -113,7 +113,13 @@ If you want to customize these values, use the methods described above.
<div id="include" /> <div id="include" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
include: {% include: {%
include-markdown "../../../defaults/both/audio_language.yml" include-markdown "../../../defaults/both/audio_language.yml"
comments=false comments=false
@ -127,11 +133,17 @@ If you want to customize these values, use the methods described above.
<div id="key-name-override" /> <div id="key-name-override" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
key_name_override: {% key_name_override: {%
include-markdown "../../../defaults/both/audio_language.yml" include-markdown "../../../defaults/both/audio_language.yml"
comments=false comments=false
preserve-includer-indent=false preserve-includer-indent=false
start="key_name_override:" start="key_name_override:"
%} %}
``` ```

12
docs/defaults/both/collectionless.md
View file

@ -69,7 +69,7 @@ work. Any value not specified will use its default value if it has one if not it
| `collection_order` | **Description:** Changes the Collection Order for all collections in this file.<br>**Default:** `alpha`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | | `collection_order` | **Description:** Changes the Collection Order for all collections in this file.<br>**Default:** `alpha`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
| `url_poster` | **Description:** Changes the poster url of the collection.<br>**Values:** URL directly to the Image | | `url_poster` | **Description:** Changes the poster url of the collection.<br>**Values:** URL directly to the Image |
| `exclude` | **Description:** Exclude these Collections from being considered for collectionless.<br>**Values:** List of Collections | | `exclude` | **Description:** Exclude these Collections from being considered for collectionless.<br>**Values:** List of Collections |
| `exclude_prefix` | **Description:** Overrides the [default exclude_prefix list](#exclude-prefix). Exclude Collections with one of these prefixes from being considered for collectionless.<br>**Default:** [default exclude_prefix list](#default-exclude_prefix)<br>**Values:** List of Prefixes | | | `exclude_prefix` | **Description:** Overrides the [default exclude_prefix list](#exclude-prefix). Exclude Collections with one of these prefixes from being considered for collectionless.<br>**Default:** [default exclude_prefix list](#exclude-prefix)<br>**Values:** List of Prefixes | |
???+ example "Example Template Variable Amendments" ???+ example "Example Template Variable Amendments"
@ -101,7 +101,13 @@ If you want to customize these values, use the methods described above.
<div id="exclude-prefix" /> <div id="exclude-prefix" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
{% {%
include-markdown "../../../defaults/both/collectionless.yml" include-markdown "../../../defaults/both/collectionless.yml"
comments=false comments=false
@ -110,4 +116,4 @@ If you want to customize these values, use the methods described above.
start="# check1" start="# check1"
end="# check2" end="# check2"
%} %}
``` ```

16
docs/defaults/both/content_rating_au.md
View file

@ -123,7 +123,13 @@ If you want to customize these values, use the methods described above.
<div id="include" /> <div id="include" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
include: {% include: {%
include-markdown "../../../defaults/both/content_rating_au.yml" include-markdown "../../../defaults/both/content_rating_au.yml"
comments=false comments=false
@ -137,7 +143,13 @@ If you want to customize these values, use the methods described above.
<div id="addons" /> <div id="addons" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
addons: {% addons: {%
include-markdown "../../../defaults/both/content_rating_au.yml" include-markdown "../../../defaults/both/content_rating_au.yml"
comments=false comments=false

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

@ -125,7 +125,13 @@ If you want to customize these values, use the methods described above.
<div id="include" /> <div id="include" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
include: {% include: {%
include-markdown "../../../defaults/both/content_rating_cs.yml" include-markdown "../../../defaults/both/content_rating_cs.yml"
comments=false comments=false
@ -139,7 +145,13 @@ If you want to customize these values, use the methods described above.
<div id="addons" /> <div id="addons" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
addons: {% addons: {%
include-markdown "../../../defaults/both/content_rating_cs.yml" include-markdown "../../../defaults/both/content_rating_cs.yml"
comments=false comments=false

16
docs/defaults/both/content_rating_de.md
View file

@ -123,7 +123,13 @@ If you want to customize these values, use the methods described above.
<div id="include" /> <div id="include" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
include: {% include: {%
include-markdown "../../../defaults/both/content_rating_de.yml" include-markdown "../../../defaults/both/content_rating_de.yml"
comments=false comments=false
@ -137,7 +143,13 @@ If you want to customize these values, use the methods described above.
<div id="addons" /> <div id="addons" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
addons: {% addons: {%
include-markdown "../../../defaults/both/content_rating_de.yml" include-markdown "../../../defaults/both/content_rating_de.yml"
comments=false comments=false

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

@ -132,7 +132,13 @@ If you want to customize these values, use the methods described above.
<div id="include" /> <div id="include" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
include: {% include: {%
include-markdown "../../../defaults/both/content_rating_mal.yml" include-markdown "../../../defaults/both/content_rating_mal.yml"
comments=false comments=false
@ -146,7 +152,13 @@ If you want to customize these values, use the methods described above.
<div id="addons" /> <div id="addons" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
addons: {% addons: {%
include-markdown "../../../defaults/both/content_rating_mal.yml" include-markdown "../../../defaults/both/content_rating_mal.yml"
comments=false comments=false

16
docs/defaults/both/content_rating_nz.md
View file

@ -123,7 +123,13 @@ If you want to customize these values, use the methods described above.
<div id="include" /> <div id="include" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
include: {% include: {%
include-markdown "../../../defaults/both/content_rating_nz.yml" include-markdown "../../../defaults/both/content_rating_nz.yml"
comments=false comments=false
@ -137,7 +143,13 @@ If you want to customize these values, use the methods described above.
<div id="addons" /> <div id="addons" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
addons: {% addons: {%
include-markdown "../../../defaults/both/content_rating_nz.yml" include-markdown "../../../defaults/both/content_rating_nz.yml"
comments=false comments=false

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

@ -123,7 +123,13 @@ If you want to customize these values, use the methods described above.
<div id="include" /> <div id="include" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
include: {% include: {%
include-markdown "../../../defaults/both/content_rating_uk.yml" include-markdown "../../../defaults/both/content_rating_uk.yml"
comments=false comments=false
@ -137,7 +143,13 @@ If you want to customize these values, use the methods described above.
<div id="addons" /> <div id="addons" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
addons: {% addons: {%
include-markdown "../../../defaults/both/content_rating_uk.yml" include-markdown "../../../defaults/both/content_rating_uk.yml"
comments=false comments=false

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

@ -119,7 +119,13 @@ If you want to customize these values, use the methods described above.
<div id="addons" /> <div id="addons" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
addons: {% addons: {%
include-markdown "../../../defaults/both/genre.yml" include-markdown "../../../defaults/both/genre.yml"
comments=false comments=false

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

@ -137,7 +137,13 @@ If you want to customize these values, use the methods described above.
<div id="addons" /> <div id="addons" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
addons: {% addons: {%
include-markdown "../../../defaults/both/resolution.yml" include-markdown "../../../defaults/both/resolution.yml"
comments=false comments=false

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

@ -117,7 +117,13 @@ If you want to customize these values, use the methods described above.
<div id="include" /> <div id="include" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
include: {% include: {%
include-markdown "../../../defaults/both/studio.yml" include-markdown "../../../defaults/both/studio.yml"
comments=false comments=false
@ -131,7 +137,13 @@ If you want to customize these values, use the methods described above.
<div id="addons" /> <div id="addons" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
addons: {% addons: {%
include-markdown "../../../defaults/both/studio.yml" include-markdown "../../../defaults/both/studio.yml"
comments=false comments=false

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

@ -113,7 +113,13 @@ If you want to customize these values, use the methods described above.
<div id="include" /> <div id="include" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
include: {% include: {%
include-markdown "../../../defaults/both/subtitle_language.yml" include-markdown "../../../defaults/both/subtitle_language.yml"
comments=false comments=false
@ -127,7 +133,13 @@ If you want to customize these values, use the methods described above.
<div id="key-name-override" /> <div id="key-name-override" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
key_name_override: {% key_name_override: {%
include-markdown "../../../defaults/both/subtitle_language.yml" include-markdown "../../../defaults/both/subtitle_language.yml"
comments=false comments=false

24
docs/defaults/both/universe.md
View file

@ -131,7 +131,13 @@ If you want to customize these values, use the methods described above.
<div id="data" /> <div id="data" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
data: {% data: {%
include-markdown "../../../defaults/both/universe.yml" include-markdown "../../../defaults/both/universe.yml"
comments=false comments=false
@ -145,7 +151,13 @@ If you want to customize these values, use the methods described above.
<div id="trakt-url" /> <div id="trakt-url" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
{% {%
include-markdown "../../../defaults/both/universe.yml" include-markdown "../../../defaults/both/universe.yml"
comments=false comments=false
@ -160,7 +172,13 @@ If you want to customize these values, use the methods described above.
<div id="mdblist-url" /> <div id="mdblist-url" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
{% {%
include-markdown "../../../defaults/both/universe.yml" include-markdown "../../../defaults/both/universe.yml"
comments=false comments=false

1
docs/defaults/chart/tautulli.md
View file

@ -8,6 +8,7 @@ The `tautulli` Default Collection File is used to create collections based on Ta
Supported Library Types: Movie, Show Supported Library Types: Movie, Show
Requirements: [Tautulli Authentication](../../config/tautulli.md) Requirements: [Tautulli Authentication](../../config/tautulli.md)
## Collections Section 020 ## Collections Section 020

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

@ -122,7 +122,13 @@ If you want to customize these values, use the methods described above.
<div id="include" /> <div id="include" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
include: {% include: {%
include-markdown "../../../defaults/movie/content_rating_us.yml" include-markdown "../../../defaults/movie/content_rating_us.yml"
comments=false comments=false
@ -136,7 +142,13 @@ If you want to customize these values, use the methods described above.
<div id="addons" /> <div id="addons" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
addons: {% addons: {%
include-markdown "../../../defaults/movie/content_rating_us.yml" include-markdown "../../../defaults/movie/content_rating_us.yml"
comments=false comments=false

16
docs/defaults/movie/continent.md
View file

@ -124,7 +124,13 @@ If you want to customize these values, use the methods described above.
<div id="include" /> <div id="include" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
include: {% include: {%
include-markdown "../../../defaults/movie/continent.yml" include-markdown "../../../defaults/movie/continent.yml"
comments=false comments=false
@ -138,7 +144,13 @@ If you want to customize these values, use the methods described above.
<div id="addons" /> <div id="addons" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
addons: {% addons: {%
include-markdown "../../../defaults/movie/continent.yml" include-markdown "../../../defaults/movie/continent.yml"
comments=false comments=false

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

@ -124,7 +124,13 @@ If you want to customize these values, use the methods described above.
<div id="include" /> <div id="include" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
include: {% include: {%
include-markdown "../../../defaults/movie/country.yml" include-markdown "../../../defaults/movie/country.yml"
comments=false comments=false
@ -138,7 +144,13 @@ If you want to customize these values, use the methods described above.
<div id="addons" /> <div id="addons" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
addons: {% addons: {%
include-markdown "../../../defaults/movie/country.yml" include-markdown "../../../defaults/movie/country.yml"
comments=false comments=false

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

@ -101,7 +101,7 @@ work. Any value not specified will use its default value if it has one if not it
1. Check the first 10 casting credits in each movie 1. Check the first 10 casting credits in each movie
2. Create 20 collections maximum 2. Create 20 collections maximum
3. use the [rainier Style](#rainier-style) 3. use the [rainier Style](#poster-styles)
4. Do not create a "Directors Collections" separator 4. Do not create a "Directors Collections" separator
5. There are two Richard Brooks, so use the 2nd 5. There are two Richard Brooks, so use the 2nd
[Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb [Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb

34
docs/defaults/movie/franchise.md
View file

@ -58,7 +58,7 @@ work. Any value not specified will use its default value if it has one if not it
| `collection_mode` | **Description:** Controls the collection mode of all collections in this 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> | | `collection_mode` | **Description:** Controls the collection mode of all collections in this 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> |
| `minimum_items` | **Description:** Controls the minimum items that the collection must have to be created.<br>**Default:** `2`<br>**Values:** Any number | | `minimum_items` | **Description:** Controls the minimum items that the collection must have to be created.<br>**Default:** `2`<br>**Values:** Any number |
| `movie_<<key>>`<sup>1</sup> | **Description:** Adds the TMDb Movie IDs given to the specified key's collection. Overrides the [default movie](#movie) for that collection if used.<br>**Values:** List of TMDb Movie IDs | | `movie_<<key>>`<sup>1</sup> | **Description:** Adds the TMDb Movie IDs given to the specified key's collection. Overrides the [default movie](#movie) for that collection if used.<br>**Values:** List of TMDb Movie IDs |
| `name_mapping_<<key>>`<sup>1</sup> | **Description:** Sets the name mapping value for using assets of the specified key's collection.Overrides the [default name_mapping](#name_mapping) for that collection if used.<br>**Values:** Any String | | `name_mapping_<<key>>`<sup>1</sup> | **Description:** Sets the name mapping value for using assets of the specified key's collection.Overrides the [default name_mapping](#name-mapping) for that collection if used.<br>**Values:** Any String |
| `sort_title` | **Description:** Sets the sort title for all collections. Use `<<collection_name>>` to use the collection name. **Example:** `"!02_<<collection_name>>"`<br>**Values:** Any String with `<<collection_name>>` | | `sort_title` | **Description:** Sets the sort title for all collections. Use `<<collection_name>>` to use the collection name. **Example:** `"!02_<<collection_name>>"`<br>**Values:** Any String with `<<collection_name>>` |
| `sort_title_<<key>>`<sup>1</sup> | **Description:** Sets the sort title of the specified key's collection.<br>**Default:** `sort_title`<br>**Values:** Any String | | `sort_title_<<key>>`<sup>1</sup> | **Description:** Sets the sort title of the specified key's collection.<br>**Default:** `sort_title`<br>**Values:** Any String |
| `build_collection` | **Description:** Controls if you want the collection to actually be built. i.e. you may just want these movies sent to Radarr.<br>**Values:** `false` to not build the collection | | `build_collection` | **Description:** Controls if you want the collection to actually be built. i.e. you may just want these movies sent to Radarr.<br>**Values:** `false` to not build the collection |
@ -118,7 +118,13 @@ If you want to customize these values, use the methods described above.
<div id="addons" /> <div id="addons" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
addons: {% addons: {%
include-markdown "../../../defaults/movie/franchise.yml" include-markdown "../../../defaults/movie/franchise.yml"
comments=false comments=false
@ -132,7 +138,13 @@ If you want to customize these values, use the methods described above.
<div id="title-override" /> <div id="title-override" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
title_override: {% title_override: {%
include-markdown "../../../defaults/movie/franchise.yml" include-markdown "../../../defaults/movie/franchise.yml"
comments=false comments=false
@ -150,7 +162,13 @@ If you want to customize these values, use the methods described above.
Pass `movie_<<key>>` to the file as template variables to change this value per collection. Pass `movie_<<key>>` to the file as template variables to change this value per collection.
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
{% {%
include-markdown "../../../defaults/movie/franchise.yml" include-markdown "../../../defaults/movie/franchise.yml"
comments=false comments=false
@ -169,7 +187,13 @@ If you want to customize these values, use the methods described above.
Pass `name_mapping_<<key>>` to the file as template variables to change this value per collection. Pass `name_mapping_<<key>>` to the file as template variables to change this value per collection.
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
{% {%
include-markdown "../../../defaults/movie/franchise.yml" include-markdown "../../../defaults/movie/franchise.yml"
comments=false comments=false

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

@ -101,7 +101,7 @@ work. Any value not specified will use its default value if it has one if not it
1. Check the first 15 casting credits in each movie 1. Check the first 15 casting credits in each movie
2. Create 5 collections maximum 2. Create 5 collections maximum
3. use the [rainier Style](#signature-style) 3. use the [rainier Style](#poster-styles)
4. Do not create a "Producers Collections" separator 4. Do not create a "Producers Collections" separator
5. There are two Richard Brooks, so use the 2nd 5. There are two Richard Brooks, so use the 2nd
[Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb [Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb

16
docs/defaults/movie/region.md
View file

@ -128,7 +128,13 @@ If you want to customize these values, use the methods described above.
<div id="include" /> <div id="include" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
include: {% include: {%
include-markdown "../../../defaults/movie/region.yml" include-markdown "../../../defaults/movie/region.yml"
comments=false comments=false
@ -142,7 +148,13 @@ If you want to customize these values, use the methods described above.
<div id="addons" /> <div id="addons" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
addons: {% addons: {%
include-markdown "../../../defaults/movie/region.yml" include-markdown "../../../defaults/movie/region.yml"
comments=false comments=false

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

@ -145,7 +145,13 @@ If you want to customize these values, use the methods described above.
<div id="data" /> <div id="data" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
data: {% data: {%
include-markdown "../../../defaults/movie/seasonal.yml" include-markdown "../../../defaults/movie/seasonal.yml"
comments=false comments=false
@ -163,7 +169,13 @@ If you want to customize these values, use the methods described above.
Pass `emoji_<<key>>` to the file as template variables to change this value per collection. Pass `emoji_<<key>>` to the file as template variables to change this value per collection.
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
{% {%
include-markdown "../../../defaults/movie/seasonal.yml" include-markdown "../../../defaults/movie/seasonal.yml"
comments=false comments=false
@ -182,14 +194,20 @@ If you want to customize these values, use the methods described above.
Pass `schedule_<<key>>` to the file as template variables to change this value per collection. Pass `schedule_<<key>>` to the file as template variables to change this value per collection.
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
{% {%
include-markdown "../../../defaults/movie/seasonal.yml" include-markdown "../../../defaults/movie/seasonal.yml"
comments=false comments=false
preserve-includer-indent=true preserve-includer-indent=true
dedent=true dedent=true
start="# check2" start="# check2"
end="# check3" end="# check4"
%} %}
``` ```
@ -201,7 +219,13 @@ If you want to customize these values, use the methods described above.
Pass `imdb_search_<<key>>` to the file as template variables to change this value per collection. Pass `imdb_search_<<key>>` to the file as template variables to change this value per collection.
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
{% {%
include-markdown "../../../defaults/movie/seasonal.yml" include-markdown "../../../defaults/movie/seasonal.yml"
comments=false comments=false
@ -220,7 +244,13 @@ If you want to customize these values, use the methods described above.
Pass `tmdb_collection_<<key>>` to the file as template variables to change this value per collection. Pass `tmdb_collection_<<key>>` to the file as template variables to change this value per collection.
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
{% {%
include-markdown "../../../defaults/movie/seasonal.yml" include-markdown "../../../defaults/movie/seasonal.yml"
comments=false comments=false
@ -239,7 +269,13 @@ If you want to customize these values, use the methods described above.
Pass `tmdb_movie_<<key>>` to the file as template variables to change this value per collection. Pass `tmdb_movie_<<key>>` to the file as template variables to change this value per collection.
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
{% {%
include-markdown "../../../defaults/movie/seasonal.yml" include-markdown "../../../defaults/movie/seasonal.yml"
comments=false comments=false
@ -258,7 +294,13 @@ If you want to customize these values, use the methods described above.
Pass `mdblist_list_<<key>>` to the file as template variables to change this value per collection. Pass `mdblist_list_<<key>>` to the file as template variables to change this value per collection.
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
{% {%
include-markdown "../../../defaults/movie/seasonal.yml" include-markdown "../../../defaults/movie/seasonal.yml"
comments=false comments=false
@ -277,7 +319,13 @@ If you want to customize these values, use the methods described above.
Pass `trakt_list_<<key>>` to the file as template variables to change this value per collection. Pass `trakt_list_<<key>>` to the file as template variables to change this value per collection.
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
{% {%
include-markdown "../../../defaults/movie/seasonal.yml" include-markdown "../../../defaults/movie/seasonal.yml"
comments=false comments=false

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

@ -101,7 +101,7 @@ work. Any value not specified will use its default value if it has one if not it
1. Check the first 10 casting credits in each movie 1. Check the first 10 casting credits in each movie
2. Create 20 collections maximum 2. Create 20 collections maximum
3. use the [diivivoy Style](#rainier-style) 3. use the [diivivoy Style](#poster-styles)
4. Do not create a "Writers Collections" separator 4. Do not create a "Writers Collections" separator
5. There are two Richard Brooks, so use the 2nd 5. There are two Richard Brooks, so use the 2nd
[Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb [Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb

4
docs/defaults/playlist.md
View file

@ -62,7 +62,7 @@ work. Any value not specified will use its default value if it has one if not it
| `sync_to_users_<<key>>`<sup>1</sup> | **Description:** Sets the users to sync the specified key's playlist to.<br>**Default:** `sync_to_user` Value<br>**Values:** Comma-separated string or list of user names. | | `sync_to_users_<<key>>`<sup>1</sup> | **Description:** Sets the users to sync the specified key's playlist to.<br>**Default:** `sync_to_user` Value<br>**Values:** Comma-separated string or list of user names. |
| `exclude_user` | **Description:** Sets the users to exclude from sync for all playlists.<br>**Default:** `playlist_sync_to_users` Global Setting Value<br>**Values:** Comma-separated string or list of user names. | | `exclude_user` | **Description:** Sets the users to exclude from sync for all playlists.<br>**Default:** `playlist_sync_to_users` Global Setting Value<br>**Values:** Comma-separated string or list of user names. |
| `exclude_user_<<key>>`<sup>1</sup> | **Description:** Sets the users to exclude from sync the specified key's playlist.<br>**Default:** `sync_to_users` Value<br>**Values:** Comma-separated string or list of user names. | | `exclude_user_<<key>>`<sup>1</sup> | **Description:** Sets the users to exclude from sync the specified key's playlist.<br>**Default:** `sync_to_users` Value<br>**Values:** Comma-separated string or list of user names. |
| `trakt_list_<<key>>`<sup>1</sup> | **Description:** Adds the Movies in the Trakt List to the specified key's playlist. Overrides the [default trakt_list](#default-trakt_list) for that playlist if used.<br>**Values:** List of Trakt List URLs | | | | | `trakt_list_<<key>>`<sup>1</sup> | **Description:** Adds the Movies in the Trakt List to the specified key's playlist. Overrides the [default trakt_list] for that playlist if used.<br>**Values:** List of Trakt List URLs | | | |
| `delete_playlist` | **Description:** Will delete all playlists for the users defined by sync_to_users.<br>**Values:** `true` or `false` | | `delete_playlist` | **Description:** Will delete all playlists for the users defined by sync_to_users.<br>**Values:** `true` or `false` |
| `delete_playlist_<<key>>`<sup>1</sup> | **Description:** Will delete the specified key's playlists for the users defined by sync_to_users.<br>**Values:** `true` or `false` | | `delete_playlist_<<key>>`<sup>1</sup> | **Description:** Will delete the specified key's playlists for the users defined by sync_to_users.<br>**Values:** `true` or `false` |
| `ignore_ids` | **Description:** Set a list or comma-separated string of TMDb/TVDb IDs to ignore in all playlists.<br>**Values:** List or comma-separated string of TMDb/TVDb IDs | | `ignore_ids` | **Description:** Set a list or comma-separated string of TMDb/TVDb IDs to ignore in all playlists.<br>**Values:** List or comma-separated string of TMDb/TVDb IDs |
@ -110,7 +110,7 @@ show how to change a name or a list.**
If you want to customize these values, use the methods described above. If you want to customize these values, use the methods described above.
??? example "Default Template Variable `trakt_list` (click to expand) <a class="headerlink" href="#trakt-list" title="Permanent link"></a>" ??? example "Default Template Variable `trakt_list` (click to expand) <a class="headerlink" href="#trakt-list" title="Permanent link"></a>"
<div id="trakt-list" /> <div id="trakt-list" />
???+ tip ???+ tip

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

@ -120,7 +120,13 @@ If you want to customize these values, use the methods described above.
<div id="include" /> <div id="include" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
include: {% include: {%
include-markdown "../../../defaults/show/content_rating_us.yml" include-markdown "../../../defaults/show/content_rating_us.yml"
comments=false comments=false
@ -134,7 +140,13 @@ If you want to customize these values, use the methods described above.
<div id="addons" /> <div id="addons" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
addons: {% addons: {%
include-markdown "../../../defaults/show/content_rating_us.yml" include-markdown "../../../defaults/show/content_rating_us.yml"
comments=false comments=false

16
docs/defaults/show/continent.md
View file

@ -114,7 +114,13 @@ If you want to customize these values, use the methods described above.
<div id="include" /> <div id="include" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
include: {% include: {%
include-markdown "../../../defaults/show/continent.yml" include-markdown "../../../defaults/show/continent.yml"
comments=false comments=false
@ -128,7 +134,13 @@ If you want to customize these values, use the methods described above.
<div id="addons" /> <div id="addons" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
addons: {% addons: {%
include-markdown "../../../defaults/show/continent.yml" include-markdown "../../../defaults/show/continent.yml"
comments=false comments=false

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

@ -114,7 +114,13 @@ If you want to customize these values, use the methods described above.
<div id="include" /> <div id="include" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
include: {% include: {%
include-markdown "../../../defaults/show/country.yml" include-markdown "../../../defaults/show/country.yml"
comments=false comments=false
@ -128,7 +134,13 @@ If you want to customize these values, use the methods described above.
<div id="addons" /> <div id="addons" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
addons: {% addons: {%
include-markdown "../../../defaults/show/country.yml" include-markdown "../../../defaults/show/country.yml"
comments=false comments=false

16
docs/defaults/show/franchise.md
View file

@ -120,7 +120,13 @@ If you want to customize these values, use the methods described above.
<div id="data" /> <div id="data" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
data: {% data: {%
include-markdown "../../../defaults/show/franchise.yml" include-markdown "../../../defaults/show/franchise.yml"
comments=false comments=false
@ -134,7 +140,13 @@ If you want to customize these values, use the methods described above.
<div id="addons" /> <div id="addons" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
addons: {% addons: {%
include-markdown "../../../defaults/show/franchise.yml" include-markdown "../../../defaults/show/franchise.yml"
comments=false comments=false

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

@ -128,7 +128,13 @@ If you want to customize these values, use the methods described above.
<div id="include" /> <div id="include" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
include: {% include: {%
include-markdown "../../../defaults/show/network.yml" include-markdown "../../../defaults/show/network.yml"
comments=false comments=false
@ -142,7 +148,13 @@ If you want to customize these values, use the methods described above.
<div id="addons" /> <div id="addons" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
addons: {% addons: {%
include-markdown "../../../defaults/show/network.yml" include-markdown "../../../defaults/show/network.yml"
comments=false comments=false

16
docs/defaults/show/region.md
View file

@ -129,7 +129,13 @@ If you want to customize these values, use the methods described above.
<div id="include" /> <div id="include" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
include: {% include: {%
include-markdown "../../../defaults/show/region.yml" include-markdown "../../../defaults/show/region.yml"
comments=false comments=false
@ -143,7 +149,13 @@ If you want to customize these values, use the methods described above.
<div id="addons" /> <div id="addons" />
```yaml ```{ .dtd .no-copy }
###############################################################################
################################## IMPORTANT ##################################
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################
addons: {% addons: {%
include-markdown "../../../defaults/show/region.yml" include-markdown "../../../defaults/show/region.yml"
comments=false comments=false

196
docs/files/builders/overview.md
View file

@ -4,250 +4,250 @@ Builders use third-party services to source items to be added to the collection.
!!! builder !!! builder
![Smart Plex logo](../../../assets/icons/plex.png){ align=right } ![Smart Plex logo](../../assets/icons/plex.png){ align=right }
**[Plex (Smart)](../smart)** builders create Smart Collections based on the metadata inside your Plex Server. Results are dynamic and will update as your library updates without the need to re-run Kometa. **[Plex (Smart)](smart.md)** builders create Smart Collections based on the metadata inside your Plex Server. Results are dynamic and will update as your library updates without the need to re-run Kometa.
[:octicons-home-16: View Builder](../smart){ .md-button .md-button--primary } [:octicons-home-16: View Builder](smart.md){ .md-button .md-button--primary }
[:octicons-alert-24:](""){ .card-link title="Cannot be used for Overlays unless utilizing Smart Labels" } [:octicons-alert-24:](""){ .card-link title="Cannot be used for Overlays unless utilizing Smart Labels" }
??? quicklink "Popular Builders" ??? quicklink "Popular Builders"
- [:simple-plex: Smart Label](../smart/#smart-label) - Create a Smart Collection based on a specific label. The label can be generated by Kometa based on criteria. - [:simple-plex: Smart Label](smart.md#smart-label) - Create a Smart Collection based on a specific label. The label can be generated by Kometa based on criteria.
- [:simple-plex: Smart Filter](../smart/#smart-filter) - Create a Smart Collection based on the filter parameters provided. - [:simple-plex: Smart Filter](smart.md#smart-filter) - Create a Smart Collection based on the filter parameters provided.
!!! builder !!! builder
![Dumb Plex logo](../../../assets/icons/plex_dumb.png){ align=right } ![Dumb Plex logo](../../assets/icons/plex_dumb.png){ align=right }
**[Plex (Dumb)](../smart)** builders grab items based on the metadata inside your Plex Server. Results are static and require Kometa to re-run to update. **[Plex (Dumb)](smart.md)** builders grab items based on the metadata inside your Plex Server. Results are static and require Kometa to re-run to update.
[:octicons-home-16: View Builder](../plex){ .md-button .md-button--primary } [:octicons-home-16: View Builder](plex.md){ .md-button .md-button--primary }
??? quicklink "Popular Builders" ??? quicklink "Popular Builders"
- [:simple-plex: Plex All](../plex/#plex-all) - Gets every movie/show in your library. - [:simple-plex: Plex All](plex.md#plex-all) - Gets every movie/show in your library.
- [:simple-plex: Plex Search](../plex/#plex-search) - Gets every movie/show based on the search parameters provided. - [:simple-plex: Plex Search](plex.md#plex-search) - Gets every movie/show based on the search parameters provided.
- [:simple-plex: Plex Collectionless](../plex/#plex-collectionless) - Gets every movie/show that is not in a collection. - [:simple-plex: Plex Collectionless](plex.md#plex-collectionless) - Gets every movie/show that is not in a collection.
!!! builder !!! builder
![TMDb logo](../../../assets/icons/tmdb.png){ align=right } ![TMDb logo](../../assets/icons/tmdb.png){ align=right }
**[TMDb](../tmdb)** builders grab items based on metadata and lists on TheMovieDb.org **[TMDb](tmdb.md)** builders grab items based on metadata and lists on TheMovieDb.org
[:octicons-home-16: View Builder](../tmdb){ .md-button .md-button--primary } [:octicons-home-16: View Builder](tmdb.md){ .md-button .md-button--primary }
??? quicklink "Popular Builders" ??? quicklink "Popular Builders"
- [:simple-themoviedatabase: TMDb Collection](../tmdb/#tmdb-collection) - Gets every movie/show in your library. - [:simple-themoviedatabase: TMDb Collection](tmdb.md#tmdb-collection) - Gets every movie/show in your library.
- [:simple-themoviedatabase: TMDb List](../tmdb/#tmdb-list) - Gets every movie/show in your Watchlist. - [:simple-themoviedatabase: TMDb List](tmdb.md#tmdb-list) - Gets every movie/show in your Watchlist.
- [:simple-themoviedatabase: TMDb Company](../tmdb/#tmdb-company) - Gets the first episode of every show in your library. - [:simple-themoviedatabase: TMDb Company](tmdb.md#tmdb-company) - Gets the first episode of every show in your library.
- [:simple-themoviedatabase: TMDb Network](../tmdb/#tmdb-network) - Gets the first episode of every show in your library. - [:simple-themoviedatabase: TMDb Network](tmdb.md#tmdb-network) - Gets the first episode of every show in your library.
!!! builder !!! builder
![Trakt logo](../../../assets/icons/trakt.png){ align=right } ![Trakt logo](../../assets/icons/trakt.png){ align=right }
**[Trakt](../trakt)** builders grab items based on metadata and lists on Trakt.tv **[Trakt](trakt.md)** builders grab items based on metadata and lists on Trakt.tv
[:octicons-home-16: View Builder](../trakt){ .md-button .md-button--primary } [:octicons-home-16: View Builder](trakt.md){ .md-button .md-button--primary }
??? quicklink "Popular Builders" ??? quicklink "Popular Builders"
- [:simple-trakt: Trakt List](../trakt/#trakt-list) - Gets every movie/show in the Trakt List - [:simple-trakt: Trakt List](trakt.md#trakt-list) - Gets every movie/show in the Trakt List
- [:simple-trakt: Trakt Chart](../trakt/#trakt-chart) - Gets every movie/show in the Trakt Chart - [:simple-trakt: Trakt Chart](trakt.md#trakt-chart) - Gets every movie/show in the Trakt Chart
- [:simple-trakt: Trakt Recommendations](../trakt/#trakt-recommendations) - Gets every movie/show in Trakt's Personal Recommendations for your User - [:simple-trakt: Trakt Recommendations](trakt.md#trakt-recommendations) - Gets every movie/show in Trakt's Personal Recommendations for your User
!!! builder !!! builder
![MDBList logo](../../../assets/icons/mdblist.png){ align=right } ![MDBList logo](../../assets/icons/mdblist.png){ align=right }
**[MDBList](../mdblist)** builders grab items based on lists on MDBList.com **[MDBList](mdblist.md)** builders grab items based on lists on MDBList.com
[:octicons-home-16: View Builder](../mdblist){ .md-button .md-button--primary } [:octicons-home-16: View Builder](mdblist.md){ .md-button .md-button--primary }
??? quicklink "Popular Builders" ??? quicklink "Popular Builders"
- [:octicons-list-ordered-16: MDBList List](../mdblist/#mdblist-list) - Gets every movie/show in a MDBList List. - [:octicons-list-ordered-16: MDBList List](mdblist.md#mdblist-list) - Gets every movie/show in a MDBList List.
!!! builder !!! builder
![IMDb logo](../../../assets/icons/imdb.png){ align=right } ![IMDb logo](../../assets/icons/imdb.png){ align=right }
**[IMDb](../imdb)** builders grab items based on metadata and lists on IMDb.com **[IMDb](imdb.md)** builders grab items based on metadata and lists on IMDb.com
[:octicons-home-16: View Builder](../imdb){ .md-button .md-button--primary } [:octicons-home-16: View Builder](imdb.md){ .md-button .md-button--primary }
??? quicklink "Popular Builders" ??? quicklink "Popular Builders"
- [:simple-imdb: IMDb Chart](../imdb/#imdb-chart) - Gets every movie/show in an IMDb Chart like IMDb Top 250 Movies. - [:simple-imdb: IMDb Chart](imdb.md#imdb-chart) - Gets every movie/show in an IMDb Chart like IMDb Top 250 Movies.
- [:simple-imdb: IMDb List](../imdb/#imdb-list) - Gets every movie/show in an IMDb List. - [:simple-imdb: IMDb List](imdb.md#imdb-list) - Gets every movie/show in an IMDb List.
- [:simple-imdb: IMDb Award](../imdb/#imdb-award) - Gets every movie/show in an IMDb Event. - [:simple-imdb: IMDb Award](imdb.md#imdb-award) - Gets every movie/show in an IMDb Event.
- [:simple-imdb: IMDb Search](../imdb/#imdb-award) - Gets every movie/show in an IMDb Search. Can also be used for Keyword searches. - [:simple-imdb: IMDb Search](imdb.md#imdb-award) - Gets every movie/show in an IMDb Search. Can also be used for Keyword searches.
!!! builder !!! builder
![TVDb logo](../../../assets/icons/tvdb.png){ align=right } ![TVDb logo](../../assets/icons/tvdb.png){ align=right }
**[TVDb](../tvdb)** builders grab items based on metadata and lists on TheTVDb.com **[TVDb](tvdb.md)** builders grab items based on metadata and lists on TheTVDb.com
[:octicons-home-16: View Builder](../tvdb){ .md-button .md-button--primary } [:octicons-home-16: View Builder](tvdb.md){ .md-button .md-button--primary }
??? quicklink "Popular Builders" ??? quicklink "Popular Builders"
- [:material-television-guide: TVDb Show](../tvdb/#tvdb-show) - Grabs the specified series. - [:material-television-guide: TVDb Show](tvdb.md#tvdb-show) - Grabs the specified series.
- [:material-television-guide: TVDb Movie](../tvdb/#tvdb-movie) - Gets the specified movies. - [:material-television-guide: TVDb Movie](tvdb.md#tvdb-movie) - Gets the specified movies.
- [:material-television-guide: TVDb List](../tvdb/#tvdb-list) - Gets every item in a TVDb List or TVDb UserList. - [:material-television-guide: TVDb List](tvdb.md#tvdb-list) - Gets every item in a TVDb List or TVDb UserList.
!!! builder !!! builder
![BoxOfficeMojo logo](../../../assets/icons/boxofficemojo.png){ align=right } ![BoxOfficeMojo logo](../../assets/icons/boxofficemojo.png){ align=right }
**[BoxOfficeMojo](../mojo)** builders grab items based on metadata and lists on Boxofficemojo.com **[BoxOfficeMojo](mojo.md)** builders grab items based on metadata and lists on Boxofficemojo.com
[:octicons-home-16: View Builder](../mojo){ .md-button .md-button--primary } [:octicons-home-16: View Builder](mojo.md){ .md-button .md-button--primary }
[:octicons-alert-24:](""){ .card-link title="Only works with Movie libraries" } [:octicons-alert-24:](""){ .card-link title="Only works with Movie libraries" }
??? quicklink "Popular Builders" ??? quicklink "Popular Builders"
- [:material-ticket: Mojo World](../mojo/#mojo-world) - Grabs items in the Worldwide Box Office chart. - [:material-ticket: Mojo World](mojo.md#mojo-world) - Grabs items in the Worldwide Box Office chart.
- [:material-ticket: Mojo Domestic](../mojo/#mojo-movie) - Grabs items in the Domestic Box Office chart. - [:material-ticket: Mojo Domestic](mojo.md#mojo-domestic) - Grabs items in the Domestic Box Office chart.
- [:material-ticket: Mojo Record](../mojo/#mojo-record) - Grabs items in miscellaneous lists such as Weekend Records and Daily Records. - [:material-ticket: Mojo Record](mojo.md#mojo-record) - Grabs items in miscellaneous lists such as Weekend Records and Daily Records.
!!! builder !!! builder
![Tautulli logo](../../../assets/icons/tautulli.png){ align=right } ![Tautulli logo](../../assets/icons/tautulli.png){ align=right }
**[Tautulli](../tautulli)** builders grab items based on lists on Tautulli **[Tautulli](tautulli.md)** builders grab items based on lists on Tautulli
[:octicons-home-16: View Builder](../tautulli){ .md-button .md-button--primary } [:octicons-home-16: View Builder](tautulli.md){ .md-button .md-button--primary }
??? quicklink "Popular Builders" ??? quicklink "Popular Builders"
- [:material-movie-search: Tautulli Popular](../tautulli/#tautulli-popular) - Gets every movie/show in the Tautulli Most Popular List - [:material-movie-search: Tautulli Popular](tautulli.md#tautulli-popularwatched) - Gets every movie/show in the Tautulli Most Popular List
- [:material-movie-search: Tautulli Watched](../tautulli/#tautulli-watched) - Gets every movie/show in the Tautulli Most Watched List - [:material-movie-search: Tautulli Watched](tautulli.md#tautulli-popularwatched) - Gets every movie/show in the Tautulli Most Watched List
!!! builder !!! builder
![Radarr logo](../../../assets/icons/radarr.png){ align=right } ![Radarr logo](../../assets/icons/radarr.png){ align=right }
**[Radarr](../radarr)** builders grab items based on tags in Radarr **[Radarr](radarr.md)** builders grab items based on tags in Radarr
[:octicons-home-16: View Builder](../radarr){ .md-button .md-button--primary } [:octicons-home-16: View Builder](radarr.md){ .md-button .md-button--primary }
[:octicons-alert-24:](""){ .card-link title="Only works with Movie libraries" } [:octicons-alert-24:](""){ .card-link title="Only works with Movie libraries" }
??? quicklink "Popular Builders" ??? quicklink "Popular Builders"
- [:octicons-tag-16: Radarr All](../radarr/#radarr-all) - Gets every movie in Radarr - [:octicons-tag-16: Radarr All](radarr.md#radarr-all) - Gets every movie in Radarr
- [:octicons-tag-16: Radarr Taglist](../radarr/#radarr-taglist) - Gets every movie with the specified tags - [:octicons-tag-16: Radarr Taglist](radarr.md#radarr-taglist) - Gets every movie with the specified tags
!!! builder !!! builder
![Sonarr logo](../../../assets/icons/sonarr.png){ align=right } ![Sonarr logo](../../assets/icons/sonarr.png){ align=right }
**[Sonarr](../sonarr)** builders grab items based on tags in Sonarr **[Sonarr](sonarr.md)** builders grab items based on tags in Sonarr
[:octicons-home-16: View Builder](../sonarr){ .md-button .md-button--primary } [:octicons-home-16: View Builder](sonarr.md){ .md-button .md-button--primary }
[:octicons-alert-24:](""){ .card-link title="Only works with Show libraries" } [:octicons-alert-24:](""){ .card-link title="Only works with Show libraries" }
??? quicklink "Popular Builders" ??? quicklink "Popular Builders"
- [:octicons-tag-16: Sonarr All](../sonarr/#sonarr-all) - Gets every show in Sonarr - [:octicons-tag-16: Sonarr All](sonarr.md#sonarr-all) - Gets every show in Sonarr
- [:octicons-tag-16: Sonarr Taglist](../sonarr/#sonarr-taglist) - Gets every show with the specified tags - [:octicons-tag-16: Sonarr Taglist](sonarr.md#sonarr-taglist) - Gets every show with the specified tags
!!! builder !!! builder
![Letterboxd logo](../../../assets/icons/letterboxd.png){ align=right } ![Letterboxd logo](../../assets/icons/letterboxd.png){ align=right }
**[Letterboxd](../letterboxd)** builders grab items based on lists on Letterboxd.com **[Letterboxd](letterboxd.md)** builders grab items based on lists on Letterboxd.com
[:octicons-home-16: View Builder](../letterboxd){ .md-button .md-button--primary } [:octicons-home-16: View Builder](letterboxd.md){ .md-button .md-button--primary }
[:octicons-alert-24:](""){ .card-link title="Only works with Movie libraries" } [:octicons-alert-24:](""){ .card-link title="Only works with Movie libraries" }
??? quicklink "Popular Builders" ??? quicklink "Popular Builders"
- [:simple-letterboxd: Letterboxd List](../letterboxd/#letterboxd-list) - Gets every movie in the Letterboxd list - [:simple-letterboxd: Letterboxd List](letterboxd.md#letterboxd-list) - Gets every movie in the Letterboxd list
!!! builder !!! builder
![ICheckMovies logo](../../../assets/icons/icheckmovies.png){ align=right } ![ICheckMovies logo](../../assets/icons/icheckmovies.png){ align=right }
**[ICheckMovies](../icheckmovies)** builders grab items based on lists on ICheckMovies.com **[ICheckMovies](icheckmovies.md)** builders grab items based on lists on ICheckMovies.com
[:octicons-home-16: View Builder](../icheckmovies){ .md-button .md-button--primary } [:octicons-home-16: View Builder](icheckmovies.md){ .md-button .md-button--primary }
[:octicons-alert-24:](""){ .card-link title="Only works with Movie libraries" } [:octicons-alert-24:](""){ .card-link title="Only works with Movie libraries" }
??? quicklink "Popular Builders" ??? quicklink "Popular Builders"
- [:material-check: ICheckMovies List](../icheckmovies/#icheckmovies-list) - Gets every show in the ICheckMovies list - [:material-check: ICheckMovies List](icheckmovies.md#icheckmovies-list) - Gets every show in the ICheckMovies list
!!! builder !!! builder
![AniDB logo](../../../assets/icons/anidb.png){ align=right } ![AniDB logo](../../assets/icons/anidb.png){ align=right }
**[AniDB](../anidb)** builders grab items based on metadata and lists on AniDB.com **[AniDB](anidb.md)** builders grab items based on metadata and lists on AniDB.com
[:octicons-home-16: View Builder](../anidb){ .md-button .md-button--primary } [:octicons-home-16: View Builder](anidb.md){ .md-button .md-button--primary }
??? quicklink "Popular Builders" ??? quicklink "Popular Builders"
- [:octicons-database-16: AniDB ID](../anidb/#anidb-id) - Finds the anime specified by the AniDB ID - [:octicons-database-16: AniDB ID](anidb.md#anidb-id) - Finds the anime specified by the AniDB ID
- [:octicons-database-16: AniDB Popular](../anidb/#anidb-popular) - Finds every anime in AniDB's Popular Anime list - [:octicons-database-16: AniDB Popular](anidb.md#anidb-popular) - Finds every anime in AniDB's Popular Anime list
- [:octicons-database-16: AniDB Tags](../anidb/#anidb-tags) - Finds every anime with the specified AniDB Tag - [:octicons-database-16: AniDB Tags](anidb.md#anidb-tag) - Finds every anime with the specified AniDB Tag
!!! builder !!! builder
![AniList logo](../../../assets/icons/anilist.png){ align=right } ![AniList logo](../../assets/icons/anilist.png){ align=right }
**[AniList](../anilist)** builders grab items based on metadata and lists on AniList.com **[AniList](anilist.md)** builders grab items based on metadata and lists on AniList.com
[:octicons-home-16: View Builder](../anilist){ .md-button .md-button--primary } [:octicons-home-16: View Builder](anilist.md){ .md-button .md-button--primary }
??? quicklink "Popular Builders" ??? quicklink "Popular Builders"
- [:simple-anilist: AniList Top Rated](../anilist/#anilist-top-rated) - Gets every anime in AniList's Top Rated Anime list - [:simple-anilist: AniList Top Rated](anilist.md#anilist-top-rated) - Gets every anime in AniList's Top Rated Anime list
- [:simple-anilist: AniList Popular](../anilist/#anilist-popular) - Gets every anime in AniList's Popular Anime list - [:simple-anilist: AniList Popular](anilist.md#anilist-popular) - Gets every anime in AniList's Popular Anime list
- [:simple-anilist: AniList Trending](../anilist/#anilist-trending) - Gets every anime in AniList's Trending Anime list - [:simple-anilist: AniList Trending](anilist.md#anilist-trending) - Gets every anime in AniList's Trending Anime list
- [:simple-anilist: AniList Search](../anilist/#anilist-search) - Gets every anime specified by the AniList search parameters provided - [:simple-anilist: AniList Search](anilist.md#anilist-search) - Gets every anime specified by the AniList search parameters provided
!!! builder !!! builder
![MyAnimeList logo](../../../assets/icons/myanimelist.png){ align=right } ![MyAnimeList logo](../../assets/icons/myanimelist.png){ align=right }
**[MyAnimeList](../myanimelist)** builders grab items based on metadata and lists on MyAnimeList.com **[MyAnimeList](myanimelist.md)** builders grab items based on metadata and lists on MyAnimeList.com
[:octicons-home-16: View Builder](../myanimelist){ .md-button .md-button--primary } [:octicons-home-16: View Builder](myanimelist.md){ .md-button .md-button--primary }
??? quicklink "Popular Builders" ??? quicklink "Popular Builders"
- [:simple-myanimelist: MyAnimeList Popular](../myanimelist/#myanimelist-most-popular) - Gets every anime in MyAnimeList's Most Popular Anime list - [:simple-myanimelist: MyAnimeList Popular](myanimelist.md#myanimelist-most-popular) - Gets every anime in MyAnimeList's Most Popular Anime list
- [:simple-myanimelist: MyAnimeList Top All](../myanimelist/#myanimelist-top-all) - Gets every anime in MyAnimeList's Top All Anime list - [:simple-myanimelist: MyAnimeList Top All](myanimelist.md#myanimelist-top-all) - Gets every anime in MyAnimeList's Top All Anime list
- [:simple-myanimelist: MyAnimeList Top Airing](../myanimelist/#myanimelist-top-airing) - Gets every anime in MyAnimeList's Top Airing Anime list - [:simple-myanimelist: MyAnimeList Top Airing](myanimelist.md#myanimelist-top-airing) - Gets every anime in MyAnimeList's Top Airing Anime list
- [:simple-myanimelist: MyAnimeList Suggested](../myanimelist/#myanimelist-suggested) - Gets every suggested anime in by MyAnimeList for the authorized user - [:simple-myanimelist: MyAnimeList Suggested](myanimelist.md#myanimelist-suggested) - Gets every suggested anime in by MyAnimeList for the authorized user
!!! builder !!! builder
![Reciperr logo](../../../assets/icons/reciperr.png){ align=right } ![Reciperr logo](../../assets/icons/reciperr.png){ align=right }
**[Reciperr](../reciperr)** builders grab items based on lists on Reciperr.com **[Reciperr](reciperr.md)** builders grab items based on lists on Reciperr.com
[:octicons-home-16: View Builder](../reciperr){ .md-button .md-button--primary } [:octicons-home-16: View Builder](reciperr.md){ .md-button .md-button--primary }
[:octicons-alert-24:](""){ .card-link title="Only works with Movie libraries" } [:octicons-alert-24:](""){ .card-link title="Only works with Movie libraries" }
??? quicklink "Popular Builders" ??? quicklink "Popular Builders"
- [:material-chef-hat: Reciperr List](../reciperr/#reciperr-list) - Gets every movie returned by the Reciperr JSON data URL. - [:material-chef-hat: Reciperr List](reciperr.md#reciperr-list) - Gets every movie returned by the Reciperr JSON data URL.
!!! builder !!! builder
![StevenLu logo](../../../assets/icons/stevenlu.png){ align=right } ![StevenLu logo](../../assets/icons/stevenlu.png){ align=right }
**[StevenLu](../stevenlu)** builders grab items based on lists on StevenLu.com **[StevenLu](stevenlu.md)** builders grab items based on lists on StevenLu.com
[:octicons-home-16: View Builder](../stevenlu){ .md-button .md-button--primary } [:octicons-home-16: View Builder](stevenlu.md){ .md-button .md-button--primary }
[:octicons-alert-24:](""){ .card-link title="Only works with Movie libraries" } [:octicons-alert-24:](""){ .card-link title="Only works with Movie libraries" }
??? quicklink "Popular Builders" ??? quicklink "Popular Builders"
- [:material-pirate: StevenLu Popular](../stevenlu/#stevenlus-popular-movie-list) - Gets every movie on StevenLu's Popular Movies List. - [:material-pirate: StevenLu Popular](stevenlu.md#stevenlus-popular-movies-list) - Gets every movie on StevenLu's Popular Movies List.

4
docs/files/collections.md
View file

@ -58,8 +58,8 @@ Collection Files can utilize the following top-level attributes
| Attribute | Description | | Attribute | Description |
|:--------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------| |:--------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------|
| [`templates`](templates.md) | contains definitions of templates that can be leveraged by multiple collections | | [`templates`](templates.md) | contains definitions of templates that can be leveraged by multiple collections |
| [`external_templates`](templates.md#external-templates) | contains [file blocks](../config/files.md) that point to external templates that can be leveraged by multiple collections | | [`external_templates`](templates.md) | contains [file blocks](../config/files.md) that point to external templates that can be leveraged by multiple collections |
| [`collections`](#collection-operations--attributes) | contains definitions of collections you wish to add to one or more libraries | | [`collections`](#collection-operations-attributes) | contains definitions of collections you wish to add to one or more libraries |
| [`dynamic_collections`](#dynamic-collections) | contains definitions of [dynamic collections](dynamic.md) you wish to create | | [`dynamic_collections`](#dynamic-collections) | contains definitions of [dynamic collections](dynamic.md) you wish to create |
* One of `metadata`, `collections` or `dynamic_collections` must be present for the File to run, else you will receive * One of `metadata`, `collections` or `dynamic_collections` must be present for the File to run, else you will receive

4
docs/files/overlays.md
View file

@ -67,7 +67,7 @@ Overlay Files can utilize the following top-level attributes
| Attribute | Description | | Attribute | Description |
|:--------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------| |:--------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------|
| [`templates`](templates.md) | contains definitions of templates that can be leveraged by multiple Overlays | | [`templates`](templates.md) | contains definitions of templates that can be leveraged by multiple Overlays |
| [`external_templates`](templates.md#external-templates) | contains [file blocks](../config/files.md) that point to external templates that can be leveraged by multiple overlays | | [`external_templates`](templates.md) | contains [file blocks](../config/files.md) that point to external templates that can be leveraged by multiple overlays |
| [`overlays`](#overlay-attributes) | contains definitions of Overlays you wish to add to one or more libraries | | [`overlays`](#overlay-attributes) | contains definitions of Overlays you wish to add to one or more libraries |
* Example Files can be found in the [Kometa Community Configs Repository](https://github.com/Kometa-Team/Community-Configs) * Example Files can be found in the [Kometa Community Configs Repository](https://github.com/Kometa-Team/Community-Configs)
@ -116,7 +116,7 @@ Overlay Files can utilize the following top-level attributes
| Attribute | Description | | Attribute | Description |
|:--------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------| |:--------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------|
| [`templates`](templates.md) | contains definitions of templates that can be leveraged by multiple overlays | | [`templates`](templates.md) | contains definitions of templates that can be leveraged by multiple overlays |
| [`external_templates`](templates.md#external-templates) | contains [file blocks](../config/files.md) that point to external templates that can be leveraged by multiple overlays | | [`external_templates`](templates.md) | contains [file blocks](../config/files.md) that point to external templates that can be leveraged by multiple overlays |
| [`queues`](#overlay-queues) | contains the positional attributes of queues | | [`queues`](#overlay-queues) | contains the positional attributes of queues |
| [`overlays`](#overlay-attributes) | contains definitions of overlays you wish to add | | [`overlays`](#overlay-attributes) | contains definitions of overlays you wish to add |

2
docs/files/playlists.md
View file

@ -71,7 +71,7 @@ These are the attributes which can be utilized within the Playlist File:
| Attribute | Description | | Attribute | Description |
|:--------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------| |:--------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------|
| [`templates`](templates.md) | contains definitions of templates that can be leveraged by multiple playlists | | [`templates`](templates.md) | contains definitions of templates that can be leveraged by multiple playlists |
| [`external_templates`](templates.md#external-templates) | contains [file blocks](../config/files.md) that point to external templates that can be leveraged by multiple playlists | | [`external_templates`](templates.md) | contains [file blocks](../config/files.md) that point to external templates that can be leveraged by multiple playlists |
| [`playlists`](#playlist-attributes) | contains definitions of playlists you wish to add to the server | | [`playlists`](#playlist-attributes) | contains definitions of playlists you wish to add to the server |
* `playlists` is required in order to run the Playlist File. * `playlists` is required in order to run the Playlist File.

8
docs/kometa/guides/order.md
View file

@ -28,7 +28,7 @@ Let's start with an unmodified set of collections which do **not** specify a cus
plex_all: true plex_all: true
``` ```
![](images\sorts_example1.png) ![](images/sorts_example1.png)
Now let's use the `sort_title` attribute to reorder these collections slightly Now let's use the `sort_title` attribute to reorder these collections slightly
@ -48,7 +48,7 @@ Now let's use the `sort_title` attribute to reorder these collections slightly
sort_title: Collection 2 sort_title: Collection 2
``` ```
![](images\sorts_example2.png) ![](images/sorts_example2.png)
The above could also be achieved using any form of ASCII sort order. This example will produce the same outcome, but uses a (perhaps) illogical set of ASCII characters to define the sort title. The above could also be achieved using any form of ASCII sort order. This example will produce the same outcome, but uses a (perhaps) illogical set of ASCII characters to define the sort title.
@ -89,7 +89,7 @@ Users aren't expected to understand what this does, but users can use the `colle
1. Because the `!` character is a higher priority ASCII character, that will place ahead of the `000` for the seasonal collections. 1. Because the `!` character is a higher priority ASCII character, that will place ahead of the `000` for the seasonal collections.
![](images\sorts_example3.jpg) ![](images/sorts_example3.jpg)
You can also re-order collections within each Defaults file using the `order_<<key>>` template variable. <<key>> refers to the identifier that Kometa uses for each collection, which you can find on the relative default's wiki page. You can also re-order collections within each Defaults file using the `order_<<key>>` template variable. <<key>> refers to the identifier that Kometa uses for each collection, which you can find on the relative default's wiki page.
@ -114,7 +114,7 @@ You can also re-order collections within each Defaults file using the `order_<<k
1. Because the `!` character is a higher priority ASCII character, that will place ahead of the `000` for the seasonal collections. 1. Because the `!` character is a higher priority ASCII character, that will place ahead of the `000` for the seasonal collections.
2. file has 5 collections, each with a defined key. I have reordered each of the collections to appear in the order that I specified. 2. file has 5 collections, each with a defined key. I have reordered each of the collections to appear in the order that I specified.
![](images\sorts_example4.jpg) ![](images/sorts_example4.jpg)
## Builder Sorting ## Builder Sorting

4
docs/kometa/guides/scheduling.md
View file

@ -46,7 +46,7 @@ IMPORTANT: Every time you see `/path/to` below, it's a placeholder for the path
This will run Kometa in the background persistently until it is stopped by the user. While the docker container will be persistently running, Kometa will not begin the run until the scheduled time. This will run Kometa in the background persistently until it is stopped by the user. While the docker container will be persistently running, Kometa will not begin the run until the scheduled time.
Further customizations of the docker run command can be used to specify set times to run Kometa, further information on this and other Run Commands can be found [here](../environmental.md#time-to-run) Further customizations of the docker run command can be used to specify set times to run Kometa, further information on this and other Run Commands can be found [here](../environmental.md#times)
=== "Windows Task Scheduler" === "Windows Task Scheduler"
@ -68,7 +68,7 @@ IMPORTANT: Every time you see `/path/to` below, it's a placeholder for the path
This is the recommended approach as it allows the user additional control over how and when Kometa processes. This is the recommended approach as it allows the user additional control over how and when Kometa processes.
If you don't specify a time, the script will run at 5AM each day. You can change this with the [time-to-run](../environmental.md#time-to-run) runtime flag. If you don't specify a time, the script will run at 5AM each day. You can change this with the [time-to-run](../environmental.md#times) runtime flag.
??? abstract "Background Run Scheduled Task" ??? abstract "Background Run Scheduled Task"

2
docs/kometa/logs.md
View file

@ -26,7 +26,7 @@ Wondering how to troubleshoot Kometa and how to read through the meta.log?
In all cases, the first step is to open the [`meta.log`](#locating-log-files) with your text editor and perform these steps: In all cases, the first step is to open the [`meta.log`](#locating-log-files) with your text editor and perform these steps:
1. Check that you are running the latest [`version`](#checking-Kometa-version) of your branch. Your current version can be found in the `meta.log` file either below the Kometa ASCII art, or at the end of the run. If you are not on the latest version of your branch, you will see `Newest Version: X.X.X` below this. Ensure you [`upgrade`](install/local.md#i-want-to-update-to-the-latest-version-of-kometa) to the latest version of Kometa. 1. Check that you are running the latest [`version`](#checking-kometa-version) of your branch. Your current version can be found in the `meta.log` file either below the Kometa ASCII art, or at the end of the run. If you are not on the latest version of your branch, you will see `Newest Version: X.X.X` below this. Ensure you [`upgrade`](install/local.md#i-want-to-update-to-the-latest-version-of-kometa) to the latest version of Kometa.
2. When scanning your meta.log file, search for `[CRITICAL]` items first as these will definitely need to be fixed 2. When scanning your meta.log file, search for `[CRITICAL]` items first as these will definitely need to be fixed
3. Scan your meta.log file for `[ERROR]` and make a note of the content of the full line to start your search below on how to resolve 3. Scan your meta.log file for `[ERROR]` and make a note of the content of the full line to start your search below on how to resolve

4
docs/notused/playlists.md
View file

@ -2,9 +2,9 @@
As playlists are not tied to one specific library and can combine media from multiple libraries, they require their own special [Playlist Files](../files/playlists.md) to work. As playlists are not tied to one specific library and can combine media from multiple libraries, they require their own special [Playlist Files](../files/playlists.md) to work.
Within the [Config File](overview.md), the `playlist_files` attribute specifies the [path type](../files/files.md#paths) and path of the [Playlist Files](../files/playlists.md) that the user wants Kometa to act on. Within the [Config File](../config/overview.md), the `playlist_files` attribute specifies the [path type](../config/files.md#file-blocks) and path of the [Playlist Files](../files/playlists.md) that the user wants Kometa to act on.
**The libraries used in the playlist attribute `libraries` must be defined under the `libraries` attribute of the [Config File](overview.md).** **The libraries used in the playlist attribute `libraries` must be defined under the `libraries` attribute of the [Config File](../config/overview.md).**
```yaml ```yaml
playlist_files: playlist_files:

4
docs/showcase/overlays.md
View file

@ -51,7 +51,7 @@ Each showcased photo has been confirmed to be fully functional with Kometa v1.19
Custom fonts have been used for the ratings which can be sourced in [bullmoose20's repository](https://github.com/Kometa-Team/Community-Configs/tree/master/bullmoose20) within `fonts.zip` Custom fonts have been used for the ratings which can be sourced in [bullmoose20's repository](https://github.com/Kometa-Team/Community-Configs/tree/master/bullmoose20) within `fonts.zip`
A [Library Operation](../config/operations.md#mass--rating-update) is used to place the IMDb rating into the user rating slot, as can be seen in the code example. A [Library Operation](../config/operations.md#mass-star-rating-update) is used to place the IMDb rating into the user rating slot, as can be seen in the code example.
**Click the image to enlarge it** **Click the image to enlarge it**
@ -103,7 +103,7 @@ Each showcased photo has been confirmed to be fully functional with Kometa v1.19
This example uses two Kometa Default Overlay files: [Ratings](../defaults/overlays/ratings.md) and [Runtimes](../defaults/overlays/runtimes.md). This example uses two Kometa Default Overlay files: [Ratings](../defaults/overlays/ratings.md) and [Runtimes](../defaults/overlays/runtimes.md).
Ratings are set to show the TMDb, Trakt and IMDb ratings, which have been set using [Library Operations](../config/operations.md#mass--rating-update) Ratings are set to show the TMDb, Trakt and IMDb ratings, which have been set using [Library Operations](../config/operations.md#mass-star-rating-update)
The runtimes overlay is modified to show no text, but to instead produce the black bar which the ratigns sit on top of. The runtimes overlay is modified to show no text, but to instead produce the black bar which the ratigns sit on top of.

4
docs/stylesheets/extra.css
View file

@ -429,4 +429,6 @@ details[class="quicklink annotate"] > p .md-annotation span span::before {
.md-typeset .card-link { .md-typeset .card-link {
color: var(--md-default-fg-color--light); color: var(--md-default-fg-color--light);
} }
.highlight.no-copy .md-clipboard { display: none; }