Skip to content
This repository was archived by the owner on Jan 24, 2022. It is now read-only.

File Format

Joshua Avalon edited this page Jul 12, 2019 · 6 revisions

Naming

Media/
├───Movies/
│   └───Rogue One A Star Wars Story (2016)/
│       └───Rogue One A Star Wars Story (2016).mkv
│       └───Rogue One A Star Wars Story (2016).xml
└───TV Shows/   
    └───Doctor Who (2005)/
        ├───tvshow.xml
        ├───Specials/
        │   └───Doctor Who (2005) - s00e83 - The Day of the Doctor.720p.mkv
        │   └───Doctor Who (2005) - s00e83 - The Day of the Doctor.480p.mkv
        │   └───Doctor Who (2005) - s00e83.xml
        └───Season 03/
            └───Doctor Who (2005) - s03e10 - Blink.mkv
            └───Doctor Who (2005) - s03e10.xml
            └───Doctor Who (2005) - s03e10 - Blink.xml

There are two xml naming convention for episode and movie. Standard naming is recommended because Plex will choose the best version when refreshing metadata. If you use File naming, the xml may changes if you are better version. The thumbnail of an episode should follow the same naming.

Standard (Recommend)

Episode

<show name> - s<season>e<episode>.xml

Movie

<moive name> (<year>).xml

File (Not recommend)

Episode && Movie

<File name>.xml

Show

tvshow.xml show be in the show level folder.

XML

<tvshow>
    <title></title>
    <originaltitle></originaltitle>
    <sorttitle></sorttitle>
    <set></set>
    <mpaa></mpaa>
    <plot></plot>
    <tagline></tagline>
    <rating></rating>
    <premiered></premiered>
    <studio></studio>
    <genre></genre>
    <actor>
        <name></name>
        <role></role>
        <thumb></thumb>
    </actor>
</tvshow>

Tags

Tag Required Multiple Working Description
tvshow Y N N/A Root tag
title Y N Y Title. Need for match.
originaltitle N N Y2 Original Title. Plex does not accept it.
sorttitle N N Y Sort Title.
set N Y Y Collections.
mpaa N N Y Content Rating.
plot N N Y Summary.
tagline N N Y2 Tagline. Plex does not accept it.
rating N N Y Rating.
premiered N N Y Originally Available. Format: yyyy-mm-dd
studio N N Y Studio.
genre N Y Y Genres.
actor N Y Y Cast.
name N N Y Cast Name.
role N N Y Cast Role.
thumb N N Y Cast Thumbnail. It should be a URL with of a square image.1

1 Square image works the best because the circle will be the center of image.

2 You need to set the Plex token in agent setting. Note that using this will NOT respect the lock on the field.

Episode

XML

<episodedetails>
    <title></title>
    <aired></aired>
    <mpaa></mpaa>
    <plot></plot>
    <director></director>
    <writer></writer>
    <rating></rating>
</episodedetails>

Tags

Tag Required Multiple Working Description
episodedetails Y N N/A Root tag
title N N Y Title. Need for match.
aired N N Y Originally Available. Format: yyyy-mm-dd
mpaa N N Y Content Rating.
plot N N Y Summary.
director N Y Y Directors.
writer N Y Y Writers.
rating N N Y Rating.

Movie

XML

<movie>
    <title></title>
    <originaltitle></originaltitle>
    <sorttitle></sorttitle>
    <set></set>
    <rating></rating>
    <releasedate></releasedate>
    <plot></plot>
    <tagline></tagline>
    <mpaa></mpaa>
    <genre></genre>
    <writer></writer>
    <studio></studio>
    <director></director>
    <actor>
        <name></name>
        <role></role>
        <thumb></thumb>
    </actor>
</movie>

Tags

Tag Required Multiple Working Description
tvshow Y N N/A Root tag
title Y N Y Title. Need for match.
originaltitle N N Y Original Title.
sorttitle N N Y Sort Title.
set N Y Y Collections.
mpaa N N Y Content Rating.
plot N N Y Summary.
tagline N N Y Tagline.
rating N N Y Rating.
releasedate N N Y Originally Available. Format: yyyy-mm-dd
studio N N Y Studio.
genre N Y Y Genres.
actor N Y Y Cast.
name N N Y Cast Name.
role N N Y Cast Role.
thumb N N Y Cast Thumbnail. It should be a URL with of a square image.

Table Of Content

Clone this wiki locally