13 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
Chart Collections
Default | Path | Example Collections | Works with Movies | Works with Shows |
---|---|---|---|---|
Chart Separator | separator_chart |
Chart Collections | ✅ | ✅ |
AniList | anilist |
AniList Popular, AniList Season | ✅ | ✅ |
Basic | basic |
Newly Released, New Episodes | ✅ | ✅ |
FlixPatrol | flixpatrol |
Top Disney, Top Hbo, Top Hulu, Top Netflix | ✅ | ✅ |
IMDb | imdb |
IMDb Popular, IMDb Top 250 | ✅ | ✅ |
MyAnimeList | myanimelist |
MyAnimeList Popular, MyAnimeList Top Rated | ✅ | ✅ |
Other | other_chart |
AniDB Popular, Common Sense Selection | ✅ | ✅ |
Tautulli | tautulli |
Plex Popular, Plex Watched | ✅ | ✅ |
TMDb | tmdb |
TMDb Popular, TMDb Airing Today | ✅ | ✅ |
Trakt | trakt |
Trakt Popular, Trakt Trending | ✅ | ✅ |
Award Collections
Default | Path | Example Collections | Works with Movies | Works with Shows |
---|---|---|---|---|
Award Separator | separator_award |
Award Collections | ✅ | ✅ |
British Academy of Film and Television Arts | bafta |
BAFTA Best Films, BAFTA 2021 | ✅ | ❌ |
Cannes | cannes |
Cannes - Palme d'or, Cannes 2018 | ✅ | ❌ |
Critics Choice | choice |
Critics Choice Awards 2020 | ✅ | ✅ |
Emmys | emmy |
Emmys 2021 | ✅ | ✅ |
Golden Globes | golden |
Best Motion Pictures | ✅ | ✅ |
Academy Awards (Oscars) | oscars |
Best Picture Winners | ✅ | ✅ |
Independent Spirit | spirit |
Independent Spirit Awards 2021 | ✅ | ❌ |
Sundance | sundance |
Sundance Grand Jury Winners | ✅ | ✅ |
Other | other_award |
Berlinale Golden Bears, Venice Golden Lions | ✅ | ❌ |
General Collections
Default | Path | Example Collections | Works with Movies | Works with Shows |
---|---|---|---|---|
Actor | actor |
Chris Hemsworth, Margot Robbie | ✅ | ✅ |
Audio Language | audio_language |
French Audio, Korean Audio | ✅ | ✅ |
Common Sense Content Rating | content_rating_cs |
1, 2, 3, 4, 5, 6, 15, 16, 17, 18 | ✅ | ✅ |
Content Rating (UK) | content_rating_uk |
U, PG, 12A | ✅ | ✅ |
Content Rating (US) Movie/Show | content_rating_us |
G, PG, NC-17 | ✅ | ✅ |
Country Movie/Show | country |
Belgium, India | ✅ | ✅ |
Decade Movie/Show | decade |
Best of 2012, Best of 2022 | ✅ | ✅ |
Director | director |
Steven Spielberg (Director), Olivia Wilde (Director) | ✅ | ❌ |
Franchise Movie/Show | 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 |
4K Movies, 1080p Movies, 720p Movies | ✅ | ✅ |
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) | ✅ | ❌ |
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
Default | path | Example Overlays | Movies | Shows | Seasons | Episodes |
---|---|---|---|---|---|---|
Audio Codec | audio_codec |
Dolby Atmos logo, DTS logo | ✅ | ✅ | ✅ | ✅ |
Audio Language | audio_language |
French Audio, Korean Audio | ✅ | ✅ | ✅ | ✅ |
CommonSense Age Rating | commonsense |
"3+", "16+" | ✅ | ✅ | ❗ | ❗ |
Direct Play | direct_play |
"Direct Play Only" | ✅ | ❗ | ❗ | ✅ |
Episode Info | episode_info |
"S01E01", "S02E09" | ❌ | ❌ | ❌ | ✅ |
FlixPatrol | flixpatrol |
"Streaming service logo with words "TOP" | ✅ | ✅ | ❌ | ❌ |
Mediastinger | mediastinger |
Mediastinger Logo for After/During Credit Scenes | ✅ | ✅ | ❌ | ❌ |
Ratings | ratings |
IMDb Audience Rating, Metacritic Critic Rating | ✅ | ✅ | ❌ | ✅ |
Resolution/Editions | resolution |
4K Dolby Vision logo, 720P logo, "Director's Cut", "Criterion Collection" | ✅ | ✅ | ❌ | ✅ |
Ribbon | ribbon |
IMDb Top 250 Ribbon, RT Fresh Ribbon | ✅ | ✅ | ❌ | ❌ |
Runtimes | runtimes |
"Runtime: 1h 30m" | ✅ | ✅ | ❌ | ❌ |
Status | status |
Airing, Returning, Canceled, Ended | ❌ | ✅ | ❌ | ❌ |
Streaming | streaming |
Netflix logo, Hulu logo | ✅ | ✅ | ❌ | ❌ |
Versions | versions |
Multiple Versions logo | ✅ | ✅ | ✅ | ✅ |
Video Format | 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
Default | path | Example Overlays |
---|---|---|
Playlist | playlist |
Arrowverse (Timeline Order), Pokémon (Timeline Order) |