10 KiB
List of Defaults Files
The below table outlines the available Defaults files which can be called via metadata_path (for Collections), overlay_path (for Overlays) and playlist_files (for Playlists).
Collections
These files can generally be used on both Movie and Show library-types, or are part of a category of collection (such as Award Shows.)
These collections are applied by calling the below paths into the metadata_path: section of your config.yml
General Collections
| Theme | config.yml entry | Example Collections Created | Works with Movies | Works with Shows |
|---|---|---|---|---|
| Actor | actor |
Chris Hemsworth, Margot Robbie | ✅ | ✅ |
| Audio Language | audio_language |
French Audio, Korean Audio | ✅ | ✅ |
| Content Rating (UK) | content_rating_uk |
U, PG, 12A | ✅ | ✅ |
| Content Rating (US) | content_rating_us |
G, PG, NC-17 | ✅ | ✅ |
| Country | country |
Belgium, India | ✅ | ✅ |
| Decade | decade |
Best of 2012, Best of 2022 | ✅ | ✅ |
| Director | director |
Steven Spielberg (Director), Olivia Wilde (Director) | ✅ | ❌ |
| Franchise | franchise |
Star Wars: Skywalker Saga, Godzilla (Anime) | ✅ | ✅ |
| Genre | genre |
Action, Drama, Science Fiction | ✅ | ✅ |
| Network | network |
Disney Channel, Lifetime | ❌ | ✅ |
| Producer | producer |
James Cameron (Producer), Reese Witherspoon (Producer) | ✅ | ❌ |
| Resolution | resolution OR resolution_standards |
4K, 1080 OR Ultra HD, Full HD | ✅ | ✅ |
| Seasonal | seasonal |
Easter, Christmas | ✅ | ❌ |
| Streaming | streaming |
Disney+ Movies, HBO Max Shows | ✅ | ✅ |
| Studio | studio |
DreamWorks Studios, Walt Disney Pictures | ✅ | ✅ |
| Subtitle Language | subtitle_language |
German Subtitles, Swedish Subtitles | ✅ | ✅ |
| Universe | universe |
Marvel Cinematic Universal, Wizarding World | ✅ | ❌ |
| Year | year |
Best of 2010, Best of 2019 | ✅ | ✅ |
| Writer | writer |
James Cameron (Writer), Lilly Wachowski (Writer) | ✅ | ❌ |
Award Show Collections
| Award Show | config.yml entry | Example Collections Created | Works with Movies | Works with Shows |
|---|---|---|---|---|
| BAFTA | award/bafta |
BAFTA Best Films, BAFTA 2021 | ✅ | ❌ |
| Cannes | award/cannes |
Cannes - Palme d'or, Cannes 2018 | ✅ | ❌ |
| Critics Choice | award/choice |
Critics Choice Awards 2020 | ✅ | ✅ |
| Emmys | award/emmy |
Emmys 2021 | ✅ | ✅ |
| Golden Globes | award/golden |
Best Motion Pictures | ✅ | ✅ |
| Oscars | award/oscars |
Best Picture Winners | ✅ | ✅ |
| Spirit | award/spirit |
Independent Spirit Awards 2021 | ✅ | ❌ |
| Sundance | award/sundance |
Sundance Grand Jury Winners | ✅ | ✅ |
Chart Collections
| Source | config.yml entry | Example Collections Created | Works with Movies | Works with Shows |
|---|---|---|---|---|
| AniList | chart/anilist |
AniList Popular, AniList Season | ✅ | ✅ |
| Basic | chart/basic |
Newly Released, New Episodes | ✅ | ✅ |
| IMDb | chart/imdb |
IMDb Popular, IMDb Top 250 | ✅ | ✅ |
| MyAnimeList | chart/myanimelist |
MyAnimeList Popular, MyAnimeList Top Rated | ✅ | ✅ |
| Other | chart/other |
AniDB Popular, Common Sense Selection | ✅ | ✅ |
| Tautulli | chart/tautulli |
Plex Popular, Plex Watched | ✅ | ✅ |
| TMDb | chart/tmdb |
TMDb Popular, TMDb Airing Today | ✅ | ✅ |
| Trakt | chart/trakt |
Trakt Popular, Trakt Trending | ✅ | ✅ |
Overlays
These files apply overlays and can generally be used on both Movie and Show library-types, and often works at the season and episode-level too.
It should be noted that when an overlay has ❌ for a season or episode, it normally means that whilst the overlay can technically be applied at the level, it wasn't designed for this purpose. For example, a show's season cannot have a resolution since it is not a video file, and an episode cannot have a commonsense age-rating since only Movies and Shows are rated by CommonSense.
In the scenario where there is missing data such as age ratings for episodes, then generally the highest-level data available will be applied at the lower level (i.e. a Show's CommonSense age rating would apply to all episodes).
These overlays are applied by calling the below paths into the overlay_path: section of your config.yml
Overlay Files
| Theme | path | Example Overlays | Movies | Shows | Seasons | Episodes |
|---|---|---|---|---|---|---|
| Audio Codec | overlays/audio_codec |
Dolby Atmos logo, DTS logo | ✅ | ✅ | ✅ | ✅ |
| Audio Language | overlays/audio_language |
French Audio, Korean Audio | ✅ | ✅ | ✅ | ✅ |
| CommonSense Age Rating | overlays/commonsense |
"3+", "16+" | ✅ | ✅ | ❗ | ❗ |
| Direct Play | overlays/direct_play |
"Direct Play Only" | ✅ | ❗ | ❗ | ✅ |
| Editions | overlays/editions |
Director's Cut logo, IMAX logo | ✅ | ❌ | ❌ | ❌ |
| Episode Info | overlays/episode_info |
"S01E01", "S02E09" | ❌ | ❌ | ❌ | ✅ |
| Mediastinger | overlays/mediastinger |
Mediastinger logo | ✅ | ✅ | ❌ | ❌ |
| Ratings | overlays/ratings |
IMDb Audience Rating, Metacritic Critic Rating | ✅ | ✅ | ❌ | ✅ |
| Resolution | overlays/resolution |
4K Dolby Vision logo, 720P logo | ✅ | ✅ | ❌ | ✅ |
| Ribbon | overlays/ribbon |
IMDb Top 250 Ribbon, RT Fresh Ribbon | ✅ | ✅ | ❌ | ❌ |
| Runtimes | overlays/runtimes |
"Runtime: 1h 30m" | ✅ | ✅ | ❌ | ❌ |
| Special Releases | overlays/special_release |
"Director's Cut", "Criterion Collection" | ✅ | ✅ | ❗ | ❗ |
| Streaming | overlays/streaming |
Netflix logo, Hulu logo | ✅ | ✅ | ❌ | ❌ |
| Versions | overlays/versions |
Multiple Versions logo | ✅ | ✅ | ✅ | ✅ |
| Video Format | overlays/video_format |
"REMUX", "HDTV" | ✅ | ❗ | ❗ | ✅ |
Playlists
These files apply playlists to the "Playlists" section of Plex and are applied by calling the below paths into the playlist_files: section of your config.yml
Playlist Files
| Theme | path | Example Overlays |
|---|---|---|
| Playlist | playlist |
Arrowverse (Timeline Order), Pokémon (Timeline Order) |