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

[22] table alignment

Browse source
This commit is contained in:
meisnate12 2022-11-16 09:30:04 -05:00
parent 73254f5b94
commit 531e12eb46
82 changed files with 740 additions and 717 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
VERSION
View file

@ -1 +1 @@
1.18.0-develop21
1.18.0-develop22

14
docs/config/anidb.md
View file

@ -22,13 +22,13 @@ anidb:
```
| Attribute | Allowed Values | Default | Required |
|:-------------------|:----------------------------------------------------------------------------------------------|:-------:|:--------:|
| `client` | AniDB Client Name | N/A | ❌ |
| `version` | AniDB Client Version | N/A | ❌ |
| `language` | [ISO 639-1 Code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) of the User Language. | en | ❌ |
| `cache_expiration` | Number of days before each cache mapping expires and has to be re-cached. | 60 | ❌ |
| `username` | AniDB Username | N/A | ❌ |
| `password` | AniDB Password | N/A | ❌ |
|:-------------------|:----------------------------------------------------------------------------------------------|:--------|:--------:|
| `client` | AniDB Client Name | N/A | ❌ |
| `version` | AniDB Client Version | N/A | ❌ |
| `language` | [ISO 639-1 Code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) of the User Language. | en | ❌ |
| `cache_expiration` | Number of days before each cache mapping expires and has to be re-cached. | 60 | ❌ |
| `username` | AniDB Username | N/A | ❌ |
| `password` | AniDB Password | N/A | ❌ |
* To get a Client Name and Client Version please follow the following steps.

30
docs/config/configuration.md
View file

@ -8,22 +8,22 @@ A template Configuration File can be found in the [GitHub Repo](https://github.c
This table outlines the third-party services that Plex Meta Manager can make use of. Each service has specific requirements for setup that can be found by clicking the links within the table.
| Attribute | Required |
|:------------------------------|:---------------------------------------:|
| [`libraries`](libraries) | ✅ |
| [`playlist_files`](playlists) | ❌ |
| [`settings`](settings) | ❌ |
| [`webhooks`](webhooks) | ❌ |
| Attribute | Required |
|:------------------------------|:----------------------------------------|
| [`libraries`](libraries) | ✅ |
| [`playlist_files`](playlists) | ❌ |
| [`settings`](settings) | ❌ |
| [`webhooks`](webhooks) | ❌ |
| [`plex`](plex) | &#9989; <br/>Either here or per library |
| [`tmdb`](tmdb) | &#9989; |
| [`tautulli`](tautulli) | &#10060; |
| [`omdb`](omdb) | &#10060; |
| [`notifiarr`](notifiarr) | &#10060; |
| [`anidb`](anidb) | &#10060; |
| [`radarr`](radarr) | &#10060; |
| [`sonarr`](sonarr) | &#10060; |
| [`trakt`](trakt) | &#10060; |
| [`mal`](myanimelist) | &#10060; |
| [`tmdb`](tmdb) | &#9989; |
| [`tautulli`](tautulli) | &#10060; |
| [`omdb`](omdb) | &#10060; |
| [`notifiarr`](notifiarr) | &#10060; |
| [`anidb`](anidb) | &#10060; |
| [`radarr`](radarr) | &#10060; |
| [`sonarr`](sonarr) | &#10060; |
| [`trakt`](trakt) | &#10060; |
| [`mal`](myanimelist) | &#10060; |
## Configuration File Example

26
docs/config/libraries.md
View file

@ -78,20 +78,20 @@ radarr:
The available attributes for each library are as follows:
| Attribute | Values | Default | Required |
|:----------------------------------------------------|:------------------------------------------------------------------------------------------------------|:-------------------------------------:|:-------------------------------:|
| [`library_name`](#library-name) | Library name (required only when trying to use multiple libraries with the same name) | Base Attribute Name | &#10060; |
| [`metadata_path`](#metadata-path) | Location of Metadata YAML files | `/config/<<MAPPING_NAME>>.yml` | &#10060; |
| [`overlay_path`](#overlay-path) | Location of Overlay YAML files | None | &#10060; |
| Attribute | Values | Default | Required |
|:----------------------------------------------------|:------------------------------------------------------------------------------------------------------|:--------------------------------------|:-------------------------------:|
| [`library_name`](#library-name) | Library name (required only when trying to use multiple libraries with the same name) | Base Attribute Name | &#10060; |
| [`metadata_path`](#metadata-path) | Location of Metadata YAML files | `/config/<<MAPPING_NAME>>.yml` | &#10060; |
| [`overlay_path`](#overlay-path) | Location of Overlay YAML files | None | &#10060; |
| [`report_path`](#report-path) | Location to create the YAML file listing added, removed, filtered, and missing items for this library | `/config/<<MAPPING_NAME>>_report.yml` | &#10060; |
| [`template_variables`](#library-template-variables) | Library template variables to be applied to every Metadata and Overlay file run. | N/A | &#10060; |
| [`schedule`](../metadata/details/schedule) | Use any [schedule option](../metadata/details/schedule) to control when this library is run. | daily | &#10060; |
| [`operations`](operations) | Library Operations to run | N/A | &#10060; |
| [`settings`](settings) | Any `setting` attribute that overrides a global value | global | &#10060; |
| [`plex`](plex) | Any `plex` attribute that overrides a global value | global | &#9989; Either here or globally |
| [`radarr`](radarr) | Any `radarr` attribute that overrides a global value | global | &#10060; |
| [`sonarr`](sonarr) | Any `sonarr` attribute that overrides a global value | global | &#10060; |
| [`tautulli`](tautulli) | Any `tautulli` attribute that overrides a global value | global | &#10060; |
| [`template_variables`](#library-template-variables) | Library template variables to be applied to every Metadata and Overlay file run. | N/A | &#10060; |
| [`schedule`](../metadata/details/schedule) | Use any [schedule option](../metadata/details/schedule) to control when this library is run. | daily | &#10060; |
| [`operations`](operations) | Library Operations to run | N/A | &#10060; |
| [`settings`](settings) | Any `setting` attribute that overrides a global value | global | &#10060; |
| [`plex`](plex) | Any `plex` attribute that overrides a global value | global | &#9989; Either here or globally |
| [`radarr`](radarr) | Any `radarr` attribute that overrides a global value | global | &#10060; |
| [`sonarr`](sonarr) | Any `sonarr` attribute that overrides a global value | global | &#10060; |
| [`tautulli`](tautulli) | Any `tautulli` attribute that overrides a global value | global | &#10060; |
### Library Name

6
docs/config/mdblist.md
View file

@ -12,9 +12,9 @@ mdblist:
```
| Attribute | Allowed Values | Default | Required |
|:-------------------|:--------------------------------------------------------------------------|:-------:|:--------:|
| `apikey` | MdbList API Key | N/A | &#9989; |
| `cache_expiration` | Number of days before each cache mapping expires and has to be re-cached. | 60 | &#10060; |
|:-------------------|:--------------------------------------------------------------------------|:--------|:--------:|
| `apikey` | MdbList API Key | N/A | &#9989; |
| `cache_expiration` | Number of days before each cache mapping expires and has to be re-cached. | 60 | &#10060; |
* The MdbList apikey can be found [here](https://mdblist.com/preferences/).

8
docs/config/myanimelist.md
View file

@ -101,3 +101,11 @@ To authenticate MyAnimeList the first time, you need run the container with the
<h4>OAuth Flow using unRAID Docker</h4>
Directions on how to authenticate MyAnimeList on unRAID can be found on the [unRAID Walkthrough](../home/guides/unraid.md#advanced-installation-authenticating-trakt-or-myanimelist) page.
## Online Authorization Script
Plex Meta Manager requires interactive mode to be able to enter the Client ID and Client Secret. Some systems (namely NAS) make this difficult to accomplish. Chazlarson has developed an online script that can be run to generate the MAL and Trakt authentication outside of Plex Meta Manager and then paste the end-result directly into the configuration file.
The Online Auth tool can be found [here](https://replit.com/@chazlarson/MALAuth).
Simply press the play button, wait a little bit, and then follow the on-screen prompts.

6
docs/config/omdb.md
View file

@ -12,9 +12,9 @@ omdb:
```
| Attribute | Allowed Values | Default | Required |
|:-------------------|:---------------------------------------------------------------------------|:-------:|:--------:|
| `apikey` | OMDb API Key | N/A | &#9989; |
| `cache_expiration` | Number of days before each cache mapping expires and has to be re-cached. | 60 | &#10060; |
|:-------------------|:---------------------------------------------------------------------------|:--------|:--------:|
| `apikey` | OMDb API Key | N/A | &#9989; |
| `cache_expiration` | Number of days before each cache mapping expires and has to be re-cached. | 60 | &#10060; |
* The OMDb apikey can be generated [here](http://www.omdbapi.com/apikey.aspx).

13
docs/config/operations.md
View file

@ -253,9 +253,16 @@ Updates every Collection in your library to the specified Collection Mode.
**Attribute:** `mass_collection_mode`
**Values:** `default`: Library default<br>`hide`: Hide Collection<br>`hide_items`: Hide Items in this Collection<br>`show_items`: Show this Collection and its Items<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`hide`</td><td>Hide Collection</td></tr><tr><td>`hide_items`</td><td>Hide Items in this Collection</td></tr><tr><td>`show_items`</td><td>Show this Collection and its Items</td></tr></table>
**Values:**
## Update Blank Track Titles`
| Value | Description |
|:-------------|:-----------------------------------|
| `default` | Library default |
| `hide` | Hide Collection |
| `hide_items` | Hide Items in this Collection |
| `show_items` | Show this Collection and its Items |
## Update Blank Track Titles
Search though every track in a music library and replace any blank track titles with the tracks sort title.
@ -287,7 +294,7 @@ Adds every item in the library to Radarr. The existing paths in plex will be use
**Values:** `true` or `false`
## Radarr Remove By Tag`
## Radarr Remove By Tag
Removes every item from Radarr with the Tags given.

14
docs/config/plex.md
View file

@ -16,13 +16,13 @@ plex:
```
| Attribute | Allowed Values | Default | Required |
|:----------------|:-----------------------------------------------------------------------|:-------:|:--------:|
| `url` | Plex Server URL<br><strong>Example:</strong> http://192.168.1.12:32400 | N/A | &#9989; |
| `token` | Plex Server Authentication Token | N/A | &#9989; |
| `timeout` | Plex Server Timeout | 60 | &#10060; |
| `clean_bundles` | Runs Clean Bundles on the Server after all Metadata Files are run | false | &#10060; |
| `empty_trash` | Runs Empty Trash on the Server after all Metadata Files are run | false | &#10060; |
| `optimize` | Runs Optimize on the Server after all Metadata Files are run | false | &#10060; |
|:----------------|:-----------------------------------------------------------------------|:--------|:--------:|
| `url` | Plex Server URL<br><strong>Example:</strong> http://192.168.1.12:32400 | N/A | &#9989; |
| `token` | Plex Server Authentication Token | N/A | &#9989; |
| `timeout` | Plex Server Timeout | 60 | &#10060; |
| `clean_bundles` | Runs Clean Bundles on the Server after all Metadata Files are run | false | &#10060; |
| `empty_trash` | Runs Empty Trash on the Server after all Metadata Files are run | false | &#10060; |
| `optimize` | Runs Optimize on the Server after all Metadata Files are run | false | &#10060; |
* **Do Not Use the Plex Token found in Plex's Preferences.xml file**

28
docs/config/radarr.md
View file

@ -25,21 +25,21 @@ radarr:
plex_path: /share/CACHEDEV1_DATA/Multimedia
```
| Attribute | Allowed Values | Default | Required |
|:-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------:|:--------:|
| `url` | Radarr URL (Including URL Base if set).<br>**Example:** http://192.168.1.12:32788 | N/A | &#9989; |
| `token` | Radarr API Token. | N/A | &#9989; |
| `add_missing` | Adds all missing movies found from all collections to Radarr.<br>Use the `radarr_add_missing` [Radarr Details](../metadata/details/arr.md#radarr-definition-settings) in the collection definition to add missing per collection.<br>**boolean:** true or false | false | &#10060; |
| `add_existing` | Adds all existing movies in collections to Radarr.<br>Use the `radarr_add_existing` [Radarr Details](../metadata/details/arr.md#radarr-definition-settings) in the collection definition to add existing per collection.<br>**boolean:** true or false | false | &#10060; |
| `upgrade_existing` | Upgrades all existing movies in collections to match the Quality Profile of the collection.<br>Use the `radarr_upgrade_existing` [Radarr Details](../metadata/details/arr.md#radarr-definition-settings) in the collection definition to upgrade the Quality Profile per collection.<br>**boolean:** true or false | false | &#10060; |
| `root_folder_path` | Default Root Folder Path to use when adding new movies.<br>Use the `radarr_folder` [Radarr Details](../metadata/details/arr.md#radarr-definition-settings) in the collection definition to set the Root Folder per collection. | N/A | &#9989; |
| `monitor` | Monitor the movie when adding new movies.<br>Use the `radarr_monitor` [Radarr Details](../metadata/details/arr.md#radarr-definition-settings) in the collection definition to set the Monitor value per collection. | true | &#10060; |
| Attribute | Allowed Values | Default | Required |
|:-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------|:--------:|
| `url` | Radarr URL (Including URL Base if set).<br>**Example:** http://192.168.1.12:32788 | N/A | &#9989; |
| `token` | Radarr API Token. | N/A | &#9989; |
| `add_missing` | Adds all missing movies found from all collections to Radarr.<br>Use the `radarr_add_missing` [Radarr Details](../metadata/details/arr.md#radarr-definition-settings) in the collection definition to add missing per collection.<br>**boolean:** true or false | false | &#10060; |
| `add_existing` | Adds all existing movies in collections to Radarr.<br>Use the `radarr_add_existing` [Radarr Details](../metadata/details/arr.md#radarr-definition-settings) in the collection definition to add existing per collection.<br>**boolean:** true or false | false | &#10060; |
| `upgrade_existing` | Upgrades all existing movies in collections to match the Quality Profile of the collection.<br>Use the `radarr_upgrade_existing` [Radarr Details](../metadata/details/arr.md#radarr-definition-settings) in the collection definition to upgrade the Quality Profile per collection.<br>**boolean:** true or false | false | &#10060; |
| `root_folder_path` | Default Root Folder Path to use when adding new movies.<br>Use the `radarr_folder` [Radarr Details](../metadata/details/arr.md#radarr-definition-settings) in the collection definition to set the Root Folder per collection. | N/A | &#9989; |
| `monitor` | Monitor the movie when adding new movies.<br>Use the `radarr_monitor` [Radarr Details](../metadata/details/arr.md#radarr-definition-settings) in the collection definition to set the Monitor value per collection. | true | &#10060; |
| `availability` | Default Minimum Availability to use when adding new movies.<br>Use the `radarr_availability` [Radarr Details](../metadata/details/arr.md#radarr-definition-settings) in the collection definition to set the Availability per collection.<br>**Options:** `announced`, `cinemas`, `released`, `db` | `announced` | &#9989; |
| `quality_profile` | Default Quality Profile to use when adding new movies.<br>Use the `radarr_quality` [Radarr Details](../metadata/details/arr.md#radarr-definition-settings) in the collection definition to set the Quality Profile per collection. | N/A | &#10060; |
| `tag` | Default this list or comma-separated string of tags to use when adding new movies.<br>Use the `radarr_tag` [Radarr Details](../metadata/details/arr.md#radarr-definition-settings) in the collection definition to set the Tags per collection. | ` ` | &#10060; |
| `search` | Start search for missing movie when adding new movies.<br>Use the `radarr_search` [Radarr Details](../metadata/details/arr.md#radarr-definition-settings) in the collection definition to set the search value per collection.<br>**boolean:** true or false | false | &#10060; |
| `plex_path` | When using `add_existing` or `radarr_add_all` Convert this part of the path to `radarr_path`. | ` ` | &#10060; |
| `radarr_path` | When using `add_existing` or `radarr_add_all` Convert the `plex_path` part of the path to this. | ` ` | &#10060; |
| `quality_profile` | Default Quality Profile to use when adding new movies.<br>Use the `radarr_quality` [Radarr Details](../metadata/details/arr.md#radarr-definition-settings) in the collection definition to set the Quality Profile per collection. | N/A | &#10060; |
| `tag` | Default this list or comma-separated string of tags to use when adding new movies.<br>Use the `radarr_tag` [Radarr Details](../metadata/details/arr.md#radarr-definition-settings) in the collection definition to set the Tags per collection. | ` ` | &#10060; |
| `search` | Start search for missing movie when adding new movies.<br>Use the `radarr_search` [Radarr Details](../metadata/details/arr.md#radarr-definition-settings) in the collection definition to set the search value per collection.<br>**boolean:** true or false | false | &#10060; |
| `plex_path` | When using `add_existing` or `radarr_add_all` Convert this part of the path to `radarr_path`. | ` ` | &#10060; |
| `radarr_path` | When using `add_existing` or `radarr_add_all` Convert the `plex_path` part of the path to this. | ` ` | &#10060; |
* The `token` can be found by going to `Radarr > Settings > General > Security > API Key`

34
docs/config/sonarr.md
View file

@ -28,24 +28,24 @@ sonarr:
plex_path: /share/CACHEDEV1_DATA/Multimedia
```
| Attribute | Allowed Values | Default | Required |
|:-------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------:|:--------:|
| `url` | Sonarr URL (Including URL Base if set).<br>**Example:** http://192.168.1.12:32788 | N/A | &#9989; |
| `token` | Sonarr API Token. | N/A | &#9989; |
| `add_missing` | Adds all missing shows found from all collections to Sonarr.<br>Use the `sonarr_add_missing` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to add missing per collection.<br>**boolean:** true or false | false | &#10060; |
| `add_existing` | Adds all existing shows in collections to Sonarr.<br>Use the `sonarr_add_existing` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to add existing per collection.<br>**boolean:** true or false | false | &#10060; |
| `upgrade_existing` | Upgrades all existing shows in collections to match the Quality Profile of the collection.<br>Use the `sonarr_upgrade_existing` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to upgrade the Quality Profile per collection.<br>**boolean:** true or false | false | &#10060; |
| `root_folder_path` | Default Root Folder Path to use when adding new shows.<br>Use the `sonarr_folder` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to set the Root Folder per collection. | N/A | &#9989; |
| `monitor` | Default Monitor to use when adding new shows.<br>Use the `sonarr_monitor` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to set the Monitor value per collection.<br>**Values:** <table class="clearTable"><tr><td>`all`</td><td>All episodes except specials</td></tr><tr><td>`future`</td><td>Episodes that have not aired yet</td></tr><tr><td>`missing`</td><td>Episodes that do not have files or have not aired yet</td></tr><tr><td>`existing`</td><td>Episodes that have files or have not aired yet</td></tr><tr><td>`pilot`</td><td>The first episode, all others will be ignored</td></tr><tr><td>`first`</td><td>All episodes of the first season, all others will be ignored</td></tr><tr><td>`latest`</td><td>All episodes of the latest season and future seasons</td></tr><tr><td>`none`</td><td>No episodes</td></tr></table> | `all` | &#10060; |
| `quality_profile` | Default Quality Profile to use when adding new shows.<br>Use the `sonarr_quality` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to set the Quality Profile per collection. | N/A | &#9989; |
| Attribute | Allowed Values | Default | Required |
|:-------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:--------:|
| `url` | Sonarr URL (Including URL Base if set).<br>**Example:** http://192.168.1.12:32788 | N/A | &#9989; |
| `token` | Sonarr API Token. | N/A | &#9989; |
| `add_missing` | Adds all missing shows found from all collections to Sonarr.<br>Use the `sonarr_add_missing` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to add missing per collection.<br>**boolean:** true or false | false | &#10060; |
| `add_existing` | Adds all existing shows in collections to Sonarr.<br>Use the `sonarr_add_existing` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to add existing per collection.<br>**boolean:** true or false | false | &#10060; |
| `upgrade_existing` | Upgrades all existing shows in collections to match the Quality Profile of the collection.<br>Use the `sonarr_upgrade_existing` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to upgrade the Quality Profile per collection.<br>**boolean:** true or false | false | &#10060; |
| `root_folder_path` | Default Root Folder Path to use when adding new shows.<br>Use the `sonarr_folder` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to set the Root Folder per collection. | N/A | &#9989; |
| `monitor` | Default Monitor to use when adding new shows.<br>Use the `sonarr_monitor` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to set the Monitor value per collection.<br>**Values:** <table class="clearTable"><tr><td>`all`</td><td>All episodes except specials</td></tr><tr><td>`future`</td><td>Episodes that have not aired yet</td></tr><tr><td>`missing`</td><td>Episodes that do not have files or have not aired yet</td></tr><tr><td>`existing`</td><td>Episodes that have files or have not aired yet</td></tr><tr><td>`pilot`</td><td>The first episode, all others will be ignored</td></tr><tr><td>`first`</td><td>All episodes of the first season, all others will be ignored</td></tr><tr><td>`latest`</td><td>All episodes of the latest season and future seasons</td></tr><tr><td>`none`</td><td>No episodes</td></tr></table> | `all` | &#10060; |
| `quality_profile` | Default Quality Profile to use when adding new shows.<br>Use the `sonarr_quality` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to set the Quality Profile per collection. | N/A | &#9989; |
| `language_profile` | Default Language Profile to use when adding new shows.<br>Use the `sonarr_language` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to set the Language Profile per collection. | First Profile | &#10060; |
| `series_type` | Default Series Type to use when adding new shows.<br>Use the `sonarr_series` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to set the Series Type per collection.<br>**Values:** <table class="clearTable"><tr><td>`standard`</td><td>Episodes released with SxxEyy pattern</td></tr><tr><td>`daily`</td><td>Episodes released daily that use year-month-day pattern (2017-05-25)</td></tr><tr><td>`anime`</td><td>Episodes released using an absolute episode number</td></tr></table>`standard`: Episodes released with SxxEyy pattern<br>`daily`: Episodes released daily or less frequently that use year-month-day (2017-05-25)<br>`anime`: Episodes released using an absolute episode number | `standard` | &#10060; |
| `season_folder` | Use the Season Folder Option when adding new shows.<br>Use the `sonarr_season` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to set the season folder value per collection. <br>**boolean:** true or false | true | &#10060; |
| `tag` | Default this list or comma-separated string of tags to use when adding new shows.<br>Use the `sonarr_tag` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to set the tags per collection. | ` ` | &#10060; |
| `search` | Start search for missing episodes when adding new shows.<br>Use the `sonarr_search` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to set the search value per collection.<br>**boolean:** true or false | false | &#10060; |
| `cutoff_search` | Start search for cutoff unmet episodes when adding new shows.<br>Use the `sonarr_cutoff_search` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to set the cutoff search value per collection.<br>**boolean:** true or false | false | &#10060; |
| `plex_path` | When using `add_existing` or `sonarr_add_all` Convert this part of the path to `sonarr_path`. | ` ` | &#10060; |
| `sonarr_path` | When using `add_existing` or `sonarr_add_all` Convert the `plex_path` part of the path to this. | ` ` | &#10060; |
| `series_type` | Default Series Type to use when adding new shows.<br>Use the `sonarr_series` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to set the Series Type per collection.<br>**Values:** <table class="clearTable"><tr><td>`standard`</td><td>Episodes released with SxxEyy pattern</td></tr><tr><td>`daily`</td><td>Episodes released daily that use year-month-day pattern (2017-05-25)</td></tr><tr><td>`anime`</td><td>Episodes released using an absolute episode number</td></tr></table>`standard`: Episodes released with SxxEyy pattern<br>`daily`: Episodes released daily or less frequently that use year-month-day (2017-05-25)<br>`anime`: Episodes released using an absolute episode number | `standard` | &#10060; |
| `season_folder` | Use the Season Folder Option when adding new shows.<br>Use the `sonarr_season` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to set the season folder value per collection. <br>**boolean:** true or false | true | &#10060; |
| `tag` | Default this list or comma-separated string of tags to use when adding new shows.<br>Use the `sonarr_tag` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to set the tags per collection. | ` ` | &#10060; |
| `search` | Start search for missing episodes when adding new shows.<br>Use the `sonarr_search` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to set the search value per collection.<br>**boolean:** true or false | false | &#10060; |
| `cutoff_search` | Start search for cutoff unmet episodes when adding new shows.<br>Use the `sonarr_cutoff_search` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to set the cutoff search value per collection.<br>**boolean:** true or false | false | &#10060; |
| `plex_path` | When using `add_existing` or `sonarr_add_all` Convert this part of the path to `sonarr_path`. | ` ` | &#10060; |
| `sonarr_path` | When using `add_existing` or `sonarr_add_all` Convert the `plex_path` part of the path to this. | ` ` | &#10060; |
* The `token` can be found by going to `Sonarr > Settings > General > Security > API Key`

6
docs/config/tautulli.md
View file

@ -13,9 +13,9 @@ tautulli:
```
| Attribute | Allowed Values | Default | Required |
|:----------|:------------------------------------------------------|:-------:|:--------:|
| `url` | Tautulli URL<br>**Example:** http://192.168.1.12:8659 | N/A | &#9989; |
| `apikey` | Tautulli API Key | N/A | &#9989; |
|:----------|:------------------------------------------------------|:--------|:--------:|
| `url` | Tautulli URL<br>**Example:** http://192.168.1.12:8659 | N/A | &#9989; |
| `apikey` | Tautulli API Key | N/A | &#9989; |
* The apikey can be found by going to Tautulli > Settings > Web Interface > API > API Key

10
docs/config/tmdb.md
View file

@ -14,10 +14,10 @@ tmdb:
```
| Attribute | Allowed Values | Default | Required |
|:-------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------:|:--------:|
| `apikey` | User TMDb V3 API Key | N/A | &#9989; |
| `language` | [ISO 639-1 Code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) of the User Language | en | &#10060; |
| `region` | [ISO 3166-1 Code](https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) of the User Region for use with [Other TMDb Builders](../metadata/builders/tmdb.md#other-tmdb-builders) | None | &#10060; |
| `cache_expiration` | Number of days before each cache mapping expires and has to be re-cached. | 60 | &#10060; |
|:-------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------|:--------:|
| `apikey` | User TMDb V3 API Key | N/A | &#9989; |
| `language` | [ISO 639-1 Code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) of the User Language | en | &#10060; |
| `region` | [ISO 3166-1 Code](https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) of the User Region for use with [Other TMDb Builders](../metadata/builders/tmdb.md#other-tmdb-builders) | None | &#10060; |
| `cache_expiration` | Number of days before each cache mapping expires and has to be re-cached. | 60 | &#10060; |
If you do not have a TMDb V3 API key please refer to this [guide](https://developers.themoviedb.org/3/getting-started/introduction).

16
docs/config/trakt.md
View file

@ -20,10 +20,10 @@ trakt:
```
| Attribute | Allowed Values | Default | Required |
|:----------------|:--------------------------------|:-------:|:--------:|
| `client_id` | Trakt Application Client ID | N/A | &#9989; |
| `client_secret` | Trakt Application Client Secret | N/A | &#9989; |
| `pin` | Trakt Pin | None | &#10060; |
|:----------------|:--------------------------------|:--------|:--------:|
| `client_id` | Trakt Application Client ID | N/A | &#9989; |
| `client_secret` | Trakt Application Client Secret | N/A | &#9989; |
| `pin` | Trakt Pin | None | &#10060; |
* All other attributes will be filled in by the script.
@ -39,3 +39,11 @@ trakt:
8. Record the `PIN` as `pin` in your Configuration File.
* Run the script shortly after obtaining your PIN; the PIN may expire at some point.
## Online Authorization Script
Plex Meta Manager requires interactive mode to be able to enter the Client ID and Client Secret. Some systems (namely NAS) make this difficult to accomplish. Chazlarson has developed an online script that can be run to generate the MAL and Trakt authentication outside of Plex Meta Manager and then paste the end-result directly into the configuration file.
The Online Auth tool can be found [here](https://replit.com/@chazlarson/TraktAuth).
Simply press the play button, wait a little bit, and then follow the on-screen prompts.

6
docs/defaults/award/bafta.md
View file

@ -10,9 +10,9 @@ This Default file requires [Trakt Authentication](../../config/trakt)
## Collections Section 16
| Collection | Key | Description |
|:----------------------------------------------|:---------------------------------:|:--------------------------------------------------------------------------------------------|
| `BAFTA Best Films` | `best` | Collection of British Academy of Film and Television Arts Best Film Award Winners. |
| Collection | Key | Description |
|:----------------------------------------------|:----------------------------------|:--------------------------------------------------------------------------------------------|
| `BAFTA Best Films` | `best` | Collection of British Academy of Film and Television Arts Best Film Award Winners. |
| `BAFTA <<year>>`<br>**Example:** `BAFTA 2022` | `<<year>>`<br>**Example:** `2022` | Collection of British Academy of Film and Television Arts Award Winners for the given year. |
## Config

6
docs/defaults/award/cannes.md
View file

@ -10,9 +10,9 @@ This Default file requires [Trakt Authentication](../../config/trakt)
## Collections Section 16
| Collection | Key | Description |
|:------------------------------------------------|:---------------------------------:|:------------------------------------------------------------|
| `Cannes Golden Palm Winners` | `palm` | Collection of Cannes Golden Palm Award Winners. |
| Collection | Key | Description |
|:------------------------------------------------|:----------------------------------|:------------------------------------------------------------|
| `Cannes Golden Palm Winners` | `palm` | Collection of Cannes Golden Palm Award Winners. |
| `Cannes <<year>>`<br>**Example:** `Cannes 2022` | `<<year>>`<br>**Example:** `2022` | Collection of Cannes Film Award Winners for the given year. |
## Config

4
docs/defaults/award/choice.md
View file

@ -10,8 +10,8 @@ This Default file requires [Trakt Authentication](../../config/trakt)
## Collections Section 16
| Collection | Key | Description |
|:------------------------------------------------------------------------------|:---------------------------------:|:---------------------------------------------------------------|
| Collection | Key | Description |
|:------------------------------------------------------------------------------|:----------------------------------|:---------------------------------------------------------------|
| `Critics Choice Awards <<year>>`<br>**Example:** `Critics Choice Awards 2022` | `<<year>>`<br>**Example:** `2022` | Collection of Critics Choice Award Winners for the given year. |
## Config

4
docs/defaults/award/emmy.md
View file

@ -8,8 +8,8 @@ The `emmy` Default Metadata File is used to create collections based on the Emmy
## Collections Section 16
| Collection | Key | Description |
|:----------------------------------------------|:---------------------------------:|:------------------------------------------------------|
| Collection | Key | Description |
|:----------------------------------------------|:----------------------------------|:------------------------------------------------------|
| `Emmys <<year>>`<br>**Example:** `Emmys 2022` | `<<year>>`<br>**Example:** `2022` | Collection of Emmys Award Winners for the given year. |
## Config

6
docs/defaults/award/golden.md
View file

@ -8,9 +8,9 @@ The `golden` Default Metadata File is used to create collections based on the Go
## Collections Section 16
| Collection | Key | Description |
|:------------------------------------------------------------|:---------------------------------:|:--------------------------------------------------------------|
| `Golden Globe Best Motion Pictures` | `best` | Collection of Golden Globe Best Motion Picture Award Winners. |
| Collection | Key | Description |
|:------------------------------------------------------------|:----------------------------------|:--------------------------------------------------------------|
| `Golden Globe Best Motion Pictures` | `best` | Collection of Golden Globe Best Motion Picture Award Winners. |
| `Golden Globe <<year>>`<br>**Example:** `Golden Globe 2022` | `<<year>>`<br>**Example:** `2022` | Collection of Golden Globe Award Winners for the given year. |
## Config

8
docs/defaults/award/oscars.md
View file

@ -8,10 +8,10 @@ The `oscars` Default Metadata File is used to create collections based on the Ac
## Collections Section 16
| Collection | Key | Description |
|:----------------------------------------------------------------|:---------------------------------:|:-------------------------------------------------------|
| `Oscars Best Picture Winners` | `best_picture` | Collection of Oscars Best Picture Award Winners. |
| `Oscars Best Director Winners` | `best_director` | Collection of Oscars Best Director Award Winners. |
| Collection | Key | Description |
|:----------------------------------------------------------------|:----------------------------------|:-------------------------------------------------------|
| `Oscars Best Picture Winners` | `best_picture` | Collection of Oscars Best Picture Award Winners. |
| `Oscars Best Director Winners` | `best_director` | Collection of Oscars Best Director Award Winners. |
| `Oscars Winners <<year>>`<br>**Example:** `Oscars Winners 2022` | `<<year>>`<br>**Example:** `2022` | Collection of Oscars Award Winners for the given year. |
## Config

10
docs/defaults/award/other.md
View file

@ -10,12 +10,12 @@ This Default file requires [Trakt Authentication](../../config/trakt)
## Collections Section 16
| Collection | Key | Description |
|:-----------------------------------|:-----------:|:--------------------------------------------------------------|
| Collection | Key | Description |
|:-----------------------------------|:------------|:--------------------------------------------------------------|
| `Berlinale Golden Bears` | `berlinale` | Collection of Berlinale Golden Bears Award Winners. |
| `César Best Film Winners` | `cesar` | Collection of César Best Film Winners Award Winners. |
| `Razzies Golden Raspberry Winners` | `razzie` | Collection of Razzies Golden Raspberry Winners Award Winners. |
| `Venice Golden Lions` | `venice` | Collection of Venice Golden Lions Award Winners. |
| `César Best Film Winners` | `cesar` | Collection of César Best Film Winners Award Winners. |
| `Razzies Golden Raspberry Winners` | `razzie` | Collection of Razzies Golden Raspberry Winners Award Winners. |
| `Venice Golden Lions` | `venice` | Collection of Venice Golden Lions Award Winners. |
## Config

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

@ -8,8 +8,8 @@ The `separator_award` Default Metadata File is used to create a seperator collec
## Collections Section 16
| Collection | Key | Description |
|:--------------------|:-----------:|:----------------------------------------------------------------------------|
| Collection | Key | Description |
|:--------------------|:------------|:----------------------------------------------------------------------------|
| `Award Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
## Config

4
docs/defaults/award/spirit.md
View file

@ -10,8 +10,8 @@ This Default file requires [Trakt Authentication](../../config/trakt)
## Collections Section 16
| Collection | Key | Description |
|:--------------------------------------------------------------------------------------|:---------------------------------:|:-------------------------------------------------------------------|
| Collection | Key | Description |
|:--------------------------------------------------------------------------------------|:----------------------------------|:-------------------------------------------------------------------|
| `Independent Spirit Awards <<year>>`<br>**Example:** `Independent Spirit Awards 2022` | `<<year>>`<br>**Example:** `2022` | Collection of Independent Spirit Award Winners for the given year. |
## Config

6
docs/defaults/award/sundance.md
View file

@ -10,9 +10,9 @@ This Default file requires [Trakt Authentication](../../config/trakt)
## Collections Section 16
| Collection | Key | Description |
|:--------------------------------------------------------------------------------|:---------------------------------:|:-----------------------------------------------------------------------|
| `Sundance Grand Jury Winners` | `grand` | Collection of Sundance Film Festival Grand Jury Award Winners. |
| Collection | Key | Description |
|:--------------------------------------------------------------------------------|:----------------------------------|:-----------------------------------------------------------------------|
| `Sundance Grand Jury Winners` | `grand` | Collection of Sundance Film Festival Grand Jury Award Winners. |
| `Sundance Film Festival <<year>>`<br>**Example:** `Sundance Film Festival 2022` | `<<year>>`<br>**Example:** `2022` | Collection of Sundance Film Festival Award Winners for the given year. |
## Config

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

@ -8,9 +8,9 @@ The `actor` Default Metadata File is used to dynamically create collections base
## Collections Section 17
| Collection | Key | Description |
|:------------------------------------------------|:-----------------------------------------------:|:----------------------------------------------------------------------------|
| `Actors Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| Collection | Key | Description |
|:------------------------------------------------|:------------------------------------------------|:----------------------------------------------------------------------------|
| `Actors Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| `<<actor_name>>`<br>**Example:** `Frank Welker` | `<<actor_name>>`<br>**Example:** `Frank Welker` | Collection of Movies/Shows the actor is top billing in. |
### Rainier Style

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

@ -8,11 +8,11 @@ The `audio_language` Default Metadata File is used to dynamically create collect
## Collections Section 10
| Collection | Key | Description |
|:------------------------------------------------------|:-----------------------------------------:|:----------------------------------------------------------------------------|
| `Audio Language Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| Collection | Key | Description |
|:------------------------------------------------------|:------------------------------------------|:----------------------------------------------------------------------------|
| `Audio Language Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| `<<Audio Language>> Audio`<br>**Example:** `Japanese` | `<<ISO 639-1 Code>>`<br>**Example:** `ja` | Collection of Movies/Shows that have this Audio Language. |
| `Other Audio` | `other` | Collection of Movies/Shows that are less common Languages. |
| `Other Audio` | `other` | Collection of Movies/Shows that are less common Languages. |
## Config

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

@ -12,11 +12,11 @@ Use the [Mass Content Rating Update Library Operation](../../config/operations.m
## Collections Section 14
| Collection | Key | Description |
|:------------------------------------------------------------------|:--------------------------------:|:--------------------------------------------------------------------------------------|
| `Ratings Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| Collection | Key | Description |
|:------------------------------------------------------------------|:---------------------------------|:--------------------------------------------------------------------------------------|
| `Ratings Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| `<<Content Rating>> Movies/Shows`<br>**Example:** `Age 5+ Movies` | `<<Number>>`<br>**Example:** `5` | Collection of Movies/Shows that have this Content Rating. |
| `Not Rated Movies/Shows` | `other` | Collection of Movies/Shows that are Unrated, Not Rated or any other uncommon Ratings. |
| `Not Rated Movies/Shows` | `other` | Collection of Movies/Shows that are Unrated, Not Rated or any other uncommon Ratings. |
## Config

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

@ -10,11 +10,11 @@ This file assumes that you are using the `mass_content_rating_update: mal` opera
## Collections Section 14
| Collection | Key | Description |
|:----------------------------------------------------------------|:--------------------------------------------:|:-------------------------------------------------------------------------------|
| `Ratings Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| Collection | Key | Description |
|:----------------------------------------------------------------|:---------------------------------------------|:-------------------------------------------------------------------------------|
| `Ratings Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| `<<Content Rating>> Movies/Shows`<br>**Example:** `PG-13 Shows` | `<<Content Rating>>`<br>**Example:** `PG-13` | Collection of Shows that have this Content Rating. |
| `Not Rated Movies/Shows` | `other` | Collection of Shows that are Unrated, Not Rated or any other uncommon Ratings. |
| `Not Rated Movies/Shows` | `other` | Collection of Shows that are Unrated, Not Rated or any other uncommon Ratings. |
## Config

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

@ -10,11 +10,11 @@ If you do not use the UK-based rating system within Plex, this file will attempt
## Collections Section 14
| Collection | Key | Description |
|:--------------------------------------------------------------|:-----------------------------------------:|:--------------------------------------------------------------------------------------|
| `Ratings Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| Collection | Key | Description |
|:--------------------------------------------------------------|:------------------------------------------|:--------------------------------------------------------------------------------------|
| `Ratings Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| `<<Content Rating>> Movies/Shows`<br>**Example:** `15 Movies` | `<<Content Rating>>`<br>**Example:** `15` | Collection of Movies/Shows that have this Content Rating. |
| `Not Rated Movies/Shows` | `other` | Collection of Movies/Shows that are Unrated, Not Rated or any other uncommon Ratings. |
| `Not Rated Movies/Shows` | `other` | Collection of Movies/Shows that are Unrated, Not Rated or any other uncommon Ratings. |
## Config

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

@ -10,9 +10,9 @@ This file also merges similarly named genres (such as "Sci-Fi", "SciFi" and "Sci
## Collections Section 06
| Collection | Key | Description |
|:---------------------------------------------------------|:--------------------------------:|:----------------------------------------------------------------------------|
| `Genre Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| Collection | Key | Description |
|:---------------------------------------------------------|:---------------------------------|:----------------------------------------------------------------------------|
| `Genre Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| `<<Genre>> Movies/Shows`<br>**Example:** `Action Movies` | `<<Number>>`<br>**Example:** `5` | Collection of Movies/Shows that have this Genre. |
## Config

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

@ -9,9 +9,9 @@ The `resolution` Default Metadata File is used to dynamically create collections
## Collections Section 15
| Collection | Key | Description |
|:-------------------------------------------------------------|:-----------------------------------:|:----------------------------------------------------------------------------|
| `Resolution Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| Collection | Key | Description |
|:-------------------------------------------------------------|:------------------------------------|:----------------------------------------------------------------------------|
| `Resolution Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| `<<Resolution>> Movies/Shows`<br>**Example:** `1080p Movies` | `<<Number>>`<br>**Example:** `1080` | Collection of Movies/Shows that have this Resolution. |
### Standards Style

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

@ -8,24 +8,24 @@ The `streaming` Default Metadata File is used to dynamically create collections
## Collections Section 03
| Collection | Key | Description |
|:---------------------------|:-------------:|:----------------------------------------------------------------------------|
| `Streaming Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| `All 4 Movies/Shows` | `all4` | Collection of Movies/Shows Streaming on All 4. |
| `Apple TV+ Movies/Shows` | `appletv` | Collection of Movies/Shows Streaming on Apple TV+. |
| `BET+ Movies/Shows` | `bet` | Collection of Movies/Shows Streaming on BET+. |
| `BritBox Movies/Shows` | `britbox` | Collection of Movies/Shows Streaming on BritBox. |
| Collection | Key | Description |
|:---------------------------|:--------------|:----------------------------------------------------------------------------|
| `Streaming Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| `All 4 Movies/Shows` | `all4` | Collection of Movies/Shows Streaming on All 4. |
| `Apple TV+ Movies/Shows` | `appletv` | Collection of Movies/Shows Streaming on Apple TV+. |
| `BET+ Movies/Shows` | `bet` | Collection of Movies/Shows Streaming on BET+. |
| `BritBox Movies/Shows` | `britbox` | Collection of Movies/Shows Streaming on BritBox. |
| `Crunchyroll Movies/Shows` | `crunchyroll` | Collection of Movies/Shows Streaming on Crunchyroll. |
| `Disney+ Movies/Shows` | `disney` | Collection of Movies/Shows Streaming on Disney+. |
| `hayu Movies/Shows` | `hayu` | Collection of Movies/Shows Streaming on hayu. |
| `HBO Max Movies/Shows` | `hbomax` | Collection of Movies/Shows Streaming on HBO Max. |
| `Hulu Movies/Shows` | `hulu` | Collection of Movies/Shows Streaming on Hulu. |
| `Netflix Movies/Shows` | `netflix` | Collection of Movies/Shows Streaming on Netflix. |
| `NOW Movies/Shows` | `now` | Collection of Movies/Shows Streaming on NOW. |
| `Paramount+ Movies/Shows` | `paramount` | Collection of Movies/Shows Streaming on Paramount+. |
| `Peacock Movies/Shows` | `peacock` | Collection of Movies/Shows Streaming on Peacock. |
| `Prime Video Movies/Shows` | `amazon` | Collection of Movies/Shows Streaming on Prime Video. |
| `Showtime Movies/Shows` | `showtime` | Collection of Movies/Shows Streaming on Showtime. |
| `Disney+ Movies/Shows` | `disney` | Collection of Movies/Shows Streaming on Disney+. |
| `hayu Movies/Shows` | `hayu` | Collection of Movies/Shows Streaming on hayu. |
| `HBO Max Movies/Shows` | `hbomax` | Collection of Movies/Shows Streaming on HBO Max. |
| `Hulu Movies/Shows` | `hulu` | Collection of Movies/Shows Streaming on Hulu. |
| `Netflix Movies/Shows` | `netflix` | Collection of Movies/Shows Streaming on Netflix. |
| `NOW Movies/Shows` | `now` | Collection of Movies/Shows Streaming on NOW. |
| `Paramount+ Movies/Shows` | `paramount` | Collection of Movies/Shows Streaming on Paramount+. |
| `Peacock Movies/Shows` | `peacock` | Collection of Movies/Shows Streaming on Peacock. |
| `Prime Video Movies/Shows` | `amazon` | Collection of Movies/Shows Streaming on Prime Video. |
| `Showtime Movies/Shows` | `showtime` | Collection of Movies/Shows Streaming on Showtime. |
## Config

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

@ -10,9 +10,9 @@ This file also merges similarly named studios (such as "20th Century Fox" and "2
## Collections Section 07
| Collection | Key | Description |
|:-----------------------------------------------------|:----------------------------------------------------:|:----------------------------------------------------------------------------|
| `Studio Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| Collection | Key | Description |
|:-----------------------------------------------------|:-----------------------------------------------------|:----------------------------------------------------------------------------|
| `Studio Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| `<<Studio>>`<br>**Example:** `Blumhouse Productions` | `<<Studio>>`<br>**Example:** `Blumhouse Productions` | Collection of Movies/Shows that have this Studio. |
## Config

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

@ -8,9 +8,9 @@ The `studio_anime` Default Metadata File is used to dynamically create collectio
## Collections Section 07
| Collection | Key | Description |
|:-----------------------------------------------------|:----------------------------------------------------:|:----------------------------------------------------------------------------|
| `Studio Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| Collection | Key | Description |
|:-----------------------------------------------------|:-----------------------------------------------------|:----------------------------------------------------------------------------|
| `Studio Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| `<<Studio>>`<br>**Example:** `Blumhouse Productions` | `<<Studio>>`<br>**Example:** `Blumhouse Productions` | Collection of Movies/Shows that have this Studio. |
## Config

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

@ -8,11 +8,11 @@ The `subtitle_language` Default Metadata File is used to dynamically create coll
## Collections Section 11
| Collection | Key | Description |
|:---------------------------------------------------------|:-----------------------------------------:|:----------------------------------------------------------------------------|
| `Subtitle Language Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| Collection | Key | Description |
|:---------------------------------------------------------|:------------------------------------------|:----------------------------------------------------------------------------|
| `Subtitle Language Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| `<<Subtitle Language>> Audio`<br>**Example:** `Japanese` | `<<ISO 639-1 Code>>`<br>**Example:** `ja` | Collection of Movies/Shows that have this Subtitle Language. |
| `Other Subtitles` | `other` | Collection of Movies/Shows that are less common Languages. |
| `Other Subtitles` | `other` | Collection of Movies/Shows that are less common Languages. |
## Config

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

@ -8,9 +8,9 @@ The `year` Default Metadata File is used to dynamically create collections based
## Collections Section 13
| Collection | Key | Description |
|:--------------------------------------------------|:---------------------------------:|:----------------------------------------------------------------------------|
| `Year Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| Collection | Key | Description |
|:--------------------------------------------------|:----------------------------------|:----------------------------------------------------------------------------|
| `Year Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| `Best of <<Year>>`<br>**Example:** `Best of 2022` | `<<Year>>`<br>**Example:** `2022` | Collection of Movies/Shows that have this Year. |
## Config

8
docs/defaults/chart/anilist.md
View file

@ -8,12 +8,12 @@ The `anilist` Default Metadata File is used to create collections based on Anili
## Collections Section 01
| Collection | Key | Description |
|:--------------------|:----------:|:-----------------------------------------------------|
| Collection | Key | Description |
|:--------------------|:-----------|:-----------------------------------------------------|
| `AniList Popular` | `popular` | Collection of the most Popular Anime on AniList. |
| `AniList Top Rated` | `top` | Collection of the Top Rated Anime on AniList. |
| `AniList Top Rated` | `top` | Collection of the Top Rated Anime on AniList. |
| `AniList Trending` | `trending` | Collection of the Trending Anime on AniList. |
| `AniList Season` | `season` | Collection of the Current Season's Anime on AniList. |
| `AniList Season` | `season` | Collection of the Current Season's Anime on AniList. |
## Config

4
docs/defaults/chart/basic.md
View file

@ -8,8 +8,8 @@ The `basic` Default Metadata File is used to create collections based on recentl
## Collections Section 01
| Collection | Key | Description |
|:-----------------|:----------:|:---------------------------------------------------------------|
| Collection | Key | Description |
|:-----------------|:-----------|:---------------------------------------------------------------|
| `Newly Released` | `released` | Collection of Movies or TV Shows released in the last 90 days. |
| `New Episodes` | `episodes` | Collection of Episodes released in the last 7 days. |

14
docs/defaults/chart/flixpatrol.md
View file

@ -8,14 +8,14 @@ The `flixpatrol` Default Metadata File is used to create collections based on Fl
## Collections Section 01
| Collection | Key | Description |
|:---------------------------------|:-----------:|:---------------------------------------------------------------------------|
| `Netflix Top 10 Moves/Shows` | `netflix` | Collection of the Top Movies/Shows on Netflix according to FlixPatrol. |
| `Disney+ Top 10 Moves/Shows` | `disney` | Collection of the Top Movies/Shows on Disney+ according to FlixPatrol. |
| `HBO Top 10 Moves/Shows` | `hbo` | Collection of the Top Movies/Shows on HBO according to FlixPatrol. |
| `Hulu Top 10 Moves/Shows` | `hulu` | Collection of the Top Movies/Shows on Hulu according to FlixPatrol. |
| Collection | Key | Description |
|:---------------------------------|:------------|:---------------------------------------------------------------------------|
| `Netflix Top 10 Moves/Shows` | `netflix` | Collection of the Top Movies/Shows on Netflix according to FlixPatrol. |
| `Disney+ Top 10 Moves/Shows` | `disney` | Collection of the Top Movies/Shows on Disney+ according to FlixPatrol. |
| `HBO Top 10 Moves/Shows` | `hbo` | Collection of the Top Movies/Shows on HBO according to FlixPatrol. |
| `Hulu Top 10 Moves/Shows` | `hulu` | Collection of the Top Movies/Shows on Hulu according to FlixPatrol. |
| `Paramount+ Top 10 Moves/Shows` | `paramount` | Collection of the Top Movies/Shows on Paramount+ according to FlixPatrol. |
| `Prime Video Top 10 Moves/Shows` | `prime` | Collection of the Top Movies/Shows on Prime Video according to FlixPatrol. |
| `Prime Video Top 10 Moves/Shows` | `prime` | Collection of the Top Movies/Shows on Prime Video according to FlixPatrol. |
## Config

6
docs/defaults/chart/imdb.md
View file

@ -8,10 +8,10 @@ The `imdb` Default Metadata File is used to create collections based on IMDb Cha
## Collections Section 01
| Collection | Key | Description |
|:--------------------|:---------:|:-----------------------------------------------------|
| Collection | Key | Description |
|:--------------------|:----------|:-----------------------------------------------------|
| `IMDb Popular` | `popular` | Collection of the most Popular Movies/Shows on IMDb. |
| `IMDb Top 250` | `top` | Collection of Top 250 Movies/Shows on IMDb. |
| `IMDb Top 250` | `top` | Collection of Top 250 Movies/Shows on IMDb. |
| `IMDb Lowest Rated` | `lowest` | Collection of the lowest Rated Movies on IMDb. |
## Config

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

@ -8,13 +8,13 @@ The `myanimelist` Default Metadata File is used to create collections based on M
## Collections Section 01
| Collection | Key | Description |
|:-------------------------|:-----------:|:--------------------------------------------------------|
| `MyAnimeList Popular` | `popular` | Collection of the most Popular Anime on MyAnimeList. |
| Collection | Key | Description |
|:-------------------------|:------------|:--------------------------------------------------------|
| `MyAnimeList Popular` | `popular` | Collection of the most Popular Anime on MyAnimeList. |
| `MyAnimeList Favorited` | `favorited` | Collection of most Favorited Anime on MyAnimeList. |
| `MyAnimeList Top Rated` | `top` | Collection of the Top Rated Anime on MyAnimeList. |
| `MyAnimeList Top Airing` | `airing` | Collection of the Top Rated Airing on MyAnimeList. |
| `MyAnimeList Season` | `season` | Collection of the Current Seasons Anime on MyAnimeList. |
| `MyAnimeList Top Rated` | `top` | Collection of the Top Rated Anime on MyAnimeList. |
| `MyAnimeList Top Airing` | `airing` | Collection of the Top Rated Airing on MyAnimeList. |
| `MyAnimeList Season` | `season` | Collection of the Current Seasons Anime on MyAnimeList. |
## Config

10
docs/defaults/chart/other.md
View file

@ -8,12 +8,12 @@ The `other_chart` Default Metadata File is used to create collections based on o
## Collections Section 01
| Collection | Key | Description |
|:------------------------------------|:-------------:|:-----------------------------------------------------|
| `AniDB Popular` | `anidb` | Collection of the most Popular Anime on AniDB. |
| Collection | Key | Description |
|:------------------------------------|:--------------|:-----------------------------------------------------|
| `AniDB Popular` | `anidb` | Collection of the most Popular Anime on AniDB. |
| `Common Sense Selection` | `commonsense` | Collection of Common Sense Selection Movies/Shows. |
| `StevenLu's Popular Movies` | `stevenlu` | Collection of StevenLu's Popular Movies. |
| `Top 10 Pirated Movies of the Week` | `pirated` | Collection of the Top 10 Pirated Movies of the Week. |
| `StevenLu's Popular Movies` | `stevenlu` | Collection of StevenLu's Popular Movies. |
| `Top 10 Pirated Movies of the Week` | `pirated` | Collection of the Top 10 Pirated Movies of the Week. |
## Config

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

@ -8,8 +8,8 @@ The `separator_chart` Default Metadata File is used to create a seperator collec
## Collections Section 01
| Collection | Key | Description |
|:--------------------|:-----------:|:----------------------------------------------------------------------------|
| Collection | Key | Description |
|:--------------------|:------------|:----------------------------------------------------------------------------|
| `Chart Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
## Config

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

@ -10,8 +10,8 @@ This Default file requires [Tautulli Authentication](../../config/tautulli)
## Collections Section 01
| Collection | Key | Description |
|:---------------|:---------:|:-----------------------------------------------------|
| Collection | Key | Description |
|:---------------|:----------|:-----------------------------------------------------|
| `Plex Popular` | `popular` | Collection of the most Popular Movies/Shows on Plex. |
| `Plex Watched` | `watched` | Collection of the most Watched Movies/Shows on Plex. |

10
docs/defaults/chart/tmdb.md
View file

@ -8,13 +8,13 @@ The `tmdb` Default Metadata File is used to create collections based on TMDb Cha
## Collections Section 01
| Collection | Key | Description |
|:--------------------|:----------:|:-----------------------------------------------------|
| Collection | Key | Description |
|:--------------------|:-----------|:-----------------------------------------------------|
| `TMDb Popular` | `popular` | Collection of the Most Popular Movies/Shows on TMDb. |
| `TMDb Top Rated` | `top` | Collection of the Top Rated Movies/Shows on TMDb. |
| `TMDb Top Rated` | `top` | Collection of the Top Rated Movies/Shows on TMDb. |
| `TMDb Trending` | `trending` | Collection of Trending Movies/Shows on TMDb. |
| `TMDb Airing Today` | `airing` | Collection of Shows Airing Today on TMDb. |
| `TMDb On The Air` | `air` | Collection of Shows currently On The Air on TMDb. |
| `TMDb Airing Today` | `airing` | Collection of Shows Airing Today on TMDb. |
| `TMDb On The Air` | `air` | Collection of Shows currently On The Air on TMDb. |
## Config

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

@ -8,13 +8,13 @@ The `trakt` Default Metadata File is used to create collections based on Trakt C
## Collections Section 01
| Collection | Key | Description |
|:--------------------|:-------------:|:--------------------------------------------------------|
| `Trakt Collected` | `collected` | Collection of the Most Collected Movies/Shows on Trakt. |
| `Trakt Popular` | `popular` | Collection of the Most Popular Movies/Shows on Trakt. |
| Collection | Key | Description |
|:--------------------|:--------------|:--------------------------------------------------------|
| `Trakt Collected` | `collected` | Collection of the Most Collected Movies/Shows on Trakt. |
| `Trakt Popular` | `popular` | Collection of the Most Popular Movies/Shows on Trakt. |
| `Trakt Recommended` | `recommended` | Collection of Recommended Movies/Shows on Trakt. |
| `Trakt Trending` | `trending` | Collection of Trending Movies/Shows on Trakt. |
| `Trakt Watched` | `watched` | Collection of the Most Watched Movies/Shows on Trakt. |
| `Trakt Trending` | `trending` | Collection of Trending Movies/Shows on Trakt. |
| `Trakt Watched` | `watched` | Collection of the Most Watched Movies/Shows on Trakt. |
## Config

84
docs/defaults/collection_list.md
View file

@ -6,58 +6,58 @@ These collections are applied by calling the below paths into the `metadata_path
### Chart Collections
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|:-----------------------------------|:-----------------:|:-------------------------------------------|:-----------------:|:----------------:|
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|:-----------------------------------|:------------------|:-------------------------------------------|:-----------------:|:----------------:|
| [Chart Separator](chart/separator) | `separator_chart` | Chart Collections | &#9989; | &#9989; |
| [AniList](chart/anilist) | `anilist` | AniList Popular, AniList Season | &#9989; | &#9989; |
| [Basic](chart/basic) | `basic` | Newly Released, New Episodes | &#9989; | &#9989; |
| [FlixPatrol](chart/flixpatrol) | `flixpatrol` | Top Disney, Top Hbo, Top Hulu, Top Netflix | &#9989; | &#9989; |
| [IMDb](chart/imdb) | `imdb` | IMDb Popular, IMDb Top 250 | &#9989; | &#9989; |
| [MyAnimeList](chart/myanimelist) | `myanimelist` | MyAnimeList Popular, MyAnimeList Top Rated | &#9989; | &#9989; |
| [Other](chart/other) | `other_chart` | AniDB Popular, Common Sense Selection | &#9989; | &#9989; |
| [Tautulli](chart/tautulli) | `tautulli` | Plex Popular, Plex Watched | &#9989; | &#9989; |
| [TMDb](chart/tmdb) | `tmdb` | TMDb Popular, TMDb Airing Today | &#9989; | &#9989; |
| [Trakt](chart/trakt) | `trakt` | Trakt Popular, Trakt Trending | &#9989; | &#9989; |
| [AniList](chart/anilist) | `anilist` | AniList Popular, AniList Season | &#9989; | &#9989; |
| [Basic](chart/basic) | `basic` | Newly Released, New Episodes | &#9989; | &#9989; |
| [FlixPatrol](chart/flixpatrol) | `flixpatrol` | Top Disney, Top Hbo, Top Hulu, Top Netflix | &#9989; | &#9989; |
| [IMDb](chart/imdb) | `imdb` | IMDb Popular, IMDb Top 250 | &#9989; | &#9989; |
| [MyAnimeList](chart/myanimelist) | `myanimelist` | MyAnimeList Popular, MyAnimeList Top Rated | &#9989; | &#9989; |
| [Other](chart/other) | `other_chart` | AniDB Popular, Common Sense Selection | &#9989; | &#9989; |
| [Tautulli](chart/tautulli) | `tautulli` | Plex Popular, Plex Watched | &#9989; | &#9989; |
| [TMDb](chart/tmdb) | `tmdb` | TMDb Popular, TMDb Airing Today | &#9989; | &#9989; |
| [Trakt](chart/trakt) | `trakt` | Trakt Popular, Trakt Trending | &#9989; | &#9989; |
### Award Collections
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|:-----------------------------------------------------------|:-----------------:|:--------------------------------------------|:-----------------:|:----------------:|
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|:-----------------------------------------------------------|:------------------|:--------------------------------------------|:-----------------:|:----------------:|
| [Award Separator](award/separator) | `separator_award` | Award Collections | &#9989; | &#9989; |
| [British Academy of Film and Television Arts](award/bafta) | `bafta` | BAFTA Best Films, BAFTA 2021 | &#9989; | &#10060; |
| [Cannes](award/cannes) | `cannes` | Cannes - Palme d'or, Cannes 2018 | &#9989; | &#10060; |
| [Critics Choice](award/choice) | `choice` | Critics Choice Awards 2020 | &#9989; | &#9989; |
| [Emmys](award/emmy) | `emmy` | Emmys 2021 | &#9989; | &#9989; |
| [Golden Globes](award/golden) | `golden` | Best Motion Pictures | &#9989; | &#9989; |
| [Academy Awards (Oscars)](award/oscars) | `oscars` | Best Picture Winners | &#9989; | &#9989; |
| [Independent Spirit](award/spirit) | `spirit` | Independent Spirit Awards 2021 | &#9989; | &#10060; |
| [Sundance](award/sundance) | `sundance` | Sundance Grand Jury Winners | &#9989; | &#9989; |
| [Other](award/other) | `other_award` | Berlinale Golden Bears, Venice Golden Lions | &#9989; | &#10060; |
| [British Academy of Film and Television Arts](award/bafta) | `bafta` | BAFTA Best Films, BAFTA 2021 | &#9989; | &#10060; |
| [Cannes](award/cannes) | `cannes` | Cannes - Palme d'or, Cannes 2018 | &#9989; | &#10060; |
| [Critics Choice](award/choice) | `choice` | Critics Choice Awards 2020 | &#9989; | &#9989; |
| [Emmys](award/emmy) | `emmy` | Emmys 2021 | &#9989; | &#9989; |
| [Golden Globes](award/golden) | `golden` | Best Motion Pictures | &#9989; | &#9989; |
| [Academy Awards (Oscars)](award/oscars) | `oscars` | Best Picture Winners | &#9989; | &#9989; |
| [Independent Spirit](award/spirit) | `spirit` | Independent Spirit Awards 2021 | &#9989; | &#10060; |
| [Sundance](award/sundance) | `sundance` | Sundance Grand Jury Winners | &#9989; | &#9989; |
| [Other](award/other) | `other_award` | Berlinale Golden Bears, Venice Golden Lions | &#9989; | &#10060; |
### General Collections
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|:------------------------------------------------------------------------------------|:--------------------:|:-------------------------------------------------------|:-----------------:|:----------------:|
| [Actor](both/actor) | `actor` | Chris Hemsworth, Margot Robbie | &#9989; | &#9989; |
| [Audio Language](both/audio_language) | `audio_language` | French Audio, Korean Audio | &#9989; | &#9989; |
| [Collectionless](both/collectionless) | `collectionless` | Collectionless | &#9989; | &#9989; |
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|:------------------------------------------------------------------------------------|:---------------------|:-------------------------------------------------------|:-----------------:|:----------------:|
| [Actor](both/actor) | `actor` | Chris Hemsworth, Margot Robbie | &#9989; | &#9989; |
| [Audio Language](both/audio_language) | `audio_language` | French Audio, Korean Audio | &#9989; | &#9989; |
| [Collectionless](both/collectionless) | `collectionless` | Collectionless | &#9989; | &#9989; |
| [Common Sense Content Rating](both/content_rating_cs) | `content_rating_cs` | 1, 2, 3, 4, 5, 6, 15, 16, 17, 18 | &#9989; | &#9989; |
| [MyAnimeList Content Rating](both/content_rating_mal) | `content_rating_mal` | G, PG, PG-13, R, R+, Rx | &#9989; | &#9989; |
| [Content Rating (UK)](both/content_rating_uk) | `content_rating_uk` | U, PG, 12A | &#9989; | &#9989; |
| Content Rating (US) [Movie](movie/content_rating_us)/[Show](show/content_rating_us) | `content_rating_us` | G, PG, NC-17 | &#9989; | &#9989; |
| Country [Movie](movie/country)/[Show](show/country) | `country` | Belgium, India | &#9989; | &#9989; |
| Decade [Movie](movie/decade)/[Show](show/decade) | `decade` | Best of 2012, Best of 2022 | &#9989; | &#9989; |
| [Director](movie/director) | `director` | Steven Spielberg (Director), Olivia Wilde (Director) | &#9989; | &#10060; |
| Franchise [Movie](movie/franchise)/[Show](show/franchise) | `franchise` | Star Wars: Skywalker Saga, Godzilla (Anime) | &#9989; | &#9989; |
| [Genre](both/genre) | `genre` | Action, Drama, Science Fiction | &#9989; | &#9989; |
| [Network](show/network) | `network` | Disney Channel, Lifetime | &#10060; | &#9989; |
| [Producer](movie/producer) | `producer` | James Cameron (Producer), Reese Witherspoon (Producer) | &#9989; | &#10060; |
| [Resolution](both/resolution) | `resolution` | 4K Movies, 1080p Movies, 720p Movies | &#9989; | &#9989; |
| [Seasonal](movie/seasonal) | `seasonal` | Easter, Christmas | &#9989; | &#10060; |
| [Streaming](both/streaming) | `streaming` | Disney+ Movies, HBO Max Shows | &#9989; | &#9989; |
| [Studio](both/studio) | `studio` | DreamWorks Studios, Walt Disney Pictures | &#9989; | &#9989; |
| [Anime Studio](both/studio_anime) | `studio_anime` | Bones, Studio Ghibli, Toei Animation | &#9989; | &#9989; |
| Country [Movie](movie/country)/[Show](show/country) | `country` | Belgium, India | &#9989; | &#9989; |
| Decade [Movie](movie/decade)/[Show](show/decade) | `decade` | Best of 2012, Best of 2022 | &#9989; | &#9989; |
| [Director](movie/director) | `director` | Steven Spielberg (Director), Olivia Wilde (Director) | &#9989; | &#10060; |
| Franchise [Movie](movie/franchise)/[Show](show/franchise) | `franchise` | Star Wars: Skywalker Saga, Godzilla (Anime) | &#9989; | &#9989; |
| [Genre](both/genre) | `genre` | Action, Drama, Science Fiction | &#9989; | &#9989; |
| [Network](show/network) | `network` | Disney Channel, Lifetime | &#10060; | &#9989; |
| [Producer](movie/producer) | `producer` | James Cameron (Producer), Reese Witherspoon (Producer) | &#9989; | &#10060; |
| [Resolution](both/resolution) | `resolution` | 4K Movies, 1080p Movies, 720p Movies | &#9989; | &#9989; |
| [Seasonal](movie/seasonal) | `seasonal` | Easter, Christmas | &#9989; | &#10060; |
| [Streaming](both/streaming) | `streaming` | Disney+ Movies, HBO Max Shows | &#9989; | &#9989; |
| [Studio](both/studio) | `studio` | DreamWorks Studios, Walt Disney Pictures | &#9989; | &#9989; |
| [Anime Studio](both/studio_anime) | `studio_anime` | Bones, Studio Ghibli, Toei Animation | &#9989; | &#9989; |
| [Subtitle Language](both/subtitle_language) | `subtitle_language` | German Subtitles, Swedish Subtitles | &#9989; | &#9989; |
| [Universe](movie/universe) | `universe` | Marvel Cinematic Universal, Wizarding World | &#9989; | &#10060; |
| [Year](both/year) | `year` | Best of 2010, Best of 2019 | &#9989; | &#9989; |
| [Writer](movie/writer) | `writer` | James Cameron (Writer), Lilly Wachowski (Writer) | &#9989; | &#10060; |
| [Universe](movie/universe) | `universe` | Marvel Cinematic Universal, Wizarding World | &#9989; | &#10060; |
| [Year](both/year) | `year` | Best of 2010, Best of 2019 | &#9989; | &#9989; |
| [Writer](movie/writer) | `writer` | James Cameron (Writer), Lilly Wachowski (Writer) | &#9989; | &#10060; |

78
docs/defaults/collections.md
View file

@ -55,45 +55,45 @@ For example: `collection_section: 01` translates to `sort_title: "!<<collection_
This is the default PMM collection ordering:
| Collection | Collection Section |
|:-----------------------|:------------------:|
| `seasonal` | `00` |
| `anilist` | `01` |
| `basic` | `01` |
| `imdb` | `01` |
| `flixpatrol` | `01` |
| `myanimelist` | `01` |
| `other_chart` | `01` |
| `tautulli` | `01` |
| `tmdb` | `01` |
| `trakt` | `01` |
| `universe` | `02` |
| `streaming` | `03` |
| `network` | `04` |
| `genre` | `06` |
| `studio` | `07` |
| `country` | `09` |
| `audio_language` | `10` |
| `subtitle_language` | `11` |
| `decade` | `12` |
| `year` | `13` |
| `content_rating_us` | `14` |
| `content_rating_uk` | `14` |
| `content_rating_cs` | `14` |
| `resolution` | `15` |
| `resolution_standards` | `15` |
| `bafta` | `16` |
| `cannes` | `16` |
| `choice` | `16` |
| `emmy` | `16` |
| `golden` | `16` |
| `oscars` | `16` |
| `other_award` | `16` |
| `spirit` | `16` |
| `sundance` | `16` |
| `actor` | `17` |
| `director` | `18` |
| `producer` | `19` |
| `writer` | `20` |
|:-----------------------|:-------------------|
| `seasonal` | `00` |
| `anilist` | `01` |
| `basic` | `01` |
| `imdb` | `01` |
| `flixpatrol` | `01` |
| `myanimelist` | `01` |
| `other_chart` | `01` |
| `tautulli` | `01` |
| `tmdb` | `01` |
| `trakt` | `01` |
| `universe` | `02` |
| `streaming` | `03` |
| `network` | `04` |
| `genre` | `06` |
| `studio` | `07` |
| `country` | `09` |
| `audio_language` | `10` |
| `subtitle_language` | `11` |
| `decade` | `12` |
| `year` | `13` |
| `content_rating_us` | `14` |
| `content_rating_uk` | `14` |
| `content_rating_cs` | `14` |
| `resolution` | `15` |
| `resolution_standards` | `15` |
| `bafta` | `16` |
| `cannes` | `16` |
| `choice` | `16` |
| `emmy` | `16` |
| `golden` | `16` |
| `oscars` | `16` |
| `other_award` | `16` |
| `spirit` | `16` |
| `sundance` | `16` |
| `actor` | `17` |
| `director` | `18` |
| `producer` | `19` |
| `writer` | `20` |
## Customizing Configs

4
docs/defaults/files.md
View file

@ -14,6 +14,6 @@ These files apply playlists to the "Playlists" section of Plex and are applied b
### Playlist Files
| Default | path | Example Overlays |
|:---------------------|:----------:|:-------------------------------------------------------|
| Default | path | Example Overlays |
|:---------------------|:-----------|:-------------------------------------------------------|
| [Playlist](playlist) | `playlist` | Arrowverse (Timeline Order), Pokémon (Timeline Order) |

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

@ -10,11 +10,11 @@ If you do not use the US-based rating system within Plex, this file will attempt
## Collections Section 14
| Collection | Key | Description |
|:-------------------------------------------------------|:----------------------------------------:|:--------------------------------------------------------------------------------|
| `Country Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| Collection | Key | Description |
|:-------------------------------------------------------|:-----------------------------------------|:--------------------------------------------------------------------------------|
| `Country Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| `<<Content Rating>> Movies`<br>**Example:** `R Movies` | `<<Content Rating>>`<br>**Example:** `R` | Collection of Movies that have this Content Rating. |
| `Not Rated Movies` | `other` | Collection of Movies that are Unrated, Not Rated or any other uncommon Ratings. |
| `Not Rated Movies` | `other` | Collection of Movies that are Unrated, Not Rated or any other uncommon Ratings. |
## Config

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

@ -8,11 +8,11 @@ The `country` Default Metadata File is used to dynamically create collections ba
## Collections Section 09
| Collection | Key | Description |
|:----------------------------------------|:---------------------------------------:|:----------------------------------------------------------------------------|
| `Country Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| Collection | Key | Description |
|:----------------------------------------|:----------------------------------------|:----------------------------------------------------------------------------|
| `Country Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| `<<Country>>`<br>**Example:** `Germany` | `<<Country>>`<br>**Example:** `Germany` | Collection of Movies that have this Country. |
| `Other Countries` | `other` | Collection of Movies that are in other uncommon Countries. |
| `Other Countries` | `other` | Collection of Movies that are in other uncommon Countries. |
## Config

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

@ -8,9 +8,9 @@ The `decade` Default Metadata File is used to dynamically create collections bas
## Collections Section 12
| Collection | Key | Description |
|:-----------------------------------------------------|:---------------------------------:|:----------------------------------------------------------------------------|
| `Decade Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| Collection | Key | Description |
|:-----------------------------------------------------|:----------------------------------|:----------------------------------------------------------------------------|
| `Decade Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| `Best of <<Decade>>`<br>**Example:** `Best of 2020s` | `<<Year>>`<br>**Example:** `2020` | Collection of Movies released in this Decade. |
## Config

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

@ -8,9 +8,9 @@ The `director` Default Metadata File is used to dynamically create collections b
## Collections Section 18
| Collection | Key | Description |
|:---------------------------------------------------|:--------------------------------------------------:|:----------------------------------------------------------------------------|
| `Directors Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| Collection | Key | Description |
|:---------------------------------------------------|:---------------------------------------------------|:----------------------------------------------------------------------------|
| `Directors Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| `<<director_name>>`<br>**Example:** `Frank Welker` | `<<director_name>>`<br>**Example:** `Frank Welker` | Collection of Movies by the Director. |
### Rainier Style

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

@ -10,8 +10,8 @@ Unlike most Default Metadata Files, Franchise works by placing collections inlin
## Collections
| Collection | Key | Description |
|:-------------------------------------------------|:-------------------------------------------------:|:-------------------------------------------------------|
| Collection | Key | Description |
|:-------------------------------------------------|:--------------------------------------------------|:-------------------------------------------------------|
| `<<Collection Name>>`<br>**Example:** `Iron Man` | `<<TMDb Collection ID>>`<br>**Example:** `131292` | Collection of Movies found in this Collection on TMDb. |
## Config

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

@ -8,9 +8,9 @@ The `producer` Default Metadata File is used to dynamically create collections b
## Collections Section 19
| Collection | Key | Description |
|:---------------------------------------------------|:--------------------------------------------------:|:----------------------------------------------------------------------------|
| `Producer Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| Collection | Key | Description |
|:---------------------------------------------------|:---------------------------------------------------|:----------------------------------------------------------------------------|
| `Producer Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| `<<producer_name>>`<br>**Example:** `Frank Welker` | `<<producer_name>>`<br>**Example:** `Frank Welker` | Collection of Movies by th Producer. |
### Rainier Style

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

@ -8,21 +8,21 @@ The `seasonal` Default Metadata File is used to dynamically create seasonal coll
## Collections Section 00
| Collection | Key | Description |
|:-----------------------------|:--------------:|:----------------------------------------------------------------------------|
| `Seasonal Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| `🎊 New Year's Day Movies` | `years` | Collection of Movies related to New Year's Day. |
| `💘 Valentine's Day Movies` | `valentine` | Collection of Movies related to Valentine's Day. |
| `☘ St. Patrick's Day Movies` | `patrick` | Collection of Movies related to St. Patrick's Day. |
| `🐰 Easter Movies` | `easter` | Collection of Movies related to Easter. |
| `🤱 Mother's Day Movies` | `mother` | Collection of Movies related to Mother's Day. |
| `🪖 Memorial Day Movies` | `memorial` | Collection of Movies related to Memorial Day. |
| `👨 Father's Day Movies` | `father` | Collection of Movies related to Father's Day. |
| Collection | Key | Description |
|:-----------------------------|:---------------|:----------------------------------------------------------------------------|
| `Seasonal Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| `🎊 New Year's Day Movies` | `years` | Collection of Movies related to New Year's Day. |
| `💘 Valentine's Day Movies` | `valentine` | Collection of Movies related to Valentine's Day. |
| `☘ St. Patrick's Day Movies` | `patrick` | Collection of Movies related to St. Patrick's Day. |
| `🐰 Easter Movies` | `easter` | Collection of Movies related to Easter. |
| `🤱 Mother's Day Movies` | `mother` | Collection of Movies related to Mother's Day. |
| `🪖 Memorial Day Movies` | `memorial` | Collection of Movies related to Memorial Day. |
| `👨 Father's Day Movies` | `father` | Collection of Movies related to Father's Day. |
| `🎆 Independence Day Movies` | `independence` | Collection of Movies related to Independence Day. |
| `⚒ Labor Day Movies` | `labor` | Collection of Movies related to Labor Day. |
| `🎃 Halloween Movies` | `halloween` | Collection of Movies related to Halloween. |
| `⚒ Labor Day Movies` | `labor` | Collection of Movies related to Labor Day. |
| `🎃 Halloween Movies` | `halloween` | Collection of Movies related to Halloween. |
| `🦃 Thanksgiving Movies` | `thanksgiving` | Collection of Movies related to Thanksgiving. |
| `🎅 Christmas Movies` | `christmas` | Collection of Movies related to Christmas. |
| `🎅 Christmas Movies` | `christmas` | Collection of Movies related to Christmas. |
## Config

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

@ -10,21 +10,21 @@ This Default file requires [Trakt Authentication](../../config/trakt)
## Collections Section 02
| Collection | Key | Description |
|:----------------------------|:-----------:|:----------------------------------------------------------------------------|
| Collection | Key | Description |
|:----------------------------|:------------|:----------------------------------------------------------------------------|
| `Universe Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| `Star Wars Universe` | `star` | Collection of Movies in the Star Wars Universe |
| `DC Animated Universe` | `dca` | Collection of Movies in the DC Animated Universe |
| `DC Extended Universe` | `dcu` | Collection of Movies in the DC Extended Universe |
| `Marvel Cinematic Universe` | `mcu` | Collection of Movies in the Marvel Cinematic Universe |
| `Wizarding World` | `wizard` | Collection of Movies in the Wizarding World Universe |
| `Alien / Predator` | `avp` | Collection of Movies in the Alien / Predator Universe |
| `X-Men Universe` | `xmen` | Collection of Movies in the X-Men Universe |
| `Middle Earth` | `middle` | Collection of Movies in the Middle Earth Universe |
| `Fast & Furious` | `fast` | Collection of Movies in the Fast & Furious Universe |
| `Star Trek` | `trek` | Collection of Movies in the Star Trek Universe |
| `Rocky / Creed` | `rocky` | Collection of Movies in the Rocky / Creed Universe |
| `The Mummy Universe` | `mummy` | Collection of Movies in the The Mummy Universe |
| `Star Wars Universe` | `star` | Collection of Movies in the Star Wars Universe |
| `DC Animated Universe` | `dca` | Collection of Movies in the DC Animated Universe |
| `DC Extended Universe` | `dcu` | Collection of Movies in the DC Extended Universe |
| `Marvel Cinematic Universe` | `mcu` | Collection of Movies in the Marvel Cinematic Universe |
| `Wizarding World` | `wizard` | Collection of Movies in the Wizarding World Universe |
| `Alien / Predator` | `avp` | Collection of Movies in the Alien / Predator Universe |
| `X-Men Universe` | `xmen` | Collection of Movies in the X-Men Universe |
| `Middle Earth` | `middle` | Collection of Movies in the Middle Earth Universe |
| `Fast & Furious` | `fast` | Collection of Movies in the Fast & Furious Universe |
| `Star Trek` | `trek` | Collection of Movies in the Star Trek Universe |
| `Rocky / Creed` | `rocky` | Collection of Movies in the Rocky / Creed Universe |
| `The Mummy Universe` | `mummy` | Collection of Movies in the The Mummy Universe |
## Config

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

@ -8,9 +8,9 @@ The `writer` Default Metadata File is used to dynamically create collections bas
## Collections Section 20
| Collection | Key | Description |
|:-------------------------------------------------|:------------------------------------------------:|:----------------------------------------------------------------------------|
| `Writers Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| Collection | Key | Description |
|:-------------------------------------------------|:-------------------------------------------------|:----------------------------------------------------------------------------|
| `Writers Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| `<<writer_name>>`<br>**Example:** `Frank Welker` | `<<writer_name>>`<br>**Example:** `Frank Welker` | Collection of Movies by the Writer. |
### Rainier Style

34
docs/defaults/overlay_list.md
View file

@ -10,21 +10,21 @@ These overlays are applied by calling the below paths into the `overlay_path` [s
### Overlay Files
| Default | path | Example Overlays | Movies | Shows | Seasons | Episodes |
|:-----------------------------------------------|:----------------:|:--------------------------------------------------------------------------|:--------:|:---------:|:---------:|:--------:|
| [Audio Codec](overlays/audio_codec) | `audio_codec` | Dolby Atmos logo, DTS logo | &#9989; | &#9989; | &#9989; | &#9989; |
| [CommonSense Age Rating](overlays/commonsense) | `commonsense` | "3+", "16+" | &#9989; | &#9989; | &#10071; | &#10071; |
| [Direct Play](overlays/direct_play) | `direct_play` | "Direct Play Only" | &#9989; | &#10071; | &#10071; | &#9989; |
| [Episode Info](overlays/episode_info) | `episode_info` | "S01E01", "S02E09" | &#10060; | &#10060; | &#10060; | &#9989; |
| [FlixPatrol](overlays/flixpatrol) | `flixpatrol` | "Streaming service logo with words "TOP" | &#9989; | &#9989; | &#10060; | &#10060; |
| Default | path | Example Overlays | Movies | Shows | Seasons | Episodes |
|:-----------------------------------------------|:-----------------|:--------------------------------------------------------------------------|:--------:|:---------:|:---------:|:--------:|
| [Audio Codec](overlays/audio_codec) | `audio_codec` | Dolby Atmos logo, DTS logo | &#9989; | &#9989; | &#9989; | &#9989; |
| [CommonSense Age Rating](overlays/commonsense) | `commonsense` | "3+", "16+" | &#9989; | &#9989; | &#10071; | &#10071; |
| [Direct Play](overlays/direct_play) | `direct_play` | "Direct Play Only" | &#9989; | &#10071; | &#10071; | &#9989; |
| [Episode Info](overlays/episode_info) | `episode_info` | "S01E01", "S02E09" | &#10060; | &#10060; | &#10060; | &#9989; |
| [FlixPatrol](overlays/flixpatrol) | `flixpatrol` | "Streaming service logo with words "TOP" | &#9989; | &#9989; | &#10060; | &#10060; |
| [Language Count](overlays/language_count) | `language_count` | Dual-Audio, Multi-Audio, Dual-Subtitle, Multi-Subtitle | &#9989; | &#9989; | &#9989; | &#9989; |
| [Languages](overlays/languages) | `languages` | Flags Based on the Audio/Subtitles a file has | &#9989; | &#9989; | &#9989; | &#9989; |
| [Mediastinger](overlays/mediastinger) | `mediastinger` | Mediastinger Logo for After/During Credit Scenes | &#9989; | &#9989; | &#10060; | &#10060; |
| [Ratings](overlays/ratings) | `ratings` | IMDb Audience Rating, Metacritic Critic Rating | &#9989; | &#9989; | &#10060; | &#9989; |
| [Resolution/Editions](overlays/resolution) | `resolution` | 4K Dolby Vision logo, 720P logo, "Director's Cut", "Criterion Collection" | &#9989; | &#9989; | &#10060; | &#9989; |
| [Ribbon](overlays/ribbon) | `ribbon` | IMDb Top 250 Ribbon, RT Fresh Ribbon | &#9989; | &#9989; | &#10060; | &#10060; |
| [Runtimes](overlays/runtimes) | `runtimes` | "Runtime: 1h 30m" | &#9989; | &#9989; | &#10060; | &#10060; |
| [Status](overlays/status) | `status` | Airing, Returning, Canceled, Ended | &#10060; | &#9989; | &#10060; | &#10060; |
| [Streaming](overlays/streaming) | `streaming` | Netflix logo, Hulu logo | &#9989; | &#9989; | &#10060; | &#10060; |
| [Versions](overlays/versions) | `versions` | Multiple Versions logo | &#9989; | &#9989; | &#9989; | &#9989; |
| [Video Format](overlays/video_format) | `video_format` | "REMUX", "HDTV" | &#9989; | &#10071; | &#10071; | &#9989; |
| [Languages](overlays/languages) | `languages` | Flags Based on the Audio/Subtitles a file has | &#9989; | &#9989; | &#9989; | &#9989; |
| [Mediastinger](overlays/mediastinger) | `mediastinger` | Mediastinger Logo for After/During Credit Scenes | &#9989; | &#9989; | &#10060; | &#10060; |
| [Ratings](overlays/ratings) | `ratings` | IMDb Audience Rating, Metacritic Critic Rating | &#9989; | &#9989; | &#10060; | &#9989; |
| [Resolution/Editions](overlays/resolution) | `resolution` | 4K Dolby Vision logo, 720P logo, "Director's Cut", "Criterion Collection" | &#9989; | &#9989; | &#10060; | &#9989; |
| [Ribbon](overlays/ribbon) | `ribbon` | IMDb Top 250 Ribbon, RT Fresh Ribbon | &#9989; | &#9989; | &#10060; | &#10060; |
| [Runtimes](overlays/runtimes) | `runtimes` | "Runtime: 1h 30m" | &#9989; | &#9989; | &#10060; | &#10060; |
| [Status](overlays/status) | `status` | Airing, Returning, Canceled, Ended | &#10060; | &#9989; | &#10060; | &#10060; |
| [Streaming](overlays/streaming) | `streaming` | Netflix logo, Hulu logo | &#9989; | &#9989; | &#10060; | &#10060; |
| [Versions](overlays/versions) | `versions` | Multiple Versions logo | &#9989; | &#9989; | &#9989; | &#9989; |
| [Video Format](overlays/video_format) | `video_format` | "REMUX", "HDTV" | &#9989; | &#10071; | &#10071; | &#9989; |

48
docs/defaults/overlays/audio_codec.md
View file

@ -10,24 +10,24 @@ The `audio_codec` Default Overlay File is used to create an overlay based on the
## Supported Audio Codecs
| Audio Codec | Key | Weight |
|:-----------------------|:--------------:|:------:|
| Audio Codec | Key | Weight |
|:-----------------------|:---------------|:-------|
| Dolby TrueHD Atmos | `truehd_atmos` | `160` |
| DTS-X | `dtsx` | `150` |
| Dolby Digital+ / E-AC3 | `plus_atmos` | `140` |
| DTS-X | `dtsx` | `150` |
| Dolby Digital+ / E-AC3 | `plus_atmos` | `140` |
| Dolby Atmos | `dolby_atmos` | `130` |
| Dolby TrueHD | `truehd` | `120` |
| DTS-HD-MA | `ma` | `110` |
| FLAC | `flac` | `100` |
| PCM | `pcm` | `90` |
| DTS-HD-HRA | `hra` | `80` |
| Dolby Digital+ | `plus` | `70` |
| DTS-ES | `dtses` | `60` |
| DTS | `dts` | `50` |
| Dolby Digital | `digital` | `40` |
| AAC | `aac` | `30` |
| MP3 | `mp3` | `20` |
| Opus | `opus` | `10` |
| Dolby TrueHD | `truehd` | `120` |
| DTS-HD-MA | `ma` | `110` |
| FLAC | `flac` | `100` |
| PCM | `pcm` | `90` |
| DTS-HD-HRA | `hra` | `80` |
| Dolby Digital+ | `plus` | `70` |
| DTS-ES | `dtses` | `60` |
| DTS | `dts` | `50` |
| Dolby Digital | `digital` | `40` |
| AAC | `aac` | `30` |
| MP3 | `mp3` | `20` |
| Opus | `opus` | `10` |
### Standard Style
@ -63,15 +63,15 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Overlay Variables](../overlay_variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
| Variable | Default |
|:--------------------|:-----------:|
| `horizontal_offset` | `0` |
| `horizontal_align` | `center` |
| `vertical_offset` | `15` |
| `vertical_align` | `top` |
| Variable | Default |
|:--------------------|:------------|
| `horizontal_offset` | `0` |
| `horizontal_align` | `center` |
| `vertical_offset` | `15` |
| `vertical_align` | `top` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `105`/`189` |
| Variable | Description & Values |

20
docs/defaults/overlays/commonsense.md
View file

@ -11,7 +11,7 @@ Use the [Mass Content Rating Update Library Operation](../../config/operations.m
## Supported CommonSense Age Rating
| Rating | Key |
|:-------|:----:|
|:-------|:-----|
| 1+ | `1` |
| 2+ | `2` |
| 3+ | `3` |
@ -60,16 +60,16 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Overlay Variables](../overlay_variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
| Variable | Default |
|:--------------------|:-----------:|
| `horizontal_offset` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `270` |
| `vertical_align` | `bottom` |
| Variable | Default |
|:--------------------|:------------|
| `horizontal_offset` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `270` |
| `vertical_align` | `bottom` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `105` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `105` |
| Variable | Description & Values |
|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|

18
docs/defaults/overlays/direct_play.md
View file

@ -34,16 +34,16 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Overlay Variables](../overlay_variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
| Variable | Default |
|:--------------------|:-----------:|
| `horizontal_offset` | `0` |
| `horizontal_align` | `center` |
| `vertical_offset` | `150` |
| `vertical_align` | `bottom` |
| Variable | Default |
|:--------------------|:------------|
| `horizontal_offset` | `0` |
| `horizontal_align` | `center` |
| `vertical_offset` | `150` |
| `vertical_align` | `bottom` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `170` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `170` |
| Variable | Description & Values |
|:----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|

18
docs/defaults/overlays/episode_info.md
View file

@ -25,16 +25,16 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Overlay Variables](../overlay_variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
| Variable | Default |
|:--------------------|:-----------:|
| `horizontal_offset` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `270` |
| `vertical_align` | `bottom` |
| Variable | Default |
|:--------------------|:------------|
| `horizontal_offset` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `270` |
| `vertical_align` | `bottom` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `105` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `105` |
| Variable | Description & Values |
|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|

36
docs/defaults/overlays/flixpatrol.md
View file

@ -8,14 +8,14 @@ The `flixpatrol` Default Overlay File is used to create an overlay based on the
## Supported Services
| Service | Key | Weight |
|:------------|:-----------:|:------:|
| Netflix | `netflix` | `60` |
| Disney+ | `disney` | `50` |
| HBO | `hbo` | `40` |
| Hulu | `hulu` | `30` |
| Paramount+ | `paramount` | `20` |
| Prime Video | `prime` | `10` |
| Service | Key | Weight |
|:------------|:------------|:-------|
| Netflix | `netflix` | `60` |
| Disney+ | `disney` | `50` |
| HBO | `hbo` | `40` |
| Hulu | `hulu` | `30` |
| Paramount+ | `paramount` | `20` |
| Prime Video | `prime` | `10` |
## Config
@ -39,17 +39,17 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Overlay Variables](../overlay_variables) except `horizontal_offset`, `horizontal_align`, `vertical_offset`, and `vertical_align` are available with the default values below as well as the additional Variables below which can be used to customize the file.
| Variable | Default |
|:--------------------|:-----------------:|
| `horizontal_offset` | `30` |
| `horizontal_align` | `left`/`right` |
| Variable | Default |
|:--------------------|:------------------|
| `horizontal_offset` | `30` |
| `horizontal_align` | `left`/`right` |
| `vertical_offset` | `465`/`670`/`875` |
| `vertical_align` | `top` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `160` |
| `back_height` | `160` |
| `back_padding` | `15` |
| `vertical_align` | `top` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `160` |
| `back_height` | `160` |
| `back_padding` | `15` |
| Variable | Description & Values |
|:----------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

26
docs/defaults/overlays/language_count.md
View file

@ -10,10 +10,10 @@ The `language_count` Default Overlay File is used to create an overlay based on
## Supported Audio/Subtitle Languages
| Audio/Subtitle Languages | Key | Weight |
|:-------------------------|:-------:|:------:|
| Dual | `dual` | `20` |
| Multi | `multi` | `10` |
| Audio/Subtitle Languages | Key | Weight |
|:-------------------------|:--------|:-------|
| Dual | `dual` | `20` |
| Multi | `multi` | `10` |
## Config
@ -43,16 +43,16 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Overlay Variables](../overlay_variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
| Variable | Default |
|:--------------------|:-----------:|
| `horizontal_offset` | `0` |
| `horizontal_align` | `center` |
| `vertical_offset` | `30` |
| `vertical_align` | `bottom` |
| Variable | Default |
|:--------------------|:------------|
| `horizontal_offset` | `0` |
| `horizontal_align` | `center` |
| `vertical_offset` | `30` |
| `vertical_align` | `bottom` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `188` |
| `back_height` | `105` |
| `back_radius` | `30` |
| `back_width` | `188` |
| `back_height` | `105` |
| Variable | Description & Values |
|:-----------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

146
docs/defaults/overlays/languages.md
View file

@ -11,68 +11,68 @@ The `languages` Default Overlay File is used to create an overlay of a flag and
## Supported Audio/Subtitle Language Flags
| Audio/Subtitle Languages | Key | Weight | Default Flag | Default Use |
|:-------------------------|:----:|:------:|:------------:|:-----------:|
| English | `en` | `610` | `us` | &#9989; |
| German | `de` | `600` | `de` | &#9989; |
| French | `fr` | `590` | `fr` | &#9989; |
| Spanish | `es` | `580` | `es` | &#9989; |
| Portuguese | `pt` | `570` | `pt` | &#9989; |
| Japanese | `ja` | `560` | `jp` | &#9989; |
| Korean | `ko` | `550` | `kr` | &#10060; |
| Chinese | `zh` | `540` | `cn` | &#10060; |
| Danish | `da` | `530` | `dk` | &#10060; |
| Russian | `ru` | `520` | `ru` | &#10060; |
| Italian | `it` | `510` | `it` | &#10060; |
| Hindi | `hi` | `500` | `in` | &#10060; |
| Telugu | `te` | `490` | `in` | &#10060; |
| Farsi | `fa` | `480` | `ir` | &#10060; |
| Thai | `th` | `470` | `th` | &#10060; |
| Dutch | `nl` | `460` | `nl` | &#10060; |
| Norwegian | `no` | `450` | `no` | &#10060; |
| Icelandic | `is` | `440` | `is` | &#10060; |
| Swedish | `sv` | `430` | `se` | &#10060; |
| Turkish | `tr` | `420` | `tr` | &#10060; |
| Polish | `pl` | `410` | `pl` | &#10060; |
| Czech | `cs` | `400` | `cz` | &#10060; |
| Ukrainian | `uk` | `390` | `ua` | &#10060; |
| Hungarian | `hu` | `380` | `hu` | &#10060; |
| Arabic | `ar` | `370` | `eg` | &#10060; |
| Bulgarian | `bg` | `360` | `bg` | &#10060; |
| Bengali | `bn` | `350` | `bd` | &#10060; |
| Bosnian | `bs` | `340` | `ba` | &#10060; |
| Catalan | `ca` | `330` | `es` | &#10060; |
| Welsh | `cy` | `320` | `uk` | &#10060; |
| Greek | `el` | `310` | `gr` | &#10060; |
| Estonian | `et` | `300` | `ee` | &#10060; |
| Basque | `eu` | `290` | `es` | &#10060; |
| Finnish | `fi` | `280` | `fi` | &#10060; |
| Filipino | `fl` | `270` | `ph` | &#10060; |
| Galician | `gl` | `260` | `es` | &#10060; |
| Hebrew | `he` | `250` | `il` | &#10060; |
| Croatian | `hr` | `240` | `hr` | &#10060; |
| Indonesian | `id` | `230` | `id` | &#10060; |
| Georgian | `ka` | `220` | `ge` | &#10060; |
| Kazakh | `kk` | `210` | `kz` | &#10060; |
| Kannada | `kn` | `200` | `in` | &#10060; |
| Latin | `la` | `190` | `it` | &#10060; |
| Lithuanian | `lt` | `180` | `lt` | &#10060; |
| Latvian | `lv` | `170` | `lv` | &#10060; |
| Macedonian | `mk` | `160` | `mk` | &#10060; |
| Malayalam | `ml` | `150` | `in` | &#10060; |
| Marathi | `mr` | `140` | `in` | &#10060; |
| Malay | `ms` | `130` | `my` | &#10060; |
| Norwegian Nokmål | `nb` | `120` | `no` | &#10060; |
| Norwegian Nynorsk | `nn` | `110` | `no` | &#10060; |
| Punjabi | `pa` | `100` | `in` | &#10060; |
| Romanian | `ro` | `90` | `ro` | &#10060; |
| Slovak | `sk` | `80` | `sk` | &#10060; |
| Slovenian | `sv` | `70` | `si` | &#10060; |
| Albanian | `sq` | `60` | `al` | &#10060; |
| Serbian | `sr` | `50` | `rs` | &#10060; |
| Swahili | `sw` | `40` | `tz` | &#10060; |
| Tamil | `ta` | `30` | `in` | &#10060; |
| Urdu | `ur` | `20` | `pk` | &#10060; |
| Vietnamese | `vi` | `10` | `vn` | &#10060; |
|:-------------------------|:-----|:-------|:-------------|:-----------:|
| English | `en` | `610` | `us` | &#9989; |
| German | `de` | `600` | `de` | &#9989; |
| French | `fr` | `590` | `fr` | &#9989; |
| Spanish | `es` | `580` | `es` | &#9989; |
| Portuguese | `pt` | `570` | `pt` | &#9989; |
| Japanese | `ja` | `560` | `jp` | &#9989; |
| Korean | `ko` | `550` | `kr` | &#10060; |
| Chinese | `zh` | `540` | `cn` | &#10060; |
| Danish | `da` | `530` | `dk` | &#10060; |
| Russian | `ru` | `520` | `ru` | &#10060; |
| Italian | `it` | `510` | `it` | &#10060; |
| Hindi | `hi` | `500` | `in` | &#10060; |
| Telugu | `te` | `490` | `in` | &#10060; |
| Farsi | `fa` | `480` | `ir` | &#10060; |
| Thai | `th` | `470` | `th` | &#10060; |
| Dutch | `nl` | `460` | `nl` | &#10060; |
| Norwegian | `no` | `450` | `no` | &#10060; |
| Icelandic | `is` | `440` | `is` | &#10060; |
| Swedish | `sv` | `430` | `se` | &#10060; |
| Turkish | `tr` | `420` | `tr` | &#10060; |
| Polish | `pl` | `410` | `pl` | &#10060; |
| Czech | `cs` | `400` | `cz` | &#10060; |
| Ukrainian | `uk` | `390` | `ua` | &#10060; |
| Hungarian | `hu` | `380` | `hu` | &#10060; |
| Arabic | `ar` | `370` | `eg` | &#10060; |
| Bulgarian | `bg` | `360` | `bg` | &#10060; |
| Bengali | `bn` | `350` | `bd` | &#10060; |
| Bosnian | `bs` | `340` | `ba` | &#10060; |
| Catalan | `ca` | `330` | `es` | &#10060; |
| Welsh | `cy` | `320` | `uk` | &#10060; |
| Greek | `el` | `310` | `gr` | &#10060; |
| Estonian | `et` | `300` | `ee` | &#10060; |
| Basque | `eu` | `290` | `es` | &#10060; |
| Finnish | `fi` | `280` | `fi` | &#10060; |
| Filipino | `fl` | `270` | `ph` | &#10060; |
| Galician | `gl` | `260` | `es` | &#10060; |
| Hebrew | `he` | `250` | `il` | &#10060; |
| Croatian | `hr` | `240` | `hr` | &#10060; |
| Indonesian | `id` | `230` | `id` | &#10060; |
| Georgian | `ka` | `220` | `ge` | &#10060; |
| Kazakh | `kk` | `210` | `kz` | &#10060; |
| Kannada | `kn` | `200` | `in` | &#10060; |
| Latin | `la` | `190` | `it` | &#10060; |
| Lithuanian | `lt` | `180` | `lt` | &#10060; |
| Latvian | `lv` | `170` | `lv` | &#10060; |
| Macedonian | `mk` | `160` | `mk` | &#10060; |
| Malayalam | `ml` | `150` | `in` | &#10060; |
| Marathi | `mr` | `140` | `in` | &#10060; |
| Malay | `ms` | `130` | `my` | &#10060; |
| Norwegian Nokmål | `nb` | `120` | `no` | &#10060; |
| Norwegian Nynorsk | `nn` | `110` | `no` | &#10060; |
| Punjabi | `pa` | `100` | `in` | &#10060; |
| Romanian | `ro` | `90` | `ro` | &#10060; |
| Slovak | `sk` | `80` | `sk` | &#10060; |
| Slovenian | `sv` | `70` | `si` | &#10060; |
| Albanian | `sq` | `60` | `al` | &#10060; |
| Serbian | `sr` | `50` | `rs` | &#10060; |
| Swahili | `sw` | `40` | `tz` | &#10060; |
| Tamil | `ta` | `30` | `in` | &#10060; |
| Urdu | `ur` | `20` | `pk` | &#10060; |
| Vietnamese | `vi` | `10` | `vn` | &#10060; |
### Square Style
@ -114,19 +114,19 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Overlay Variables](../overlay_variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
| Variable | Default |
|:--------------------|:----------------------------:|
| Variable | Default |
|:--------------------|:-----------------------------|
| `horizontal_offset` | `15`/`206`/`397`/`588`/`779` |
| `horizontal_align` | `left`/`right`/`center` |
| `horizontal_align` | `left`/`right`/`center` |
| `vertical_offset` | `15`/`76`/`137`/`198`/`259` |
| `vertical_align` | `top`/`bottom`/`center` |
| `back_color` | `#00000099` |
| `back_radius` | `26`/` ` |
| `back_width` | `190` |
| `back_height` | `105` |
| `back_align` | `left`/`right` |
| `font` | `fonts/Inter-Bold.ttf` |
| `font_size` | `50` |
| `vertical_align` | `top`/`bottom`/`center` |
| `back_color` | `#00000099` |
| `back_radius` | `26`/` ` |
| `back_width` | `190` |
| `back_height` | `105` |
| `back_align` | `left`/`right` |
| `font` | `fonts/Inter-Bold.ttf` |
| `font_size` | `50` |
| Variable | Description & Values |
|:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

18
docs/defaults/overlays/mediastinger.md
View file

@ -25,16 +25,16 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Overlay Variables](../overlay_variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
| Variable | Default |
|:--------------------|:-----------:|
| `horizontal_offset` | `200` |
| `horizontal_align` | `right` |
| `vertical_offset` | `15` |
| `vertical_align` | `top` |
| Variable | Default |
|:--------------------|:------------|
| `horizontal_offset` | `200` |
| `horizontal_align` | `right` |
| `vertical_offset` | `15` |
| `vertical_align` | `top` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `105` |
| `back_height` | `105` |
| `back_radius` | `30` |
| `back_width` | `105` |
| `back_height` | `105` |
The below is an example config.yml extract with some Template Variables added in to change how the file works.

24
docs/defaults/overlays/ratings.md
View file

@ -64,19 +64,19 @@ All [Shared Overlay Variables](../overlay_variables) are available with the defa
All [Shared Overlay Variables](../overlay_variables) can be appended by `rating1_`, `rating2_`, or `rating3_` to change that attribute on each rating individually.
| Variable | Default |
|:--------------------|:-----------:|
| `horizontal_offset` | `200` |
| `horizontal_align` | `right` |
| `vertical_offset` | `15` |
| `vertical_align` | `top` |
| Variable | Default |
|:--------------------|:------------|
| `horizontal_offset` | `200` |
| `horizontal_align` | `right` |
| `vertical_offset` | `15` |
| `vertical_align` | `top` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `105` |
| `back_height` | `105` |
| `back_padding` | `15` |
| `back_radius` | `30` |
| `back_height` | `105` |
| `back_radius` | `30` |
| `back_width` | `105` |
| `back_height` | `105` |
| `back_padding` | `15` |
| `back_radius` | `30` |
| `back_height` | `105` |
| Variable | Description & Values |
|:-----------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

66
docs/defaults/overlays/resolution.md
View file

@ -10,35 +10,35 @@ The `resolution` Default Overlay File is used to create an overlay based on the
## Supported Resolutions
| Resolution | Key |
|:---------------|:---------:|
| 4K | `4k` |
| 1080P | `1080p` |
| 720P | `720p` |
| 576P | `576p` |
| 480P | `480p` |
| DV | `dv` |
| HDR | `hdr` |
| Resolution | Key |
|:---------------|:----------|
| 4K | `4k` |
| 1080P | `1080p` |
| 720P | `720p` |
| 576P | `576p` |
| 480P | `480p` |
| DV | `dv` |
| HDR | `hdr` |
## Supported Editions
| Edition | Key | Weight |
|:--------------------|:---------------:|:------:|
| Edition | Key | Weight |
|:--------------------|:----------------|:-------|
| Director's Cut | `directorscut` | `150` |
| Extended Edition | `extended` | `140` |
| Uncut Edition | `uncut` | `130` |
| Unrated Edition | `unrated` | `120` |
| Special Edition | `special` | `110` |
| Final Cut | `finalcut` | `100` |
| Anniversary Edition | `anniversary` | `90` |
| Collector's Edition | `collector` | `80` |
| International Cut | `international` | `70` |
| Theatrical Cut | `theatrical` | `60` |
| Ultimate Cut | `ultimate` | `50` |
| IMAX Enhanced | `enhanced` | `40` |
| IMAX | `imax` | `30` |
| Remastered | `remastered` | `20` |
| Criterion | `criterion` | `10` |
| Extended Edition | `extended` | `140` |
| Uncut Edition | `uncut` | `130` |
| Unrated Edition | `unrated` | `120` |
| Special Edition | `special` | `110` |
| Final Cut | `finalcut` | `100` |
| Anniversary Edition | `anniversary` | `90` |
| Collector's Edition | `collector` | `80` |
| International Cut | `international` | `70` |
| Theatrical Cut | `theatrical` | `60` |
| Ultimate Cut | `ultimate` | `50` |
| IMAX Enhanced | `enhanced` | `40` |
| IMAX | `imax` | `30` |
| Remastered | `remastered` | `20` |
| Criterion | `criterion` | `10` |
## Config
@ -68,15 +68,15 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Overlay Variables](../overlay_variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
| Variable | Default |
|:--------------------|:-----------:|
| `horizontal_offset` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `15` |
| `vertical_align` | `top` |
| Variable | Default |
|:--------------------|:------------|
| `horizontal_offset` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `15` |
| `vertical_align` | `top` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `105`/`189` |
| Variable | Description & Values |

20
docs/defaults/overlays/ribbon.md
View file

@ -8,13 +8,13 @@ The `ribbon` Default Overlay File is used to create a ribbon overlay based on th
## Supported Ribbon
| Ribbon | Key | Weight |
|:--------------------------------|:------------:|:------:|
| Oscars Best Picture | `oscars` | `50` |
| IMDb Top 250 | `imdb` | `40` |
| Rotten Tomatoes Certified Fresh | `rotten` | `30` |
| Metacritic Must See | `metacritic` | `20` |
| Commonsense Selection | `common` | `10` |
| Ribbon | Key | Weight |
|:--------------------------------|:-------------|:-------|
| Oscars Best Picture | `oscars` | `50` |
| IMDb Top 250 | `imdb` | `40` |
| Rotten Tomatoes Certified Fresh | `rotten` | `30` |
| Metacritic Must See | `metacritic` | `20` |
| Commonsense Selection | `common` | `10` |
## Config
@ -39,10 +39,10 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Overlay Variables](../overlay_variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
| Variable | Default |
|:--------------------|:--------:|
| `horizontal_offset` | `0` |
|:--------------------|:---------|
| `horizontal_offset` | `0` |
| `horizontal_align` | `right` |
| `vertical_offset` | `0` |
| `vertical_offset` | `0` |
| `vertical_align` | `bottom` |
| Variable | Description & Values |

18
docs/defaults/overlays/runtimes.md
View file

@ -28,16 +28,16 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Overlay Variables](../overlay_variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
| Variable | Default |
|:--------------------|:-----------:|
| `horizontal_offset` | `15` |
| `horizontal_align` | `right` |
| `vertical_offset` | `30` |
| `vertical_align` | `bottom` |
| Variable | Default |
|:--------------------|:------------|
| `horizontal_offset` | `15` |
| `horizontal_align` | `right` |
| `vertical_offset` | `30` |
| `vertical_align` | `bottom` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `600` |
| `back_height` | `105` |
| `back_radius` | `30` |
| `back_width` | `600` |
| `back_height` | `105` |
| Variable | Description & Values |
|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|

30
docs/defaults/overlays/status.md
View file

@ -8,12 +8,12 @@ The `status` Default Overlay File is used to create an overlay on a show detaili
## Supported Status
| Audio Codec | Key | Weight |
|:------------|:-----------:|:------:|
| AIRING | `airing` | `40` |
| RETURNING | `returning` | `30` |
| CANCELED | `canceled` | `20` |
| ENDED | `ended` | `10` |
| Audio Codec | Key | Weight |
|:------------|:------------|:-------|
| AIRING | `airing` | `40` |
| RETURNING | `returning` | `30` |
| CANCELED | `canceled` | `20` |
| ENDED | `ended` | `10` |
## Config
@ -37,16 +37,16 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Overlay Variables](../overlay_variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
| Variable | Default |
|:--------------------|:-----------:|
| `horizontal_offset` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `330` |
| `vertical_align` | `top` |
| Variable | Default |
|:--------------------|:------------|
| `horizontal_offset` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `330` |
| `vertical_align` | `top` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `105` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `105` |
| Variable | Description & Values |
|:-----------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

52
docs/defaults/overlays/streaming.md
View file

@ -8,24 +8,24 @@ The `streaming` Default Overlay File is used to create an overlay based on the s
## Supported Streaming Services
| Streaming Service | Key | Weight |
|:------------------|:-------------:|:------:|
| Netflix | `netflix` | `160` |
| Prime Video | `amazon` | `150` |
| Disney+ | `disney` | `140` |
| HBO Max | `hbomax` | `130` |
| Streaming Service | Key | Weight |
|:------------------|:--------------|:-------|
| Netflix | `netflix` | `160` |
| Prime Video | `amazon` | `150` |
| Disney+ | `disney` | `140` |
| HBO Max | `hbomax` | `130` |
| Crunchyroll | `Crunchyroll` | `120` |
| YouTube | `youtube` | `110` |
| Hulu | `hulu` | `100` |
| Paramount+ | `paramount` | `90` |
| AppleTV | `appletv` | `80` |
| Peacock | `peacock` | `70` |
| Showtime | `showtime` | `60` |
| NOW | `now` | `50` |
| All 4 | `all4` | `40` |
| britbox | `britbox` | `30` |
| BET+ | `bet` | `20` |
| hayu | `hayu` | `10` |
| YouTube | `youtube` | `110` |
| Hulu | `hulu` | `100` |
| Paramount+ | `paramount` | `90` |
| AppleTV | `appletv` | `80` |
| Peacock | `peacock` | `70` |
| Showtime | `showtime` | `60` |
| NOW | `now` | `50` |
| All 4 | `all4` | `40` |
| britbox | `britbox` | `30` |
| BET+ | `bet` | `20` |
| hayu | `hayu` | `10` |
## Config
@ -50,16 +50,16 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Overlay Variables](../overlay_variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
| Variable | Default |
|:--------------------|:-----------:|
| `horizontal_offset` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `150` |
| `vertical_align` | `bottom` |
| Variable | Default |
|:--------------------|:------------|
| `horizontal_offset` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `150` |
| `vertical_align` | `bottom` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `105` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `105` |
| Variable | Description & Values |
|:-----------------------------|:-------------------------------------------------------------------------------------------------------------|

18
docs/defaults/overlays/versions.md
View file

@ -34,16 +34,16 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Overlay Variables](../overlay_variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
| Variable | Default |
|:--------------------|:----------------:|
| `horizontal_offset` | `15`/`235` |
| Variable | Default |
|:--------------------|:-----------------|
| `horizontal_offset` | `15`/`235` |
| `horizontal_align` | `right`/`center` |
| `vertical_offset` | `1050`/`15` |
| `vertical_align` | `top` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `105` |
| `back_height` | `105` |
| `vertical_offset` | `1050`/`15` |
| `vertical_align` | `top` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `105` |
| `back_height` | `105` |
| Variable | Description & Values |
|:----------------|:--------------------------------------------------------------------------------|

34
docs/defaults/overlays/video_format.md
View file

@ -10,14 +10,14 @@ The `video_format` Default Overlay File is used to create an overlay based on th
## Supported Video Formats
| Video Format | Key | Weight |
|:-------------|:--------:|:------:|
| REMUX | `remux` | `60` |
| BLU-RAY | `bluray` | `50` |
| WEB | `web` | `40` |
| HDTV | `hdtv` | `30` |
| DVD | `dvd` | `20` |
| SDTV | `sdtv` | `10` |
| Video Format | Key | Weight |
|:-------------|:---------|:-------|
| REMUX | `remux` | `60` |
| BLU-RAY | `bluray` | `50` |
| WEB | `web` | `40` |
| HDTV | `hdtv` | `30` |
| DVD | `dvd` | `20` |
| SDTV | `sdtv` | `10` |
## Config
@ -47,16 +47,16 @@ Note that the `templates_variables:` section only needs to be used if you do wan
All [Shared Overlay Variables](../overlay_variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
| Variable | Default |
|:--------------------|:-----------:|
| `horizontal_offset` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `30` |
| `vertical_align` | `bottom` |
| Variable | Default |
|:--------------------|:------------|
| `horizontal_offset` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `30` |
| `vertical_align` | `bottom` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `105` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `105` |
| Variable | Description & Values |
|:-----------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

14
docs/defaults/playlist.md
View file

@ -8,16 +8,16 @@ This Default file requires [Trakt Authentication](../config/trakt)
## Playlists
| Playlist | Key | Description |
|:---------------------------------------------|:-----------:|:----------------------------------------------------------------------------------|
| `Arrowverse (Timeline Order)` | `arrow` | Playlist of Movies and Episodes in the Arrowverse (Timeline Order) |
| `Marvel Cinematic Universe (Timeline Order)` | `mcu` | Playlist of Movies and Episodes in the Marvel Cinematic Universe (Timeline Order) |
| `DC Animated Universe (Timeline Order)` | `dcau` | Playlist of Movies and Episodes in the DC Animated Universe (Timeline Order) |
| `Pokémon (Timeline Order)` | `pokemon` | Playlist of Movies and Episodes in the Pokémon (Timeline Order) |
| Playlist | Key | Description |
|:---------------------------------------------|:------------|:----------------------------------------------------------------------------------|
| `Arrowverse (Timeline Order)` | `arrow` | Playlist of Movies and Episodes in the Arrowverse (Timeline Order) |
| `Marvel Cinematic Universe (Timeline Order)` | `mcu` | Playlist of Movies and Episodes in the Marvel Cinematic Universe (Timeline Order) |
| `DC Animated Universe (Timeline Order)` | `dcau` | Playlist of Movies and Episodes in the DC Animated Universe (Timeline Order) |
| `Pokémon (Timeline Order)` | `pokemon` | Playlist of Movies and Episodes in the Pokémon (Timeline Order) |
| `Star Trek (Timeline Order)` | `startrek` | Playlist of Movies and Episodes in the Star Trek (Timeline Order) |
| `Star Wars (Timeline Order)` | `starwars` | Playlist of Movies and Episodes in the Star Wars (Timeline Order) |
| `Star Wars The Clone Wars (Timeline Order)` | `clonewars` | Playlist of Movies and Episodes in the Star Wars The Clone Wars (Timeline Order) |
| `X-Men (Timeline Order)` | `xmen` | Playlist of Movies and Episodes in the X-Men (Timeline Order) |
| `X-Men (Timeline Order)` | `xmen` | Playlist of Movies and Episodes in the X-Men (Timeline Order) |
## Config

56
docs/defaults/separators.md
View file

@ -12,27 +12,27 @@ Below is an example of a separator, which can be seen surrounded by a red square
These are all the files that contain a separator.
| Collection Name | Default File | Collection Section |
|:------------------------------|:-------------------:|:------------------:|
| Seasonal Collections | `seasonal` | `00` |
| Chart Collections | `separator_chart` | `01` |
| Universe Collections | `universe` | `02` |
| Streaming Collections | `streaming` | `03` |
| Network Collections | `network` | `04` |
| Genre Collections | `genre` | `06` |
| Studio Collections | `studio` | `07` |
| Country Collections | `country` | `09` |
| Audio Language Collections | `audio_language` | `10` |
| Subtitle Language Collections | `subtitle_language` | `11` |
| Decade Collections | `decade` | `12` |
| Year Collections | `year` | `13` |
| Ratings Collections | `content_rating*` | `14` |
| Resolution Collections | `resolution*` | `15` |
| Award Collections | `separator_award` | `16` |
| Actors Collections | `actor` | `17` |
| Directors Collections | `director` | `18` |
| Producers Collections | `producer` | `19` |
| Writers Collections | `writer` | `20` |
| Collection Name | Default File | Collection Section |
|-------------------------------|:--------------------|:-------------------|
| Seasonal Collections | `seasonal` | `00` |
| Chart Collections | `separator_chart` | `01` |
| Universe Collections | `universe` | `02` |
| Streaming Collections | `streaming` | `03` |
| Network Collections | `network` | `04` |
| Genre Collections | `genre` | `06` |
| Studio Collections | `studio` | `07` |
| Country Collections | `country` | `09` |
| Audio Language Collections | `audio_language` | `10` |
| Subtitle Language Collections | `subtitle_language` | `11` |
| Decade Collections | `decade` | `12` |
| Year Collections | `year` | `13` |
| Ratings Collections | `content_rating*` | `14` |
| Resolution Collections | `resolution*` | `15` |
| Award Collections | `separator_award` | `16` |
| Actors Collections | `actor` | `17` |
| Directors Collections | `director` | `18` |
| Producers Collections | `producer` | `19` |
| Writers Collections | `writer` | `20` |
## Shared Separator Variables
@ -85,15 +85,15 @@ Multiple styles are available for Separators, to match Plex's "categories" featu
The available styles available are:
| Style | Value |
|:---------|:--------:|
| Original | `orig` |
| Blue | `blue` |
| Brown | `stb` |
| Gray | `gray` |
| Style | Value |
|:---------|:---------|
| Original | `orig` |
| Blue | `blue` |
| Brown | `stb` |
| Gray | `gray` |
| Green | `green` |
| Purple | `purple` |
| Red | `red` |
| Red | `red` |
This image shows an example separator in each of the above styles

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

@ -10,11 +10,11 @@ If you do not use the US-based rating system within Plex, this file will attempt
## Collections Section 14
| Collection | Key | Description |
|:---------------------------------------------------------|:--------------------------------------------:|:-------------------------------------------------------------------------------|
| `Ratings Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| Collection | Key | Description |
|:---------------------------------------------------------|:---------------------------------------------|:-------------------------------------------------------------------------------|
| `Ratings Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| `<<Content Rating>> Shows`<br>**Example:** `TV-14 Shows` | `<<Content Rating>>`<br>**Example:** `TV-14` | Collection of Shows that have this Content Rating. |
| `Not Rated Shows` | `other` | Collection of Shows that are Unrated, Not Rated or any other uncommon Ratings. |
| `Not Rated Shows` | `other` | Collection of Shows that are Unrated, Not Rated or any other uncommon Ratings. |
## Config

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

@ -8,11 +8,11 @@ The `country` Default Metadata File is used to dynamically create collections ba
## Collections Section 09
| Collection | Key | Description |
|:----------------------------------------|:--------------------------------------------------:|:----------------------------------------------------------------------------|
| `Country Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| Collection | Key | Description |
|:----------------------------------------|:---------------------------------------------------|:----------------------------------------------------------------------------|
| `Country Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| `<<Country>>`<br>**Example:** `Germany` | `<<2 digit ISO 3166-1 code>>`<br>**Example:** `de` | Collection of TV Shows that have this Country. |
| `Other Countries` | `other` | Collection of TV Shows that are in other uncommon Countries. |
| `Other Countries` | `other` | Collection of TV Shows that are in other uncommon Countries. |
## Config

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

@ -8,9 +8,9 @@ The `decade` Metadata File is used to dynamically create collections based on th
## Collections Section 12
| Collection | Key | Description |
|:-----------------------------------------------------|:---------------------------------:|:----------------------------------------------------------------------------|
| `Decade Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| Collection | Key | Description |
|:-----------------------------------------------------|:----------------------------------|:----------------------------------------------------------------------------|
| `Decade Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| `Best of <<Decade>>`<br>**Example:** `Best of 2020s` | `<<Year>>`<br>**Example:** `2020` | Collection of Shows released in this Decade. |
## Config

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

@ -10,8 +10,8 @@ Unlike most Default Metadata Files, Franchise works by placing collections inlin
## Collections
| Collection | Key | Description |
|:------------------------------------------------------------|:---------------------------------------------------:|:---------------------------------------------------|
| Collection | Key | Description |
|:------------------------------------------------------------|:----------------------------------------------------|:---------------------------------------------------|
| `<<Collection Name>>`<br>**Example:** `Pretty Little Liars` | `<<Starting TMDb Show ID>>`<br>**Example:** `31917` | Collection of Shows specified for this Collection. |
## Config

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

@ -8,9 +8,9 @@ The `network` Default Metadata File is used to dynamically create collections ba
## Collections Section 04
| Collection | Key | Description |
|:------------------------------------|:-----------------------------------:|:----------------------------------------------------------------------------|
| `Network Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| Collection | Key | Description |
|:------------------------------------|:------------------------------------|:----------------------------------------------------------------------------|
| `Network Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| `<<network>>`<br>**Example:** `NBC` | `<<network>>`<br>**Example:** `NBC` | Collection of Shows the aired on the network. |
## Config