mirror of
https://github.com/meisnate12/Plex-Meta-Manager
synced 2025-02-16 22:08:25 +00:00
[115] update docs
This commit is contained in:
parent
3b9b4dfbce
commit
aac45e9bf9
7 changed files with 47 additions and 13 deletions
2
VERSION
2
VERSION
|
@ -1 +1 @@
|
||||||
1.16.5-develop114
|
1.16.5-develop115
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Plex Meta Manager Default Collections & Overlays
|
# Default Collections & Overlays
|
||||||
|
|
||||||
There is a default set of Metadata and Overlay Files located in the [PMM Folder](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/PMM) in the [Plex Meta Manager Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs) Repository.
|
There is a default set of Metadata and Overlay Files located in the [PMM Folder](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/PMM) in the [Plex Meta Manager Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs) Repository.
|
||||||
|
|
||||||
|
@ -28,10 +28,36 @@ libraries:
|
||||||
|
|
||||||
## Overlays
|
## Overlays
|
||||||
|
|
||||||
The default set of overlays are a combination of Positional Overlays and Text Overlays. Here is an image of all the different spots on an image the default overlays will place images.
|
The default set of overlays are a combination of Positional Overlays and Text Overlays.
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Click to expand to see all the different spots on an image the default overlays will be.</summary>
|
||||||
|
|
||||||
![](overlays.png)
|
![](overlays.png)
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
### Example Poster Overlays
|
||||||
|
|
||||||
|
![](movie-overlays.png)
|
||||||
|
|
||||||
|
|
||||||
|
### Example Episode Overlays
|
||||||
|
|
||||||
|
![](episode-overlays.png)
|
||||||
|
|
||||||
|
## Separators
|
||||||
|
|
||||||
|
By default, most metadata files use separators to denote different sections of collection like actor collections vs studio collections.
|
||||||
|
|
||||||
|
![](separators.png)
|
||||||
|
|
||||||
|
* You can turn these off using [Custom Configs](#customizing-configs)
|
||||||
|
|
||||||
|
## Collection Section Order
|
||||||
|
|
||||||
|
Almost every default metadata file has a `collection_section` attribute. These attributes determine the order of the various sections and can be set using [Custom Configs](#customizing-configs).
|
||||||
|
|
||||||
## Customizing Configs
|
## Customizing Configs
|
||||||
|
|
||||||
Configs can be customized using the `template_variables` attribute when calling the file. These `template_variables` will be given to every template call in the file which allows them to affect how that file runs.
|
Configs can be customized using the `template_variables` attribute when calling the file. These `template_variables` will be given to every template call in the file which allows them to affect how that file runs.
|
||||||
|
@ -93,7 +119,7 @@ libraries:
|
||||||
|
|
||||||
## Errors
|
## Errors
|
||||||
|
|
||||||
If there are collections being made that have configuration errors or missing posters please raise an Issue on the [Configs Repo](https://github.com/meisnate12/Plex-Meta-Manager-Configs/issues/new/choose).
|
If there are collections being made that have configuration errors or missing posters please either bring it up in our Discord or raise an Issue on the [Configs Repo](https://github.com/meisnate12/Plex-Meta-Manager-Configs/issues/new/choose).
|
||||||
|
|
||||||
## Example Configuration File
|
## Example Configuration File
|
||||||
|
|
||||||
|
|
BIN
docs/home/guides/episode-overlays.png
Normal file
BIN
docs/home/guides/episode-overlays.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 507 KiB |
BIN
docs/home/guides/movie-overlays.png
Normal file
BIN
docs/home/guides/movie-overlays.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 399 KiB |
BIN
docs/home/guides/separators.png
Normal file
BIN
docs/home/guides/separators.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 288 KiB |
BIN
docs/metadata/blur.png
Normal file
BIN
docs/metadata/blur.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 118 KiB |
|
@ -56,6 +56,16 @@ Each overlay definition needs to specify what overlay to use. This can happen in
|
||||||
|
|
||||||
3. Using a dictionary for more overlay location options.
|
3. Using a dictionary for more overlay location options.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
overlays:
|
||||||
|
IMDb Top 250:
|
||||||
|
overlay:
|
||||||
|
name: IMDb Top 250
|
||||||
|
imdb_chart: top_movies
|
||||||
|
```
|
||||||
|
|
||||||
|
There are many attributes available when using overlays to edit how they work.
|
||||||
|
|
||||||
| Attribute | Description | Required |
|
| Attribute | Description | Required |
|
||||||
|:--------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------:|
|
|:--------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------:|
|
||||||
| `name` | Name of the overlay. Each overlay name should be unique. | ✅ |
|
| `name` | Name of the overlay. Each overlay name should be unique. | ✅ |
|
||||||
|
@ -82,14 +92,6 @@ Each overlay definition needs to specify what overlay to use. This can happen in
|
||||||
|
|
||||||
* If `url`, `git`, and `repo` are all not defined then PMM will look in your `config/overlays` folder for a `.png` file named the same as the `name` attribute.
|
* If `url`, `git`, and `repo` are all not defined then PMM will look in your `config/overlays` folder for a `.png` file named the same as the `name` attribute.
|
||||||
|
|
||||||
```yaml
|
|
||||||
overlays:
|
|
||||||
IMDb Top 250:
|
|
||||||
overlay:
|
|
||||||
name: IMDb Top 250
|
|
||||||
imdb_chart: top_movies
|
|
||||||
```
|
|
||||||
|
|
||||||
### Non-Positional Image Overlay
|
### Non-Positional Image Overlay
|
||||||
|
|
||||||
Non-Positional overlays are images that are either 1000 x 1500 for Posters or 1920 x 1080 for Backgrounds and Title Cards.
|
Non-Positional overlays are images that are either 1000 x 1500 for Posters or 1920 x 1080 for Backgrounds and Title Cards.
|
||||||
|
@ -125,10 +127,14 @@ overlays:
|
||||||
overlay:
|
overlay:
|
||||||
name: blur(50)
|
name: blur(50)
|
||||||
plex_search:
|
plex_search:
|
||||||
|
type: episodes
|
||||||
all:
|
all:
|
||||||
resolution: 4K
|
resolution: 4K
|
||||||
```
|
```
|
||||||
|
|
||||||
|
![](blur.png)
|
||||||
|
|
||||||
|
|
||||||
### Text Overlay
|
### Text Overlay
|
||||||
|
|
||||||
You can add text as an overlay using the special `text()` overlay name. Anything inside the parentheses will be added as an overlay onto the image. Ex `text(4K)` adds `4K` to the image.
|
You can add text as an overlay using the special `text()` overlay name. Anything inside the parentheses will be added as an overlay onto the image. Ex `text(4K)` adds `4K` to the image.
|
||||||
|
@ -143,6 +149,8 @@ You can add an items rating number (`8.7`) to the image by using `text(audience_
|
||||||
|
|
||||||
You can add an items rating percentage (`87%`) to the image by using `text(audience_rating%)`, `text(critic_rating%)`, or `text(user_rating%)`
|
You can add an items rating percentage (`87%`) to the image by using `text(audience_rating%)`, `text(critic_rating%)`, or `text(user_rating%)`
|
||||||
|
|
||||||
|
You can use the `mass_audience_rating_update` or `mass_critic_rating_update` [Library Operation](../config/operations) to update your plex ratings to various services like `tmdb`, `imdb`, `mdb`, `metacritic`, `letterboxd` and many more.
|
||||||
|
|
||||||
PMM includes multiple fonts in the [`fonts` folder](https://github.com/meisnate12/Plex-Meta-Manager/tree/master/fonts) which can be called using `fonts/fontname.ttf`
|
PMM includes multiple fonts in the [`fonts` folder](https://github.com/meisnate12/Plex-Meta-Manager/tree/master/fonts) which can be called using `fonts/fontname.ttf`
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
@ -224,7 +232,7 @@ These filter media items added to the collection by any of the Builders.
|
||||||
|
|
||||||
* [Filters](filters)
|
* [Filters](filters)
|
||||||
|
|
||||||
## Example
|
## Examples
|
||||||
|
|
||||||
### Example Overlay File
|
### Example Overlay File
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue