/LocalTVExtras.bundle

Local TV Extras Agent for Plex

Primary LanguagePython

Local TV Extras Agent

This agent detects local trailer and extra videos in a TV Show directory and adds them to Plex. It can contribute to the default Personal Media Shows, TheTVDB and The Movie Database TV Agents as well as the HAMA TV Agent.

The agent has only had limited testing, so may not work perfectly for everyone.

Settings

How extras are organised on the server

Although the Plex Media Server supports adding, and serving, extras at all levels in a TV Show – episode, season and show – not all of the Plex clients do. Therefore, by default the agent will add any extras that are found to the TV Show level only.

However, if you have a client that supports extras at the episode or season level, then you can enable the setting Assign Extras to Episodes, Seasons or Shows based on folder structure.

TV Show folder structure

In order to associate extras only with the show that they belong to, and also to add then at the correct level. The agent needs to have some idea of the folder structure used to organise your files.

Based on the Plex requirements, the agent will classify folders named "Season" or "Specials" as season folders. If you use any other names ("Series", for example), then you may add them as a comma separated list in the Alternative names for season folders, comma separated setting.

Extra File Naming and Folder Structure

File naming is similar to the naming for Local Movie Trailers and Extras using the Plex agents, but has some specific requirements to help organise the files.

Inline Show Extras

Inline show extras should be added alongside any season folders in the Show directory. They will be detected if the end of the filename includes specific text, as follows:

  • TV Shows/TVShowName/Descriptive Name-Extra_Type.ext

Where -Extra_Type is one of:

  • -behindthescenes
  • -deleted
  • -featurette
  • -interview
  • -scene
  • -short
  • -trailer
  • -other
  • -extra

Show Extras Organised in Subdirectories

Show extras may also be organised in subdirectories in the Show directory. In this case, the entire filename is the descriptive name, and the folders must be specifically named:

  • TV Shows/TVShowName/Extra_Directory_Type/Descriptive_name.ext

Where -Extra_Type is one of:

  • Behind The Scenes
  • Deleted Scenes
  • Featurettes
  • Interviews
  • Scenes
  • Shorts
  • Trailers
  • Other
  • Extras

Season Extras

If you have extras that belong to a single season, then you can organise them in the season folder rather than the show folder. In this case, they should be named:

  • TV Shows/TVShowName/Season number/Descriptive Name-Extra_Type.ext

Or

  • TV Shows/TVShowName/Season number/Extra_Directory_Type/Descriptive_name.ext

If the Assign Extras to Episodes, Seasons or Shows based on folder structure setting is enabled, then these will be assigned to that season when scanned into Plex. Otherwise, they will be added at the show level.

Episode Extras

There are three methods by which an extra can be named connecting it to an episode. The first two methods require the episode to be given its own subdirectory. This directory must be named identically to the file name of the episode, e.g:

  • TV Shows/TVShowName/Season number/TVShowName - S##E## - Episode Name/TVShowName - S##E## - Episode Name.ext

Inline extras, or extras organised in subdirectories may then be added in the TV Shows/TVShowName/Season number/TVShowName - S##E## - Episode Name/ directory.

 

The third method is inline, and does not require a directory for each episode which has extras. The beginning of the extra's filename must be identical to the episode filename, and the descriptive name and extra type are then added at the end.

For an episode named:

  • TV Shows/TVShowName/Season number/TVShowName - S##E## - Episode Name.ext

An extra should be named:

  • TV Shows/TVShowName/Season number/TVShowName - S##E## - Episode Name-Descriptive_name-Extra_Type.ext

Thumbnails

If you have an image that you would like to use as the thumbnail for your local extra video, then it will be detected if it is placed in the same directory as the extra, and with the same filename except for the extension.

Installation

Instructions for installing a 3rd party Plex agent can be found on the Plex support website: How do I manually install a plugin?

Usage

Save your extra files in your TV Show directory as described above. Once done, navigate to the show in Plex/Web. Click on the more button, which can be found in the top-right corner of the window.

Plex-more

Then click "Refresh Metadata" from the drop-down menu.

Plex-refresh

Wait until the metadata refresh is complete, and then your TV Show extras should be added to the database.

Client Support

I don't have all these clients myself, so this is mostly a summary of what I have been told on the thread in the plex forums.

Show only:

  • Plex Media Player
  • Plex Web client
  • The new Plex for Mac/Plex for Windows clients

Show and Season:

  • Roku client
  • Kodi with the official Plex Add-on (This also includes MRMC with the same Plex Add-on)

Show, Season and Episode:

  • Android mobile client
  • iOS client (as of version 7.1)

All for Show & Season, only trailers for Episode:

  • Android TV/NVIDIA Shield

No TV Extras:

  • Apple TV client

The ones I can personally confirm are Plex Web, Plex Media Player, Plex for Mac, Plex for Kodi, iOS and Apple TV.