diff --git a/VERSION b/VERSION index cc22b5b2..64de7d11 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.20.0-develop9 +1.20.0-develop10 diff --git a/docs/config/auth.md b/docs/config/auth.md new file mode 100644 index 00000000..0adab8ef --- /dev/null +++ b/docs/config/auth.md @@ -0,0 +1,3 @@ +# Trakt and MyAnimeList Authentication + + \ No newline at end of file diff --git a/docs/config/myanimelist.md b/docs/config/myanimelist.md index 056986b9..bfe40642 100644 --- a/docs/config/myanimelist.md +++ b/docs/config/myanimelist.md @@ -124,13 +124,10 @@ To authenticate MyAnimeList the first time, you need run the container with the OAuth flow mentioned above. Once you have the MyAnimeList authentication data saved into the YAML, you'll be able to run the container normally. -## Online Authorization Script +## Online Authorization 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. +NAS) make this difficult to accomplish. Chazlarson has provided an online tool 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. \ No newline at end of file +The tool can be found [here](auth.md). \ No newline at end of file diff --git a/docs/config/settings.md b/docs/config/settings.md index 73726645..592658a8 100644 --- a/docs/config/settings.md +++ b/docs/config/settings.md @@ -1072,9 +1072,9 @@ libraries: settings: run_order: #(3)! - operations - - metadata + - overlays - collections - - operations + - metadata minimum_items: 1 #(4)! ``` diff --git a/docs/config/trakt.md b/docs/config/trakt.md index f05b1d31..711bfac1 100644 --- a/docs/config/trakt.md +++ b/docs/config/trakt.md @@ -49,13 +49,10 @@ To connect to Trakt.tv you must create a Trakt application and supply Plex Meta Run Plex Meta Manager shortly after obtaining your PIN; the PIN may expire at some point. -## Online Authorization Script +## Online Authorization 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. +NAS) make this difficult to accomplish. Chazlarson has provided an online tool 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. \ No newline at end of file +The tool can be found [here](auth.md). \ No newline at end of file diff --git a/docs/defaults/overlays/ratings.md b/docs/defaults/overlays/ratings.md index 460e37d5..1e64f18d 100644 --- a/docs/defaults/overlays/ratings.md +++ b/docs/defaults/overlays/ratings.md @@ -97,7 +97,7 @@ work. Any value not specified will use its default value if it has one if not it === "File-Specific Template Variables" - These can be prepended with `rating1_`, `rating2_`, or `rating3_` to change that attribute on each rating + These can be prependd with `rating1_`, `rating2_`, or `rating3_` to change that attribute on each rating individually. ???+ warning @@ -105,41 +105,50 @@ work. Any value not specified will use its default value if it has one if not it To amend `horizontal_offset` and `vertical_offset` you **must** prepend the variable with `rating1_`, `rating2_`, or `rating3_` - | Variable | Description & Values | - |:-----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `rating1` | **Description:** Choose the rating to display in rating1.
**Values:** `critic`, `audience`, or `user` | - | `rating1_image` | **Description:** Choose the rating image to display in rating1.
**Values:** `anidb`, `imdb`, `letterboxd`, `tmdb`, `metacritic`, `rt_popcorn`, `rt_tomato`, `trakt`, `mal`, `mdb`, or `star` | - | `rating1_style` | **Description:** Choose the rating number style for rating1.
**Values:**
Ten Scale""8.7, 9.0
Ten Scale removing .0 "#"8.7, 9
Hundred Scale"%"87, 90
Five Scale"/"8.6 rating in plex will show as 4.3 on the overlay
| - | `rating1_extra` | **Description:** Extra text after rating1.
**Default:** `%` for `rt_popcorn`, `rt_tomato`, `tmdb`.
**Values:** Any Value | - | `rating2` | **Description:** Choose the rating to display in rating2.
**Values:** `critic`, `audience`, or `user` | - | `rating2_image` | **Description:** Choose the rating image to display in rating2.
**Values:** `anidb`, `imdb`, `letterboxd`, `tmdb`, `metacritic`, `rt_popcorn`, `rt_tomato`, `trakt`, `mal`, `mdb`, or `star` | - | `rating2_style` | **Description:** Choose the rating number style for rating2.
**Values:**
Ten Scale""8.7, 9.0
Ten Scale removing .0 "#"8.7, 9
Hundred Scale"%"87, 90
Five Scale"/"8.6 rating in plex will show as 4.3 on the overlay
| - | `rating2_extra` | **Description:** Extra text after rating2.
**Default:** `%` for `rt_popcorn`, `rt_tomato`, `tmdb`.
**Values:** Any Value | - | `rating3` | **Description:** Choose the rating to display in rating3.
**Values:** `critic`, `audience`, or `user` | - | `rating3_image` | **Description:** Choose the rating image to display in rating3.
**Values:** `anidb`, `imdb`, `letterboxd`, `tmdb`, `metacritic`, `rt_popcorn`, `rt_tomato`, `trakt`, `mal`, `mdb`, or `star` | - | `rating3_style` | **Description:** Choose the rating number style for rating3.
**Values:**
Ten Scale""8.7, 9.0
Ten Scale removing .0 "#"8.7, 9
Hundred Scale"%"87, 90
Five Scale"/"8.6 rating in plex will show as 4.3 on the overlay
| - | `rating3_extra` | **Description:** Extra text after rating3.
**Default:** `%` for `rt_popcorn`, `rt_tomato`, `tmdb`.
**Values:** Any Value | - | `horizontal_position` | **Description:** Choose the horizontal position for the rating group.
**Default:** `left`
**Values:** `left`, `right`, or `center` | - | `vertical_position` | **Description:** Choose the vertical position for the rating group.
**Default:** `center`
**Values:** `top`, `bottom`, or `center` | - | `rating_alignment` | **Description:** Choose the display alignment for the rating group.
**Default:** `vertical`
**Values:** `horizontal`, or `vertical` | - | `minimum_rating` | **Description:** Minimum Rating to display
**Default:** 0.0
**Values:** Any Number | - | `fresh_rating` | **Description:** Determines when ratings are considered Fresh
**Default:** 6.0
**Values:** Any Number | - | `maximum_rating` | **Description:** Maximum Rating to display
**Default:** 10.0
**Values:** Any Number | - | `addon_offset`1 | **Description:** Text Addon Image Offset from the text.
**Default:** `15`
**Values:** Any number greater than 0 | - | `addon_position`1 | **Description:** Text Addon Image Alignment in relation to the text.
**Default:** `top`
**Values:** `left`, `right`, `top`, `bottom` | - | `builder_level` | **Description:** Choose the Overlay Level.
**Values:** `episode` | - - 1. These variables can be prepended with `rating1_`, `rating2_`, or `rating3_` to change that attribute on each - rating individually. + | Variable | Description & Values | + |:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `rating1` | **Description:** Choose the rating to display in rating1.
**Values:** `critic`, `audience`, or `user` | + | `rating1_image` | **Description:** Choose the rating image to display in rating1.
**Values:** `anidb`, `imdb`, `letterboxd`, `tmdb`, `metacritic`, `rt_popcorn`, `rt_tomato`, `trakt`, `mal`, `mdb`, or `star` | + | `rating1_style` | **Description:** Choose the rating number style for rating1.
**Values:**
Ten Scale""8.7, 9.0
Ten Scale removing .0 "#"8.7, 9
Hundred Scale"%"87, 90
Five Scale"/"8.6 rating in plex will show as 4.3 on the overlay
| + | `rating1_extra` | **Description:** Extra text after rating1.
**Default:** `%` for `rt_popcorn`, `rt_tomato`, `tmdb`.
**Values:** Any Value | + | `rating2` | **Description:** Choose the rating to display in rating2.
**Values:** `critic`, `audience`, or `user` | + | `rating2_image` | **Description:** Choose the rating image to display in rating2.
**Values:** `anidb`, `imdb`, `letterboxd`, `tmdb`, `metacritic`, `rt_popcorn`, `rt_tomato`, `trakt`, `mal`, `mdb`, or `star` | + | `rating2_style` | **Description:** Choose the rating number style for rating2.
**Values:**
Ten Scale""8.7, 9.0
Ten Scale removing .0 "#"8.7, 9
Hundred Scale"%"87, 90
Five Scale"/"8.6 rating in plex will show as 4.3 on the overlay
| + | `rating2_extra` | **Description:** Extra text after rating2.
**Default:** `%` for `rt_popcorn`, `rt_tomato`, `tmdb`.
**Values:** Any Value | + | `rating3` | **Description:** Choose the rating to display in rating3.
**Values:** `critic`, `audience`, or `user` | + | `rating3_image` | **Description:** Choose the rating image to display in rating3.
**Values:** `anidb`, `imdb`, `letterboxd`, `tmdb`, `metacritic`, `rt_popcorn`, `rt_tomato`, `trakt`, `mal`, `mdb`, or `star` | + | `rating3_style` | **Description:** Choose the rating number style for rating3.
**Values:**
Ten Scale""8.7, 9.0
Ten Scale removing .0 "#"8.7, 9
Hundred Scale"%"87, 90
Five Scale"/"8.6 rating in plex will show as 4.3 on the overlay
| + | `rating3_extra` | **Description:** Extra text after rating3.
**Default:** `%` for `rt_popcorn`, `rt_tomato`, `tmdb`.
**Values:** Any Value | + | `horizontal_position` | **Description:** Choose the horizontal position for the rating group.
**Default:** `left`
**Values:** `left`, `right`, or `center` | + | `vertical_position` | **Description:** Choose the vertical position for the rating group.
**Default:** `center`
**Values:** `top`, `bottom`, or `center` | + | `rating_alignment` | **Description:** Choose the display alignment for the rating group.
**Default:** `vertical`
**Values:** `horizontal`, or `vertical` | + | `minimum_rating` | **Description:** Minimum Rating to display
**Default:** 0.0
**Values:** Any Number | + | `fresh_rating` | **Description:** Determines when ratings are considered Fresh
**Default:** 6.0
**Values:** Any Number | + | `maximum_rating` | **Description:** Maximum Rating to display
**Default:** 10.0
**Values:** Any Number | + | `addon_offset` | **Description:** Text Addon Image Offset from the text.
**Default:** `15`
**Values:** Any number greater than 0 | + | `rating1_addon_offset` | **Description:** Text Addon Image Offset from the text.
**Default:** `15`
**Values:** Any number greater than 0 | + | `rating2_addon_offset` | **Description:** Text Addon Image Offset from the text.
**Default:** `15`
**Values:** Any number greater than 0 | + | `rating3_addon_offset` | **Description:** Text Addon Image Offset from the text.
**Default:** `15`
**Values:** Any number greater than 0 | + | `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.
**Default:** `top`
**Values:** `left`, `right`, `top`, `bottom` | + | `rating1_addon_position` | **Description:** Text Addon Image Alignment in relation to the text.
**Default:** `top`
**Values:** `left`, `right`, `top`, `bottom` | + | `rating2_addon_position` | **Description:** Text Addon Image Alignment in relation to the text.
**Default:** `top`
**Values:** `left`, `right`, `top`, `bottom` | + | `rating3_addon_position` | **Description:** Text Addon Image Alignment in relation to the text.
**Default:** `top`
**Values:** `left`, `right`, `top`, `bottom` | + | `builder_level` | **Description:** Choose the Overlay Level.
**Values:** `episode` | === "Overlay Template Variables" + These variables can be prepended with `rating1_`, `rating2_`, or `rating3_` to change that attribute on each + rating individually. + {% include-markdown "../overlay_variables.md" %} === "Overlay Text Template Variables" + These variables can be prepended with `rating1_`, `rating2_`, or `rating3_` to change that attribute on each + rating individually. + {% include-markdown "../overlay_text_variables.md" %} diff --git a/docs/files/collections.md b/docs/files/collections.md index fee9e090..2447a7ba 100644 --- a/docs/files/collections.md +++ b/docs/files/collections.md @@ -17,7 +17,7 @@ list will be added/removed from the collection in the Plex library. ```yaml collections: #(1)! - Top 50 Grossing Films of All Time (Worldwide): + Top 50 Grossing Films of All Time (Worldwide): tmdb_list: 10 #(2)! collection_order: custom #(3)! sync_mode: sync #(4)! diff --git a/mkdocs.yml b/mkdocs.yml index b4d4fbb4..01aea07f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -183,6 +183,7 @@ nav: - OMDb: config/omdb.md - AniDB: config/anidb.md - MyAnimeList: config/myanimelist.md + - Trakt and MyAnimeList Authentication: config/auth.md - PMM DEFAULTS: - Defaults Usage Guide: defaults/guide.md - Defaults Files: defaults/files.md