Add-on:VideoExtras

VideoExtras

http://robwebset.googlecode.com/svn/trunk/script.videoextras/icon.png Author: robwebset Type: Program Repo: Source: Source code Summary: Add video extras to your Movies and TV shows

Add-ons

VideoExtras

Need help with this add-on? See here.

Provides a way to add video extras to your video library.

IMPORTANT INFORMATION

The VideoExtras is currently in a BETA state and should be viewed as such if you are planning to use it. If you are using VideoExtras and also wish to use TvTunes then you should use the version of TvTunes from the same repository as VideoExtras. (Installing the robwebset repository will automatically update to that version).

RobWebset Repo

Once out of beta, the plan is to add VideoExtras to the official addon's repository and create a dedicated forum topic (At the moment comments will continue in the existing forum)

Forum, Repository and Issue Report Pages

If you have any questions, found an issue to report or would just like to know a little more you can take part in the forum discussions at:

VideoExtras Forum

If you find any bugs or have an enhancement requests, these can be recorded at the following location:

VideoExtras Google Issue List

File Naming Convention

For your video extras files to be found they must follow a specific naming convention. Here are the supported conventions:

Extras Folder

(Recommended Method)
If you put all of your movies in their own folder you can simply add an "Extras" sub folder and add all of your bonus content in that directory. (The name of this folder can be changed via the settings menu). The script will simply display the filename (without extension) in the UI. By default the list of videos will appear in alphabetical order.

Same Directory

If for some reason you don't want to create an "Extras" folder or you want to associate a bonus feature with a specific TV show episode there is an alternative naming convention. Simply use the same name as the file you want to associate the extra feature with and then append "-extras-". (This tag can be changed via the settings menu)

Remote Location

If you did not want your extras stored in the same directory structure as your Movies or TV Shows, then there is a settings option "Use Custom Extras Location" that can be set to point to a different location. The format of this location should have 2 directories at the top level "Movies" and "TvShows". Under each of these should be directories (That match the name of the directories containing the Movie or TV Shows) containing the extras files.
e.g.

Movies/Die Hard

TvShows/Blake's 7

TvShows/Blake's 7/Series 1

TvShows/Blake's 7/Series 2

In this case, when clicking on the "TV Information" for the whole Blake's 7 Series you would see all files in "TvShows/Blake's 7" and the two sub-folders (if nested search is enabled), if viewing Episode Information for an episode in series 1 of Blake's 7 then you would only see the extras in "Blake's 7/Series 1"

With this method (based on where this root directory is), there may not be a need to add the "File Exclusions" section into advanced settings.

XBMC File Exclusions

Since these are video files sprinkled in among all of your other video files we need to tell the xbmc scanner to ignore these files. If we don't then the scanner will try and match them up with one of the online sites and you probably won't be happy with the results. To do this we just need to add some new regular expressions to the advanced settings. It is recommended to add these settings and reboot xbmc for them to take effect before adding the files to your library so the scanner doesn't try to parse them.

 <video>
   <excludefromscan>
     <regexp>-extras-</regexp>
     <regexp>[\\/]Extras[\\/]</regexp>
   </excludefromscan>
   <excludetvshowsfromscan>
     <regexp>-extras-</regexp>
     <regexp>[\\/]Extras[\\/]</regexp>
   </excludetvshowsfromscan>
 </video>

In this example the default name "Extras" has been used for the directory containing the extras, if you have changed this in the settings, then this name should also be changed to match.

Custom Naming And Ordering (NFO Files)

The recommended method to give a name or sort order to your "Extras" is to add an NFO for each extra file. This follows the standard XBMC method of having the same name as the file with the extension being replaced with ".nfo" (Sitting in the same directory as the original file). This nfo can take any of the followoing formats (These are in line with the default XBMC behaviour), additional data in these files will be ignored as it is not relevant for the extras file.

Movie NFO Format

 <movie>
     <title>Who knows</title>
     <sorttitle>Who knows 1</sorttitle>
 </movie>

TV Show NFO Format

 <tvshow>
     <title>Who knows</title>
     <sorttitle>Who knows 1</sorttitle>
 </tvshow>

TV Episode NFO Format

 <episodedetails>
     <title>Who knows</title>
     <season>2</season>
     <episode>1</episode>
 </episodedetails>

Legacy Naming Format

The following are the legacy naming formats, they are supported in the short term only to allow easy migration from DVDExtras to VideoExtras. (If an NFO file is specified, the settings in that file will be used)

By default the list of videos will appear in alphabetical order. If you would like to specify a custom order just start the filename with brackets containing the text to sort on. For example you could create files "[0]Deleted Scenes.mkv", "[1]Bloopers.mkv", and "[2]Behind The Scenes.mkv". In this case instead of sorting on the name it will sort on the numbers. The bracket portion of the filename will not be displayed in the UI.

For extras tagged on a per file basis (rather and all in a sub-directory) the name will be taken from anything after the extras tag. So append "-extras-Display name here" will result in the name "Display name here". To customize the order here you can use the same format as the extras folder. Example: "s01e01-extras-[99]Extended Pilot.mkv"

Skin Modifications

A skin modification is required in order to see the extras in the UI. This is a fairly simple process but will depend on your selected skin. The file that needs modified is DialogVideoInfo.xml. This is the code needed for the default confluence skin.

Add to the top of the file (after <window>):

<onload condition="System.HasAddon(script.videoextras)">
    XBMC.RunScript(script.videoextras,check,"$INFO[ListItem.FilenameAndPath]")</onload>

Add to near the foot of the file after the last control statement:

<control type="button" id="105">
    <description>Extras</description>
    <include>ButtonInfoDialogsCommonValues</include>
    <label>Extras</label>
    <onclick>XBMC.RunScript(script.videoextras,display,"$INFO[ListItem.FilenameAndPath]")</onclick>
    <visible>System.HasAddon(script.videoextras)
     + [Container.Content(movies) | Container.Content(episodes) | Container.Content(TVShows)]
     + IsEmpty(Window(movieinformation).Property("HideVideoExtrasButton"))</visible>
</control>

You should be able to use something similar for other skins.

Alterations for other (non confluence) skins:

Skin Name	Changes Different from Confluence
Aeon Nox 4.x	As per confluence but change "ButtonInfoDialogsCommonValues" to "DialogVideoInfoButton"

Thanks

Thank you to everyone who has assisted with the development of this add-on, From suggestions to testing. Most of all to brentosmith who originally wrote DVDExtras, the precursor to VideoExtras, although the current VideoExtras doesn't look anything like the original DVDExtras it was his original idea.