Add tooltips to Overlay Files and Playlist Files examples

This commit is contained in:
YozoraXCII 2023-11-27 14:32:06 +00:00
parent c01a3d044a
commit 48fdada0e1
3 changed files with 51 additions and 13 deletions

View file

@ -53,6 +53,7 @@ This example is a Metadata file with a basic collection which is saved in a file
1. This must match the name of a library in your Plex server
2. `config` refers to the location that you mapped to `config` when following the PMM Installation Guides.
## Collection Attributes
Plex Meta Manager can run a number of different operations within `collections` and such as:

View file

@ -6,17 +6,20 @@ Overlays and templates are defined within one or more Overlay files, which are l
## Example
This example is an Overlay file with a basic overlay which is saved in a file called `MyOverlays.yml` within the location mapped as `config` in my setup.
???+ example "Example "MyOverlays.yml"""
Click the :fontawesome-solid-circle-plus: icon to learn more
This will add an overlay with text that says "Direct Play" to any item which has a 4K resolution in my library. It will be located at the bottom of the poster in the center.
```yaml
overlays:
overlays: #(1)!
directplay:
overlay:
name: text(Direct Play)
name: text(Direct Play) #(2)!
horizontal_offset: 0
horizontal_align: center
vertical_offset: 150
@ -25,23 +28,30 @@ This example is an Overlay file with a basic overlay which is saved in a file ca
font_color: "#FFFFFF"
back_color: "#00000099"
back_radius: 30
plex_search:
plex_search: #(3)!
all:
resolution: 4K
```
This file would then be defined in my `config.yml` file as a `overlay_path` item:
1. This must appear once and **only once** in any Overlay file
2. This tells PMM to use text as the overlay rather than an image
3. This is the criteria that PMM will use to define what should receive the overlay
???+ example "config.yml Example Overlay Path Addition"
Click the :fontawesome-solid-circle-plus: icon to learn more
```yaml
libraries:
Movies: # this must match the name of a library in your Plex server
Movies: #(1)!
overlay_path:
- remove_overlays: false
- file: config/MyOverlays.yml
- file: config/MyOverlays.yml #(2)!
```
1. This must match the name of a library in your Plex server
2. `config` refers to the location that you mapped to `config` when following the PMM Installation Guides.
All overlay coordinates assume 1000 x 1500 for Posters and 1920 x 1080 for Backgrounds and Title Cards.
**To remove all overlays add `remove_overlays: true` to the `overlay_path` [Libraries Attribute](../config/libraries.md#remove-overlays).**

View file

@ -14,20 +14,42 @@ You can use the [`playlist_report` setting](../config/settings.md#playlist-repor
This example is a Playlist file with a basic overlay which is saved in a file called `MyPlaylists.yml` within the location mapped as `config` in my setup.
???+ example "Example "MyPlaylists.yml"""
This will add an overlay with text that says "Direct Play" to any item which has a 4K resolution in my library. It will be located at the bottom of the poster in the center.
Click the :fontawesome-solid-circle-plus: icon to learn more
```yaml
playlists:
collections: #(1)!
Top 50 Grossing Films of All Time (Worldwide):
tmdb_list: 10 #(2)!
collection_order: custom #(3)!
sync_mode: sync #(4)!
```
1. This must appear once and **only once** in any Metadata file
2. This creates a collection based on tmdb list ID 10, https://www.themoviedb.org/list/10 would also be accepted
3. This will sort the items in the Plex collection to be the same as the order in the list
4. Syncs the collection to the list, so that if an item is added/removed from the list, the same is done to the collection. Set this to `append` if you only want it to add things and not remove them.
???+ example "config.yml Example Metadata Path Addition"
Click the :fontawesome-solid-circle-plus: icon to learn more
```yaml
playlists: #(1)!
Marvel Cinematic Universe Chronological Order:
sync_mode: sync
libraries: Movies, TV Shows # these libraries must exist in your Plex server
sync_to_users: User1, someone@somewhere.com, User3
trakt_list: https://trakt.tv/users/donxy/lists/marvel-cinematic-universe?sort=rank,asc
libraries: Movies, TV Shows #(2)!
sync_to_users: User1, someone@somewhere.com, User3 #(3)!
trakt_list: https://trakt.tv/users/donxy/lists/marvel-cinematic-universe
summary: Marvel Cinematic Universe In Chronological Order
```
1. This must appear once and **only once** in any Playlist file
2. These libraries must exist in your Plex library
3. Leave this blank if you only only want the Playlist to sync to the server owner's account
This file would then be defined in my `config.yml` file as a `playlist_files` item:
???+ warning "Important Note"
@ -36,16 +58,21 @@ This file would then be defined in my `config.yml` file as a `playlist_files` it
???+ example "config.yml Example Playlists Addition"
Click the :fontawesome-solid-circle-plus: icon to learn more
```yaml
libraries:
Movies:
# Metadata and Overlay files here
TV Shows:
# Metadata and Overlay files here
playlist_files:
- file: config/MyPlaylists.yml
playlist_files: #(1)!
- file: config/MyPlaylists.yml #(2)!
```
1. Note that Playlist files are not called within the `libraries` section, they are defined at the root identation as you can see here
2. `config` refers to the location that you mapped to `config` when following the PMM Installation Guides.
## Playlist Attributes
Plex Meta Manager can automatically build and update playlists defined within the `playlists` attribute.