Files define the structure and format for creating Collections, Overlays, Playlists, and Metadata Edits within your libraries.
Files are modular and when properly leveraged, they not only facilitate the management of your library's collections and metadata but also serve as a crucial backup resource in case a restore is necessary.
These are the File types that can be utilized against Plex servers:
|Defines the data for building collections, allowing you to group and showcase your library in unique ways.
|Defines the data for building overlays, allowing you to place information such as resolutions and ratings onto your posters.
|Defines the data for editing metadata, allowing you to find and manipulate the metadata on individual items within your library.
|Defines the data for building playlists, allowing you to combine media from multiple libraries and share them with users on your server.
|Defines templates in external files, allowing you to use the same templates across multiple other files.
Example File Blocks (click to expand)
In this example, multiple file blocks are defined for the
"TV Shows" library:
Unlike the others, Playlist Files are not defined per-library.
Within the above example, PMM will:
First, look within the root of the PMM directory (also known as
config/) for a collection 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 collection files within that directory.
Then, look in the defaults folder within the local PMM folder [or docker container] for a file called
Then, look within the Custom Defined Repo for a file called
Finally, load the playlist file located at
- See File Blocks for more information on how to define files in the config.
Definition Component Overview¶
There are a few different types of attributes that can be used in any given Collection/Overlay/Playlist File.
Builders are attributes placed at the top level of the definition that tell PMM what items belong in a collection/overlay/playlist. Multiple builders can be used in one definition. These could come from a variety of sources including but not limited to:
- Your own Plex Sever using the Advance Filters.
- A Tautulli instance with your most played items.
- A List of media online on a site like IMDb, TMDb, or TVDb.
Filters are all put under a single attribute
filters. These attributes will filter out items only after
builders find them. Filters alone do nothing, they need builders.
There are some specific filters that can filter missing items sent to Radarr/Sonarr and if needed you can use the
only_filter_missing setting to have the filter only effect the missing items.
Running filters are often slower than builders so whenever possible use only builders to build the definition.
This uses the
plex_all Buidler to get every item currently in the plex library and then checks TMDb if they have
duringcreditsstinger as a keyword.
Settings are attributes placed at the top level of the definition that tells PMM how to run the definition. Each setting will affect how the definition is run or shown in the log.
This sets the colleciton to only build if the builders find at minimum 10 items and will sync items to the collection (removing items that no longer are found by the builders).
Radarr/Sonarr Settings are attributes placed at the top level of the definition that tells PMM how Radarr/Sonarr is handled in this specific definition.
This sets the colleciton to add missing movies from the builders to Radarr.
Collection/Playlist Metadata Updates¶
Updates are attributes placed at the top level of the definition that tells PMM Metadata Changes for the Collection/Playlist.
Collection/Playlist Metadata Update Example
Item Metadata Updates¶
Item Updates are attributes placed at the top level of the definition that tells PMM Metadata Changes for every item found in the Collection/Playlist.