This metadata agent should be used with the Extended Personal Media Scanner found here. See the instructions on this page for installing the scanner.
This is a Metadata Agent for personal media files. It works in conjunction with the Extended Personal Media Scanner to scan personal media shows. The meta data agent sets the summary details on the episode. The agent expects the files to follow the naming conventions for personal media that are outlined in the Plex documentation.
Date-numbered shows
One major difference between the Extended Media Shows scanner and the Plex Series Scanner is that the Extended Media Shows scanner creates episode numbers for all of the date-based media. This results in it being sorted correctly in all Plex user interfaces. The episode number is the day of the year in which the episode is dated plus the optional index value. If an index value is not specified then a one (1) is automatically appended to the end of the episode number.
Plex date-based naming standard:
/Home Movies
/Christmas
/2010
Christmas - 2010-01-06 - Getting Ready.m4v
Christmas - 01-07-2010 - Getting Ready.m4v
Christmas - 2010-12-24 - Stuffing_the_Stockings.m4v
Christmas.12-25-2010.Christmas.Morning.m4v
Additional supported formats:
If the season title is specified it should go in the season description. Right now this is not working. I'm looking into why this failing.
/Home Movies
/Christmas
/2010
2010-01-06 - Getting Ready.m4v
12-24 - Stuffing the Stockings.m4v
/2011 - Season title
2011-01-06 - Some.title.m4v
12-24 - Some_other_title.m4v
The above example would result in a show with Christmas as the show title. The season number, episode number and episode title would be parsed from the names.
Unstructured format:
Additionally the scanner and metadata agent also support unstructured content as well. What this means is that you could put all of your files in the same folder as long as the file name format looks like the following:
/Home Movies
/Holidays
/Christmas - 2011-12-25 - Getting Ready.m4v
/Christmas - 2010-12-24 - Santa Claus.m4v
/Birthdays
/Grandma - 2010-02-24 - Grandma's 77th birthday party.m4v
/Grandma - 2008-02-24 - Grandma's 75th birthday party.m4v
The above example would result in shows with Christmas and Grandma as the show titles. The season number, episode number and episode title would be parse from the names.
Multiple episodes/shows on the same day:
With this plug-in it is possible to have multiple shows on the same date. An example of where this might be used in storing multiple NFL games in a directory with the same date. The Plex Series Scanner will see these as the same episode and will give them the same episode title. The Extended Personal Media scanner and agent allow the user to specific an index number after the date to specify that the episode is different. This results in Plex showing the episode with the appropriate title.
/Sports
/NFL
/2013
01-06_1 - Patriots Vs Giants.m4v
01-06_2 - Houston Vs Minnesota.m4v
2013-01-06_3 - Oakland Vs St. Lious.m4v
In the example of above three separate episode would be created in Plex and each with their own name.
Episode-number based shows
Plex episode-based naming standard:
/Home Movies
/Christmas
/2010
Christmas - s2010e0106 - Getting Ready.m4v
Christmas - s2010e0225 - Stuffing the Stockings.m4v
Christmas - s2010e1225 - Christmas Morning.m4v
Additional supported formats:
If the season title is specified it should go in the season description. Right now this is not working. I'm looking into why this failing.
/Home Movies
/Christmas
/2010
s2010e01 - Getting Ready.m4v
e02 - Another episode.m4v
/2011 - Season title
s2010e01 - Getting Ready.m4v
The above example would result in a show with Christmas as the show title. The season number, episode number and episode title would be parsed from the names.
Episodes that contain episode release dates:
The following shows the different supported directory/file formats that are supported by the plug-in.
/Home Movies
/NFL - s2015e01 - 2015-12-31 - Minnesota vs Green Bay.mp4
/NFL - s2015e02 - 12-31-2015 - Detroit vs Tampa Bay.mp4
/NFL
/s2015e03 - 2015-12-31 - New England vs New York Jets.mp4
/s2015e04 - 12-31-2015 - San Francisco vs Seattle.mp4
/s2015
/e05 - 2015-12-31 - Arizona vs Dallas.mp4
/e06 - 12-31-2015 - New York Giants vs Philadelphia.mp4
/e07 - 2015-12-31 - Cincinnati vs Pittsburgh.mp4
/e08 - 12-31-2015 - Episode Title.mp4
The above example would result in a show with NFL as the show title. The season number, episode number, episode release date and episode title would be parsed from the names. The example shows 8 episodes specified above each would show up having the release date of 12-31-2015 in Plex.
/Home Movies
/Holidays
/Christmas - s2010e01 - Getting Ready.m4v
/Vacations
/Italy - s2010e01 - Getting Ready.m4v
The above example would result in shows with Christmas and Italy as the show titles. The season number, episode number and episode title would be parsed from the names.
Using Chapter instead of Season:
Additionally the plugin supports using "Chapter" and "C" instead of "Season" and "S" (case is ignored). Note: the word "Season" would still be used in the Plex user interface and cannot be changed by the metadata agent plugin.
/College Classes
/Physics 101
Physics 101 - c1e1 - First chapter.m4v
Physics 101 - c1e2 - 2nd chapter.m4v
/C2
e1 - Some notes.m4v
e2 - Some more notes.m4v
/Chapter3
e1 - Something else.m4v
e2 - Something more.m4v
e3 - Something real.m4v
The above example would result in 7 episodes being added under three seasons with a show name of "Physics 101".
Show summaries
Show summaries can be added to media files in Plex by creating a file with the show name and a ".summary" extension somewhere within the directory path of your media file that you want to add the summary to. It is important to note that the show summary file found will be used as the summary information for the show.
There are two formats supported for show summary files:
- [Show title].summary where [Show title] is the name of your show that you want the summary information to be added to
- show.summary
Example media file:
/Media Root/Show title/Show title - 2010-02-02 - Some title.mp4
Summary file:
/Media Root/Show title/Show title.summary
Episode summaries
Episode summaries can be added to media files in Plex by creating a file with the same name and a ".summary" extension in the same directory as the media file you want to add the summary to.
Example media file:
Show title - 2010-02-02 - Some title.mp4
Summary file:
Show title - 2010-02-02 - Some title.summary
Download and source
Download: https://bitbucket.org/mjarends/extendedpersonalmedia-agent.bundle/get/master.zip
Source: https://bitbucket.org/mjarends/extendedpersonalmedia-agent.bundle/src
Installation
- Unzip the downloaded ZIP file, this gives you a file/folder with the name ExtendedPersonalMedia-Agent.bundle-master. Rename the folder to ExtendedPersonalMedia-Agent.bundle
-
- Mac
- Move ExtendedPersonalMedia-Agent.bundle to ~/Library/Application Support/Plex Media Server/Plug-ins. The easiest way to find this folder is to use the Go to folder... option in the Go menu of the Finder.
~ is your home folder. If you can't find your Library folder, have a look at OS X Lion: Where did my Library go?
- Move ExtendedPersonalMedia-Agent.bundle to ~/Library/Application Support/Plex Media Server/Plug-ins. The easiest way to find this folder is to use the Go to folder... option in the Go menu of the Finder.
- Windows
- Move ExtendedPersonalMedia-Agent.bundle to the Plug-ins folder: right-click the Plex Media Server icon in the system tray and open the Plug-ins folder
- Move ExtendedPersonalMedia-Agent.bundle to the Plug-ins folder: right-click the Plex Media Server icon in the system tray and open the Plug-ins folder
- Linux (Ubuntu)
- Move ExtendedPersonalMedia-Agent.bundle to /var/lib/plexmediaserver/Library/Application Support/Plex Media Server/Plug-ins
- cd "/var/lib/plexmediaserver/Library/Application Support/Plex Media Server/Plug-ins"
- sudo chown -R plex:plex ExtendedPersonalMedia-Agent.bundle
- Mac
- Restart Plex Media Server (this is optional)
- On Mac and Windows: just quit and start again
- On Linux (Ubuntu): sudo service plexmediaserver restart - In the Plex/Web application go to Settings > Server > Agents > Shows > Extended Personal Media Shows. Ensure that the Local Media Assets (TV) agent is checked and showing in the list (see the screen capture). The Local Media Assets is needed to add subtitle or metadata attributes from the files to your media.
- In Plex/Web (the media manager), create a new "TV Shows" section and select Extended Personal Media Shows from the Agent dropdown menu (under Advanced Options).
Plug-in Logs Location
This section details the plug-in log file and location on the different operating systems. Please send this log file to me so that I can perform additional analysis.
Plug-in log file name: com.arendshome.plex.agents.personalmedia.log
The following shows where the PMS Plugin Logs directory is on the different operating systems.
- Mac: ~/Library/Application Support/Plex Media Server/Logs/PMS Plugin Logs
- Windows: C:\Users\<USER NAME>\AppData\Local\Plex Media Server\Logs\PMS Plugin Logs
- Linux: Open /var/lib/plexmediaserver/Library/Application Support/Plex Media Server/Plug-ins
Change Log:
4/4/2015: Updated plug-in to fix issue with plug-in using the wrong parsed meta data within Plex due to the multi-threading of the metadata agents
5/29/2015: Added support for the following formats:
-
\Show Title - s2012e09 - 2015-12-31 - Episode Title.mp4
-
\Show Title - s2012e09 - 12-31-2015 - Episode Title.mp4
-
Show Title\s2012e09 - 2015-12-31 - Episode Title.mp4
-
Show Title\s2012e09 - 12-31-2015 - Episode Title.mp4
-
Show Title\s2015\e09 - 2015-12-31 - Episode Title.mp4
-
Show Title\s2015\e09 - 12-31-2015 - Episode Title.mp4
-
Show Title\e09 - 2015-12-31 - Episode Title.mp4
- Show Title\e09 - 12-31-2015 - Episode Title.mp4
2/28/2016: Added support for show .summary files
2/29/2016: Fixed issue with 2/28/2016 release. Added support for show.summary file format. Added preferences to enabled/disable debug logging within the plugin.