Plex
/
Plex-Meta-Manager
mirror of https://github.com/meisnate12/Plex-Meta-Manager.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'b57c564175'
${ noResults }
Plex-Meta-Manager/docs/metadata/playlist.md

5.3 KiB
Raw Blame History

Playlist Files

Playlist files are used to create and maintain playlists on the Plex Server.

If utilized to their fullest, these files can be used to maintain the entire server's collections and playlists, and can be used as a backup for these in the event of a restore requirement.

Playlists are defined in one or more Playlist files that are mapped in the Playlist Files Attribute within the Configuration File.

You can use the playlist_report setting to get a list of your playlists printed out in your log.

These are the attributes which can be utilized within the Playlist File:

Attribute Description
templates contains definitions of templates that can be leveraged by multiple playlists
external_templates contains path types that point to external templates that can be leveraged by multiple playlists
playlists contains definitions of playlists you wish to add to the server

Playlist Attributes

Plex Meta Manager can automatically build and update playlists defined within the playlists attribute.

Each playlist requires its own section within the playlists attribute and unlike collections, playlists can only be built using one Builder as their ordering is inherited from the builder; it is not possible to combine builders.

playlists:
  Marvel Cinematic Universe Chronological Order:
    # ... builder, details, and filters for this playlist
  Star Wars Clone Wars Chronological Order:
    # ... builder, details, and filters for this playlist
  etc:
    # ... builder, details, and filters for this playlist

There are multiple types of attributes that can be utilized within a playlist:

Special Playlist Attributes

Attribute Description Required
libraries Determine which libraries the playlist will be built from.
Options: Comma-separated string or list of library mapping names defined in the libraries attribute in the base of your Configuration File.		 ✅
sync_to_users Determine which Users have the playlist synced.
This will override the global playlist_sync_to_users Setting.
Options: Comma-separated string or list of users, all for every user who has server access, or leave blank for just the server owner.		 ❌
delete_playlist Will delete this playlist for the users defined by sync_to_users.
Options: true or false		 ❌
  • Any defined playlist will be always be visible by The Plex Media Server owner, so it doesn't need to be defined within sync_to_users.

Example

In the following example, media is pulled from the Movies and TV Shows libraries into the one Playlist, and the playlist is shared with a specific set of users:

playlists:
  Marvel Cinematic Universe Chronological Order:
    sync_mode: sync
    libraries: Movies, TV Shows
    sync_to_users: User1, someone@somewhere.com, User3
    trakt_list: https://trakt.tv/users/donxy/lists/marvel-cinematic-universe?sort=rank,asc
    summary: Marvel Cinematic Universe In Chronological Order
  Star Wars Clone Wars Chronological Order:
    sync_to_users: all
    sync_mode: sync
    libraries: Movies, TV Shows
    trakt_list: https://trakt.tv/users/tomfin46/lists/star-wars-the-clone-wars-chronological-episode-order