Plex-Meta-Manager/docs/config/paths.md

Path Types

YAML Files are defined by their path type and path location for the metadata_path, overlay_path, playlist_files, and external_templates attributes.

They can either be on the local system, online at an url, directly from the Plex Meta Manager Configs repository, or from another Custom Repository.

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.
• - 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.
• - repo: refers to a metadata file which is hosted on a custom repository specified aby the user with the custom_repo Setting Attribute.

Template Variables

Template Variables can be added to every template in any defined YAML file by adding the template_variables attribute to the dictionary defining the file.

Example

libraries:
  TV Shows:
    metadata_path:
      - git: PMM/genre
        template_variables:
          schedule_separator: never
          collection_mode: hide

In this example there will be two template variables added to every template in the git file PMM/genre.

schedule_separator is set to never to not show a separator in this section and collection_mode is set to hide.

What these variables will do depends on how they're defined in the Metadata File.

Metadata Path

The metadata_path attribute is defined under the libraries attribute in your Configuration File.

Example

Click to Expand

In this example, multiple metadata file path types are defined for the "TV Shows" library:

libraries:
  TV Shows:
    metadata_path:
      - file: config/TVShows.yml
      - folder: config/TV Shows/
      - git: meisnate12/ShowCharts
      - repo: charts
      - url: https://somewhere.com/PopularTV.yml

Within the above example, PMM will:

• First, look within the root of the PMM directory (also known as config/) for a metadata file named TVShows.yml. If this file does not exist, PMM will skip the entry and move to the next one in the list.
• Then, look within the root of the PMM directory (also known as config/) for a directory called TV Shows, and then load any metadata files within that directory.
• Then, look at the meisnate12 folder within the GitHub Configs Repo for a file called MovieCharts.yml which it finds here.
• Then, look at the within the Custom Defined Repo for a file called charts.yml.
• Finally, load the metadata file located at https://somewhere.com/PopularTV.yml

Playlist Files

The playlist_files at the top level in your Configuration File.

Example

Click to Expand

In this example, multiple playlist_files attribute path types are defined:

playlist_files:
  - file: config/playlists.yml
  - folder: config/Playlists/
  - git: meisnate12/Playlists
  - repo: playlists
  - url: https://somewhere.com/Playlists.yml

Within the above example, PMM will:

• First, look within the root of the PMM directory (also known as config/) for a playlist file named Playlists.yml. If this file does not exist, PMM will skip the entry and move to the next one in the list.
• Then, look within the root of the PMM directory (also known as config/) for a directory called Playlists, and then load any playlist files within that directory.
• Then, look at the meisnate12 folder within the GitHub Configs Repo for a file called MovieCharts.yml which it finds here.
• Then, look at the within the Custom Defined Repo for a file called playlists.yml.
• Finally, load the playlist file located at https://somewhere.com/Playlists.yml

External Templates

The external_templates attribute is defined at the top level in your Metadata File.

Example

Click to Expand

In this example, multiple external template file path types are defined:

external_templates:
  - file: config/templates.yml
  - folder: config/templates/
  - url: https://somewhere.com/templates.yml
  - git: PMM/templates
  - repo: templates

Within the above example, PMM will:

• First, look within the root of the PMM directory (also known as config/) for a metadata file named templates.yml. If this file does not exist, PMM will skip the entry and move to the next one in the list.
• Then, look within the root of the PMM directory (also known as config/) for a directory called templates, and then load any metadata files within that directory.
• Then, load the metadata file located at https://somewhere.com/templates.yml.
• Then, look at the PMM folder within the GitHub Configs Repo for a file called templates.yml which it finds here.
• Finally, look at the within the Custom Defined Repo for a file called templates.yml.