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

add fixes

Browse Source
pull/1744/head
YozoraXCII 1 year ago
parent 2166af3ab5
commit a3c546ab3c
3 changed files with 57 additions and 29 deletions
Show Stats Download Patch File Download Diff File

19
docs/config/paths.md
Unescape View File

@ -7,10 +7,15 @@ They can either be on the local system, online at an url, directly from the [Ple
The path types are outlined as follows: The path types are outlined as follows:
* `- file:` refers to a metadata file which is located within the system that PMM is being run from. * `- file:` refers to a metadata file which is located within the system that PMM is being run from.
* `- folder:` refers to a directory containing metadata files which is located within the system that PMM is being run from. * `- folder:` refers to a directory containing metadata files which is located within the system that PMM is being run from.
* `- pmm:` refers to a [PMM Defaults](/defaults/guide.md builders/overlay/playlist file. * `- pmm:` refers to a [PMM Defaults](/defaults/guide.md builders/overlay/playlist file.
* `- url:` refers to a metadata file which is hosted publicly on the internet. * `- url:` refers to a metadata file which is hosted publicly on the internet.
* `- git:` refers to a metadata file which is hosted on the [Configs Repo](https://github.com/meisnate12/Plex-Meta-Manager-Configs). * `- git:` refers to a metadata file which is hosted on the [Configs Repo](https://github.com/meisnate12/Plex-Meta-Manager-Configs).
* `- repo:` refers to a metadata file which is hosted on a custom repository specified by the user with the [`custom_repo` Setting Attribute](settings.md#custom-repo). * `- repo:` refers to a metadata file which is hosted on a custom repository specified by the user with the [`custom_repo` Setting Attribute](settings.md#custom-repo).
@ -95,21 +100,25 @@ playlist_files:
You can define custom Asset Directories per file by adding `asset_directory` to the file call. You can define custom Asset Directories per file by adding `asset_directory` to the file call.
???+ important
Assets can be stored anywhere on the host system that PMM has visibility of (i.e. if using docker, the directory must be mounted/visible to the docker container).
```yaml ```yaml
libraries: libraries:
Movies: Movies:
metadata_path: metadata_path:
- file: config/Movies.yml - file: config/Movies.yml
asset_directory: config/assets/Movies asset_directory: <path_to_assets>/Movies
- pmm: actors - pmm: actors
asset_directory: config/assets/people asset_directory: <path_to_assets>/people
overlay_path: overlay_path:
- pmm: imdb - pmm: imdb
playlist_files: playlist_files:
- file: config/Playlists.yml - file: config/Playlists.yml
asset_directory: asset_directory:
- config/assets/playlists1 - <path_to_assets>/playlists1
- config/assets/playlists2 - <path_to_assets>/playlists2
``` ```
## Metadata Path ## Metadata Path
@ -206,7 +215,7 @@ The [`playlist_files`](playlists.md) at the top level in your [Configuration Fil
## External Templates ## External Templates
The [`external_templates`](../builders/templates.md#external-templates) attribute is defined at the top level in your [Metadata File](../builders/details/metadata.md). The [`external_templates`](../builders/templates.md#external-templates) attribute is defined at the top level in your [Metadata File](../builders/details/metadata.md).
[metadata.md](..%2Fbuilders%2Fdetails%2Fmetadata.md)
??? example ??? example
In this example, multiple external template file path types are defined: In this example, multiple external template file path types are defined:

35
docs/config/settings.md
Unescape View File

@ -101,28 +101,33 @@ Set the number of days before each cache mapping expires and has to be re-cached
## Image Asset Directory ## Image Asset Directory
Specify the directory where assets (posters, backgrounds, etc) are located. Specify the directory where assets (posters, backgrounds, etc) are located.
| | | ???+ important
|---|---|
| Default Value | [Directory containing YAML config]/assets | Assets can be stored anywhere on the host system that PMM has visibility of (i.e. if using docker, the directory must be mounted/visible to the docker container).
| Allowed Values | any directory |
| | |
|----------------|-------------------------------------------|
| Default Value | [Directory containing YAML config]/assets |
| Allowed Values | any directory |
## Image Asset Folders ## Image Asset Folders
Search the `asset_directory` for a dedicated folder. Set to true if each poster is within its own directory.<br> Search the `asset_directory` for a dedicated folder. Set to true if each poster is within its own directory.<br>
i.e. `config/assets/Star Wars/poster.png` instead of `config/assets/Star Wars.png` i.e. `<path_to_assets>/Star Wars/poster.png` instead of `<path_to_assets>/Star Wars.png`
| | | | | |
|---|---| |----------------|-------------------|
| Default Value | true | | Default Value | true |
| Allowed Values | `true` or `false` | | Allowed Values | `true` or `false` |
## Asset Depth ## Asset Depth
Specify how many folder levels to scan for an item within the asset directory<br> Specify how many folder levels to scan for an item within the asset directory
At each asset level, PMM will look for either `medianame.ext` [such as Star Wars.png] or a dedicated folder containing `poster.ext`<br>
i.e. `config/assets/Star Wars/poster.png` and `config/assets/Star Wars.png` are both asset depth 0 At each asset level, PMM will look for either `medianame.ext` [such as Star Wars.png] or a dedicated folder containing `poster.ext`
and `config/assets/Movies/Star Wars/poster.png` and `config/assets/Movies/Star Wars.png` are both asset level 1
i.e. `<path_to_assets>/Star Wars/poster.png` and `<path_to_assets>/Star Wars.png` are both asset depth 0, whilst `<path_to_assets>/Movies/Star Wars/poster.png` and `<path_to_assets>/Movies/Star Wars.png` are both asset level 1
???+ note ???+ note
@ -130,9 +135,9 @@ and `config/assets/Movies/Star Wars/poster.png` and `config/assets/Movies/Star W
increasing the amount of levels to scan will reduce performance increasing the amount of levels to scan will reduce performance
| | | | | |
|---|---| |----------------|-------------|
| Default Value | 0 | | Default Value | 0 |
| Allowed Values | any integer | | Allowed Values | any integer |

32
docs/pmm/install/guides/assets.md
Unescape View File

@ -8,6 +8,13 @@ The Image Asset Directories can be used to update the posters and backgrounds of
You can specify your asset folders under the `settings` attribute `asset_directory`: You can specify your asset folders under the `settings` attribute `asset_directory`:
???+ important
Assets can be stored anywhere on the host system that PMM has visibility of (i.e. if using docker, the directory must be mounted/visible to the docker container).
For the sake of this document, we will assume that your assets folders are all based within the directory mapped to `config` within your PMM environment.
```yaml ```yaml
settings: settings:
asset_directory: config/assets asset_directory: config/assets
@ -22,8 +29,9 @@ settings:
- config/more_assets - config/more_assets
- config/assets_ahoy - config/assets_ahoy
``` ```
[paths.md](..%2F..%2F..%2Fconfig%2Fpaths.md)
* You can specify an Image Asset Directory per Metadata/Playlist/Overlay File when calling the file. See [Path Types](../../../config/paths.md#asset-directory) for how to define them. * You can specify an Image Asset Directory per Metadata/Playlist/Overlay File when calling the file. See [Path Types](../../../config/paths.md#asset-directory) for how to define them.
* By default [if no `asset_directory` is specified], the program will look in the same folder as your `config.yml` for a folder called `assets`. * By default [if no `asset_directory` is specified], the program will look in the same folder as your `config.yml` for a folder called `assets`.
## Applying assets ## Applying assets
@ -54,14 +62,20 @@ If a media item has an asset associated with it, that asset image is taken as th
The table below shows the asset folder path structures that will be searched for. There are two options for how Plex Meta Manager looks at the files inside your Asset Directories. Choose an option with the [`asset_folders` Setting Attribute](../../../config/settings.md#image-asset-folders). Note that `asset_folders` is a toggle; you can't put some images in folders and some not in a context where it is enabled. The table below shows the asset folder path structures that will be searched for. There are two options for how Plex Meta Manager looks at the files inside your Asset Directories. Choose an option with the [`asset_folders` Setting Attribute](../../../config/settings.md#image-asset-folders). Note that `asset_folders` is a toggle; you can't put some images in folders and some not in a context where it is enabled.
| Image Type | Asset Folders Image Paths<br>`asset_folders: true` | Flat Assets Image Paths<br>`asset_folders: false` | Assets can be stored anywhere on the host system that PMM has visibility of (i.e. if using docker, the directory must be mounted/visible to the docker container).
|:---------------------------------|:-------------------------------------------------------|:----------------------------------------------------------|
| Collection/Movie/Show poster | `config/assets/ASSET_NAME/poster.ext` | `config/assets/ASSET_NAME.ext` | ???+ important
| Collection/Movie/Show background | `config/assets/ASSET_NAME/background.ext` | `config/assets/ASSET_NAME_background.ext` |
| Season poster | `config/assets/ASSET_NAME/Season##.ext` | `config/assets/ASSET_NAME_Season##.ext` | The below table assumes that your assets are stored within the directory mapped to `config` in your PMM environment.
| Season background | `config/assets/ASSET_NAME/Season##_background.ext` | `config/assets/ASSET_NAME_Season##_background.ext` |
| Episode poster | `config/assets/ASSET_NAME/S##E##.ext` | `config/assets/ASSET_NAME_S##E##.ext` | | Image Type | Asset Folders Image Paths<br>`asset_folders: true` | Flat Assets Image Paths<br>`asset_folders: false` |
| Episode background | `config/assets/ASSET_NAME/S##E##_background.ext` | `config/assets/ASSET_NAME_S##E##_background.ext` | |:---------------------------------|:---------------------------------------------------------|:--------------------------------------------------------------|
| Collection/Movie/Show poster | `<path_to_assets>/ASSET_NAME/poster.ext` | `<path_to_assets>/ASSET_NAME.ext` |
| Collection/Movie/Show background | `<path_to_assets>/ASSET_NAME/background.ext` | `<path_to_assets>/ASSET_NAME_background.ext` |
| Season poster | `<path_to_assets>/ASSET_NAME/Season##.ext` | `<path_to_assets>/ASSET_NAME_Season##.ext` |
| Season background | `<path_to_assets>/ASSET_NAME/Season##_background.ext` | `<path_to_assets>/ASSET_NAME_Season##_background.ext` |
| Episode poster | `<path_to_assets>/ASSET_NAME/S##E##.ext` | `<path_to_assets>/ASSET_NAME_S##E##.ext` |
| Episode background | `<path_to_assets>/ASSET_NAME/S##E##_background.ext` | `<path_to_assets>/ASSET_NAME_S##E##_background.ext` |
* For **Collections** replace `ASSET_NAME` with the mapping name used with the collection unless `name_mapping` is specified, which you would then use what's specified in `name_mapping`. * For **Collections** replace `ASSET_NAME` with the mapping name used with the collection unless `name_mapping` is specified, which you would then use what's specified in `name_mapping`.

Write Preview
Loading…
Cancel
Save