Plex
/
Plex-Meta-Manager
mirror of https://github.com/meisnate12/Plex-Meta-Manager.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

[10] Closes #1829 and adds an auth tool to the wiki

Browse Source
pull/1831/head
meisnate12 4 months ago
parent acab77151f
commit 3356a40e22
8 changed files with 52 additions and 45 deletions
Show Stats Download Patch File Download Diff File

2
VERSION
Unescape View File

@ -1 +1 @@
1.20.0-develop9
1.20.0-develop10

3
docs/config/auth.md
Unescape View File

@ -0,0 +1,3 @@
# Trakt and MyAnimeList Authentication
<iframe src="https://pmm-auth-8e685ca9b226.herokuapp.com/" width="100%" height="800" style="border:0px solid black;"></iframe>

11
docs/config/myanimelist.md
Unescape View File

@ -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.
The tool can be found [here](auth.md).

4
docs/config/settings.md
Unescape View File

@ -1072,9 +1072,9 @@ libraries:
settings:
run_order: #(3)!
- operations
- metadata
- overlays
- collections
- operations
- metadata
minimum_items: 1 #(4)!
```

11
docs/config/trakt.md
Unescape View File

@ -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.
The tool can be found [here](auth.md).

63
docs/defaults/overlays/ratings.md
Unescape View File

@ -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.<br>**Values:** `critic`, `audience`, or `user` |
| `rating1_image` | **Description:** Choose the rating image to display in rating1.<br>**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.<br>**Values:** <table class="clearTable"><tr><td>Ten Scale</td><td><code>""</code></td><td><code>8.7</code>, <code>9.0</code></td></tr><tr><td>Ten Scale removing <code>.0</code> </td><td><code>"#"</code></td><td><code>8.7</code>, <code>9</code></td></tr><tr><td>Hundred Scale</td><td><code>"%"</code></td><td><code>87</code>, <code>90</code></td></tr><tr><td>Five Scale</td><td><code>"/"</code></td><td><code>8.6</code> rating in plex will show as <code>4.3</code> on the overlay</td></tr></table> |
| `rating1_extra` | **Description:** Extra text after rating1.<br>**Default:** `%` for `rt_popcorn`, `rt_tomato`, `tmdb`. <br>**Values:** Any Value |
| `rating2` | **Description:** Choose the rating to display in rating2.<br>**Values:** `critic`, `audience`, or `user` |
| `rating2_image` | **Description:** Choose the rating image to display in rating2.<br>**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.<br>**Values:** <table class="clearTable"><tr><td>Ten Scale</td><td><code>""</code></td><td><code>8.7</code>, <code>9.0</code></td></tr><tr><td>Ten Scale removing <code>.0</code> </td><td><code>"#"</code></td><td><code>8.7</code>, <code>9</code></td></tr><tr><td>Hundred Scale</td><td><code>"%"</code></td><td><code>87</code>, <code>90</code></td></tr><tr><td>Five Scale</td><td><code>"/"</code></td><td><code>8.6</code> rating in plex will show as <code>4.3</code> on the overlay</td></tr></table> |
| `rating2_extra` | **Description:** Extra text after rating2.<br>**Default:** `%` for `rt_popcorn`, `rt_tomato`, `tmdb`. <br>**Values:** Any Value |
| `rating3` | **Description:** Choose the rating to display in rating3.<br>**Values:** `critic`, `audience`, or `user` |
| `rating3_image` | **Description:** Choose the rating image to display in rating3.<br>**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.<br>**Values:** <table class="clearTable"><tr><td>Ten Scale</td><td><code>""</code></td><td><code>8.7</code>, <code>9.0</code></td></tr><tr><td>Ten Scale removing <code>.0</code> </td><td><code>"#"</code></td><td><code>8.7</code>, <code>9</code></td></tr><tr><td>Hundred Scale</td><td><code>"%"</code></td><td><code>87</code>, <code>90</code></td></tr><tr><td>Five Scale</td><td><code>"/"</code></td><td><code>8.6</code> rating in plex will show as <code>4.3</code> on the overlay</td></tr></table> |
| `rating3_extra` | **Description:** Extra text after rating3.<br>**Default:** `%` for `rt_popcorn`, `rt_tomato`, `tmdb`. <br>**Values:** Any Value |
| `horizontal_position` | **Description:** Choose the horizontal position for the rating group.<br>**Default:** `left`<br>**Values:** `left`, `right`, or `center` |
| `vertical_position` | **Description:** Choose the vertical position for the rating group.<br>**Default:** `center`<br>**Values:** `top`, `bottom`, or `center` |
| `rating_alignment` | **Description:** Choose the display alignment for the rating group.<br>**Default:** `vertical`<br>**Values:** `horizontal`, or `vertical` |
| `minimum_rating` | **Description:** Minimum Rating to display<br>**Default:** 0.0<br>**Values:** Any Number |
| `fresh_rating` | **Description:** Determines when ratings are considered Fresh<br>**Default:** 6.0<br>**Values:** Any Number |
| `maximum_rating` | **Description:** Maximum Rating to display<br>**Default:** 10.0<br>**Values:** Any Number |
| `addon_offset`<sup>1</sup> | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 |
| `addon_position`<sup>1</sup> | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `top`<br>**Values:** `left`, `right`, `top`, `bottom` |
| `builder_level` | **Description:** Choose the Overlay Level.<br>**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.<br>**Values:** `critic`, `audience`, or `user` |
| `rating1_image` | **Description:** Choose the rating image to display in rating1.<br>**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.<br>**Values:** <table class="clearTable"><tr><td>Ten Scale</td><td><code>""</code></td><td><code>8.7</code>, <code>9.0</code></td></tr><tr><td>Ten Scale removing <code>.0</code> </td><td><code>"#"</code></td><td><code>8.7</code>, <code>9</code></td></tr><tr><td>Hundred Scale</td><td><code>"%"</code></td><td><code>87</code>, <code>90</code></td></tr><tr><td>Five Scale</td><td><code>"/"</code></td><td><code>8.6</code> rating in plex will show as <code>4.3</code> on the overlay</td></tr></table> |
| `rating1_extra` | **Description:** Extra text after rating1.<br>**Default:** `%` for `rt_popcorn`, `rt_tomato`, `tmdb`. <br>**Values:** Any Value |
| `rating2` | **Description:** Choose the rating to display in rating2.<br>**Values:** `critic`, `audience`, or `user` |
| `rating2_image` | **Description:** Choose the rating image to display in rating2.<br>**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.<br>**Values:** <table class="clearTable"><tr><td>Ten Scale</td><td><code>""</code></td><td><code>8.7</code>, <code>9.0</code></td></tr><tr><td>Ten Scale removing <code>.0</code> </td><td><code>"#"</code></td><td><code>8.7</code>, <code>9</code></td></tr><tr><td>Hundred Scale</td><td><code>"%"</code></td><td><code>87</code>, <code>90</code></td></tr><tr><td>Five Scale</td><td><code>"/"</code></td><td><code>8.6</code> rating in plex will show as <code>4.3</code> on the overlay</td></tr></table> |
| `rating2_extra` | **Description:** Extra text after rating2.<br>**Default:** `%` for `rt_popcorn`, `rt_tomato`, `tmdb`. <br>**Values:** Any Value |
| `rating3` | **Description:** Choose the rating to display in rating3.<br>**Values:** `critic`, `audience`, or `user` |
| `rating3_image` | **Description:** Choose the rating image to display in rating3.<br>**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.<br>**Values:** <table class="clearTable"><tr><td>Ten Scale</td><td><code>""</code></td><td><code>8.7</code>, <code>9.0</code></td></tr><tr><td>Ten Scale removing <code>.0</code> </td><td><code>"#"</code></td><td><code>8.7</code>, <code>9</code></td></tr><tr><td>Hundred Scale</td><td><code>"%"</code></td><td><code>87</code>, <code>90</code></td></tr><tr><td>Five Scale</td><td><code>"/"</code></td><td><code>8.6</code> rating in plex will show as <code>4.3</code> on the overlay</td></tr></table> |
| `rating3_extra` | **Description:** Extra text after rating3.<br>**Default:** `%` for `rt_popcorn`, `rt_tomato`, `tmdb`. <br>**Values:** Any Value |
| `horizontal_position` | **Description:** Choose the horizontal position for the rating group.<br>**Default:** `left`<br>**Values:** `left`, `right`, or `center` |
| `vertical_position` | **Description:** Choose the vertical position for the rating group.<br>**Default:** `center`<br>**Values:** `top`, `bottom`, or `center` |
| `rating_alignment` | **Description:** Choose the display alignment for the rating group.<br>**Default:** `vertical`<br>**Values:** `horizontal`, or `vertical` |
| `minimum_rating` | **Description:** Minimum Rating to display<br>**Default:** 0.0<br>**Values:** Any Number |
| `fresh_rating` | **Description:** Determines when ratings are considered Fresh<br>**Default:** 6.0<br>**Values:** Any Number |
| `maximum_rating` | **Description:** Maximum Rating to display<br>**Default:** 10.0<br>**Values:** Any Number |
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 |
| `rating1_addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 |
| `rating2_addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 |
| `rating3_addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 |
| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `top`<br>**Values:** `left`, `right`, `top`, `bottom` |
| `rating1_addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `top`<br>**Values:** `left`, `right`, `top`, `bottom` |
| `rating2_addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `top`<br>**Values:** `left`, `right`, `top`, `bottom` |
| `rating3_addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `top`<br>**Values:** `left`, `right`, `top`, `bottom` |
| `builder_level` | **Description:** Choose the Overlay Level.<br>**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"
%}

2
docs/files/collections.md
Unescape View File

@ -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)!

1
mkdocs.yml
Unescape View File

@ -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

Write Preview
Loading…
Cancel
Save