Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tweak assets examples to use "config" as the base location #1744

Merged
merged 9 commits into from
Nov 30, 2023
Merged

tweak assets examples to use "config" as the base location #1744

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
51d6aef
Amend `asset_directory` to use `config/assets` rather than just `assets`
YozoraXCII Nov 28, 2023
640ef38
tweak assets examples to use "config" as the base location
YozoraXCII Nov 28, 2023
2166af3
add note that private Trakt Lists work if Trakt has been authorized
YozoraXCII Nov 28, 2023
a3c546a
add fixes
YozoraXCII Nov 28, 2023
0c33e34
fix bad links
YozoraXCII Nov 28, 2023
c7a0f03
create "Text Overlay Template Variables" and fix ratings default values.
YozoraXCII Nov 28, 2023
54fc69b
vertical offset should be 0 for ratings
YozoraXCII Nov 28, 2023
7b8630c
fix triple quotation marks
YozoraXCII Nov 28, 2023
1a1d985
use markdown-include to include shared variables on each Defaults pag…
YozoraXCII Nov 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/builders/details/definition.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ All the following attributes serve various functions as how the definition funct
| `default_percent` | **Description:** Used to declare the default percent for `episodes`, `seasons`, `tracks`, and `albums` [special filters](../filters.md#special-filters). Default is 50.<br>**Values:** Integer between 1 and 100 |
| `ignore_blank_results` | **Description:** Used to not have Errors resulting from blank results from builders.<br>**Default:** `false`<br>**Values:** `true` or `false` |
| `only_run_on_create` | **Description:** Used to only run the collection definition if the collection doesn't already exist.<br>**Default:** `false`<br>**Values:** `true` or `false` |
| `delete_collections_named` | **Description:** Used to delete any collections in your plex named one of the given collections.<br>**Values:** List of Collection Names to delete |[environmental.md](..%2F..%2Fpmm%2Fessentials%2Fenvironmental.md)
| `delete_collections_named` | **Description:** Used to delete any collections in your plex named one of the given collections.<br>**Values:** List of Collection Names to delete |

An example of using `default_percent` which is used in an external yml file and not within config.yml:
```yml
Expand Down
4 changes: 4 additions & 0 deletions docs/builders/trakt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ The `sync_mode: sync` and `collection_order: custom` Details are recommended sin

**Trakt Lists cannot be sorted through the API, but the list is always returned to the default list order if you own the list.**

???+ tip

If you have [authorized Trakt](../config/trakt.md) then you can use private Trakt Lists, this is not possible if you have not authorized Trakt.

```yaml
collections:
Christmas:
Expand Down
19 changes: 14 additions & 5 deletions docs/config/paths.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

* `- 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.

* `- 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.

* `- 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).


Expand Down Expand Up @@ -95,21 +100,25 @@ playlist_files:

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
libraries:
Movies:
metadata_path:
- file: config/Movies.yml
asset_directory: assets/Movies
asset_directory: <path_to_assets>/Movies
- pmm: actors
asset_directory: assets/people
asset_directory: <path_to_assets>/people
overlay_path:
- pmm: imdb
playlist_files:
- file: config/Playlists.yml
asset_directory:
- assets/playlists1
- assets/playlists2
- <path_to_assets>/playlists1
- <path_to_assets>/playlists2
```

## Metadata Path
Expand Down Expand Up @@ -206,7 +215,7 @@ The [`playlist_files`](playlists.md) at the top level in your [Configuration Fil
## 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).
[metadata.md](..%2Fbuilders%2Fdetails%2Fmetadata.md)

??? example

In this example, multiple external template file path types are defined:
Expand Down
35 changes: 20 additions & 15 deletions docs/config/settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,38 +101,43 @@ Set the number of days before each cache mapping expires and has to be re-cached
## Image Asset Directory
Specify the directory where assets (posters, backgrounds, etc) are located.

| | |
|---|---|
| Default Value | [Directory containing YAML config]/assets |
| Allowed Values | any 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).

| | |
|----------------|-------------------------------------------|
| Default Value | [Directory containing YAML config]/assets |
| Allowed Values | any directory |


## Image Asset Folders
Search the `asset_directory` for a dedicated folder. Set to true if each poster is within its own directory.<br>
i.e. `assets/Star Wars/poster.png` instead of `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` |


## Asset Depth

Specify how many folder levels to scan for an item within the asset directory<br>
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. `assets/Star Wars/poster.png` and `assets/Star Wars.png` are both asset depth 0
and `assets/Movies/Star Wars/poster.png` and `assets/Movies/Star Wars.png` are both asset level 1
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`

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

`asset_folders` must be set to `true` for this to take effect.

increasing the amount of levels to scan will reduce performance

| | |
|---|---|
| Default Value | 0 |
| | |
|----------------|-------------|
| Default Value | 0 |
| Allowed Values | any integer |


Expand Down
10 changes: 5 additions & 5 deletions docs/defaults/award/bafta.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,10 @@ libraries:
- pmm: bafta
```

## Template Variables
## Template Variable Default Values

Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.

Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.

All [Shared Collection Variables](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file.

| Variable | Description & Values |
|:---------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
Expand All @@ -51,6 +47,10 @@ All [Shared Collection Variables](../collection_variables.md) are available as w

1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.

{%
include-markdown "../collection_variables.md"
%}

### Example Template Variable Amendments

The below is an example config.yml extract with some Template Variables added in to change how the file works.
Expand Down
10 changes: 5 additions & 5 deletions docs/defaults/award/cannes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,10 @@ libraries:
- pmm: cannes
```

## Template Variables
## Template Variable Default Values

Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.

Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.

All [Shared Collection Variables](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file.

| Variable | Description & Values |
|:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
Expand All @@ -51,6 +47,10 @@ All [Shared Collection Variables](../collection_variables.md) are available as w

1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.

{%
include-markdown "../collection_variables.md"
%}

### Example Template Variable Amendments

The below is an example config.yml extract with some Template Variables added in to change how the file works.
Expand Down
10 changes: 5 additions & 5 deletions docs/defaults/award/choice.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,10 @@ libraries:
- pmm: choice
```

## Template Variables
## Template Variable Default Values

Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.

Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.

All [Shared Collection Variables](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file.

| Variable | Description & Values |
|:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
Expand All @@ -53,6 +49,10 @@ All [Shared Collection Variables](../collection_variables.md) are available as w

1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.

{%
include-markdown "../collection_variables.md"
%}

### Example Template Variable Amendments

The below is an example config.yml extract with some Template Variables added in to change how the file works.
Expand Down
Loading
Loading