|
|
| (197 intermediate revisions by 8 users not shown) |
| Line 1: |
Line 1: |
| {{Addon | | {{Delete|Page emptied by add-on author and hasn't been in official repository for three consecutive major release cycles}} |
| |Name=VideoExtras | |
| |provider-name=robwebset
| |
| |ID=script.videoextras
| |
| |latest-version=1.0.2
| |
| |extension point=xbmc.python.script
| |
| |provides=
| |
| |Summary=Add Video Extras to your Movies and TV shows.
| |
| |Description=Provides a way to add Video Extras to your Video library. Look at the wiki for setup instructions.
| |
| |Platform=all
| |
| |Language=
| |
| |License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
| |
| |Forum=http://forum.xbmc.org/showthread.php?tid=178717
| |
| |Website=
| |
| |Source=http://robwebset.googlecode.com/svn/trunk/script.videoextras/
| |
| |Email=
| |
| |broken=
| |
| |icon url=http://mirrors.xbmc.org/addons/frodo/script.videoextras/icon.png}}
| |
| | |
| <!-- Page content goes here -->
| |
| <br />
| |
| <br />
| |
| == Forum 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:
| |
| | |
| :[http://forum.xbmc.org/showthread.php?tid=178717 VideoExtras Forum]
| |
| | |
| If you find any bugs or have an enhancement requests, these can be recorded at the following location:
| |
| | |
| :[http://code.google.com/p/robwebset/issues/list VideoExtras Google Issue List]
| |
| | |
| <br />
| |
| <br />
| |
| == File Naming Convention ==
| |
| For your video extras files to be found they must follow a specific naming convention. Here are the supported conventions:
| |
| <br />
| |
| === Extras Folder ===
| |
| <small>''(Recommended Method)''</small>
| |
| <br />
| |
| 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.
| |
| <br />
| |
| === 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)
| |
| <br />
| |
| === 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.
| |
| <br />
| |
| 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"
| |
| <br />
| |
| <br />
| |
| With this method (based on where this root directory is), there may not be a need to add the "File Exclusions" section into [http://wiki.xbmc.org/index.php?title=Advancedsettings.xml advanced settings].
| |
| <br />
| |
| <br />
| |
| == 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 [http://wiki.xbmc.org/index.php?title=Advancedsettings.xml 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.
| |
| | |
| <source lang="xml">
| |
| <advancedsettings>
| |
| <video>
| |
| <excludefromscan>
| |
| <regexp>-extras-</regexp>
| |
| <regexp>/Extras/</regexp>
| |
| <regexp>Extras</regexp>
| |
| <regexp>/extras/</regexp>
| |
| <regexp>extras</regexp>
| |
| <regexp>-trailer</regexp>
| |
| <regexp>[\\/]Extras[\\/]</regexp>
| |
| <regexp>[\\/]extras[\\/]</regexp>
| |
| </excludefromscan>
| |
| <excludetvshowsfromscan>
| |
| <regexp>-extras-</regexp>
| |
| <regexp>/Extras/</regexp>
| |
| <regexp>Extras</regexp>
| |
| <regexp>/extras/</regexp>
| |
| <regexp>extras</regexp>
| |
| <regexp>-trailer</regexp>
| |
| <regexp>[\\/]Extras[\\/]</regexp>
| |
| <regexp>[\\/]extras[\\/]</regexp>
| |
| </excludetvshowsfromscan>
| |
| </video>
| |
| </advancedsettings>
| |
| </source>
| |
| | |
| 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.
| |
| <br />
| |
| <br />
| |
| | |
| == Images: Thumbnails, Icons and Fanart ==
| |
| In order to have thumbnails or custom fanart images displayed on your Extras listings (and player overlay) you can either reference them via an NFO file (see NFO section), or by having the image in the same directory as the extras file. Images referenced via NFO (locally or remotely) will have priority over any other. Thumbnail/icon images in the same directory as extras will be picked up in the following order:
| |
| | |
| * <filename>.tbn/png/jpg
| |
| * <filename>-poster.tbn/png/jpg
| |
| * <filename>-thumb.tbn/png/jpg
| |
| * poster.tbn/png/jpg
| |
| * folder.tbn/png/jpg
| |
| | |
| For fanart, the images are picked up in the following order (if no custom fanart is specified, fanart is automatically inherited from the parent video file, if there's any):
| |
| | |
| * <filename>-fanart.tbn/png/jpg
| |
| * fanart.tbn/png/jpg
| |
| | |
| <br />
| |
| <br />
| |
| == 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 ===
| |
| <source lang="xml">
| |
| <movie>
| |
| <title>Who knows</title>
| |
| <sorttitle>Who knows 1</sorttitle>
| |
| <thumb>thumbnail.jpg</thumb>
| |
| <fanart>background.jpg</fanart>
| |
| </movie>
| |
| </source>
| |
| | |
| === TV Show NFO Format ===
| |
| <source lang="xml">
| |
| <tvshow>
| |
| <title>Who knows</title>
| |
| <sorttitle>Who knows 1</sorttitle>
| |
| <thumb>http://forum.xbmc.org/images/xbmc/xbmc-lettering.png</thumb>
| |
| <fanart>http://forum.xbmc.org/images/xbmc/xbmc-lettering.png</fanart>
| |
| </tvshow>
| |
| </source>
| |
| | |
| === TV Episode NFO Format ===
| |
| <source lang="xml">
| |
| <episodedetails>
| |
| <title>Who knows</title>
| |
| <season>2</season>
| |
| <episode>1</episode>
| |
| <thumb>C:\MyThumbs\Who.Knows.tbn</thumb>
| |
| <fanart>C:\MyFanart\myart.png</fanart>
| |
| </episodedetails>
| |
| </source>
| |
| | |
| === 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)
| |
| <br />
| |
| <br />
| |
| 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.
| |
| <br />
| |
| <br />
| |
| 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"
| |
| <br />
| |
| <br />
| |
| == Settings ==
| |
| This section details all the settings options for VideoExtras
| |
| === Extras ===
| |
| :'''Extras Directory Name'''
| |
| ::The name of the sub directory that stores all the extras files
| |
| :'''Search Nested Directories'''
| |
| ::If directories below the selected TV Show or Movie should be searched for more extras. This is useful if you select a given TV Show and have all your seasons for that show in separate directories under that show. This means that all extras will be displayed when viewed via the root TV Show, and only the seasons extras if selected from inside a given season.
| |
| :'''Enable Extras with File Tag'''
| |
| ::Finds extras based on a "tag", listing anything containing that tag
| |
| :'''Extras File Name Tag'''
| |
| ::If "Enable Extras with File Tag" was enabled, this gives the name to search for as the tag
| |
| :'''Use Detailed List Screen'''
| |
| ::Displays a more advanced listing screen which displays resume points and a watched flag
| |
| :'''Window to show after exiting detailed list'''
| |
| ::(If detailed list screen is enabled) - Which screen to go to after exiting the detailed list screen, options are: "Video Selection", "Information", "Home"
| |
| :'''Menu to show after playing an extra'''
| |
| ::(If detailed list screen is disabled) - Which screen to go to after playing an extra, options are: "Extras", "Video Selection", "Information", "Home"
| |
| === File System ===
| |
| :'''Use Custom Extras Location'''
| |
| ::If extras are not stored with the Movies/TV Shows, this allows them to be stored in a different directory structure.
| |
| :'''Path'''
| |
| ::The path that the extras are located in (Only if ''"Use Custom Extras Location"'' is enabled)
| |
| :'''Custom Movies Sub-Folder'''
| |
| ::The name of the folder under the ''"Path"'' where Movie extras are stored (Note: a directory with the movie name will be located under this directory containing the extras for that movie)
| |
| :'''Custom TV Shows Sub-Folder'''
| |
| ::The name of the folder under the ''"Path"'' where TV Shows extras are stored (Note: a directory with the TV Show name will be located under this directory containing the extras for that TV Show)
| |
| === Database ===
| |
| :'''Enable Database Support'''
| |
| ::Enables the use of the Extras stand-alone database, this enables the display and storing of data such as
| |
| :::* Which extras have been viewed already
| |
| :::* Resume playing an extra from the last stop point
| |
| :'''Clean Database'''
| |
| ::Clears the extras database (resets all play states for the extras) - Note: This does not do anything to the default XBMC database.
| |
| === Advanced ===
| |
| :'''Force Extras Button Display'''
| |
| ::Will always display the "Extras" button on the Video Information screen (Normal behaviour is to only show the button if there are extra's detected for the given video.
| |
| :'''Exclude Files Regular Expression'''
| |
| ::Regular expression for files that will be deemed "Not to be extras" even if there are present in the Extras directory.
| |
| :'''Enable Debug logging'''
| |
| ::Enables VideoExtras debug logging into the XBMC log file
| |
| | |
| <br />
| |
| <br />
| |
| == Skin Information ==
| |
| === Skins With Build In Support ===
| |
| The following skins have built-in support for Video Extras, so require no user skin modifications:
| |
| | |
| {| class="wikitable"
| |
| |-
| |
| ! Skin !! Hook Support !! Detailed Screen Support !! Detailed Screen Skin Location
| |
| |-
| |
| | [[Add-on:Confluence|Confluence]] || <center>No</center>|| <center>Yes</center> || <center>VideoExtras</center>
| |
| |-
| |
| | [http://forum.xbmc.org/showthread.php?tid=145080 Confluence Modified] || <center>Yes</center> || <center>Yes</center> || <center>VideoExtras</center>
| |
| |-
| |
| | [http://forum.xbmc.org/showthread.php?tid=139712 Immersive] || <center>Yes</center> || <center>Yes</center> || <center>Immersive</center>
| |
| |-
| |
| | [http://forum.xbmc.org/showthread.php?tid=165481 Xperience1080++] || <center>Yes</center> || <center>Yes</center> || <center>Xperience1080++</center>
| |
| |-
| |
| | [[Add-on:Aeon_MQ_5|Aeon MQ 5]] || <center>Yes</center> || <center>No</center> || <center>N/A</center>
| |
| |}
| |
| | |
| <br />
| |
| If your skin does not support the "Detailed List Screen", then you can either:
| |
| # Switch the "Detailed List Screen" off - reverting to the basic list dialog
| |
| # Convert the Window XML file in the addon and post a link to it in the forum.
| |
| <br />
| |
| <br />
| |
| === 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>):
| |
| <source lang="xml">
| |
| <onload condition="System.HasAddon(script.videoextras)">
| |
| XBMC.RunScript(script.videoextras,check,"$INFO[ListItem.FilenameAndPath]")</onload>
| |
| </source>
| |
| | |
| Add to near the foot of the file after the last control statement:
| |
| | |
| <source lang="xml">
| |
| <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>
| |
| </source>
| |
| <br />
| |
| You should be able to use something similar for other skins.
| |
| <br />
| |
| <br />
| |
| Alterations for other (non confluence) skins:
| |
| {| class="wikitable"
| |
| |-
| |
| ! Skin Name !! Changes Different from Confluence
| |
| |-
| |
| | Aeon Nox 4.x || As per confluence but change "ButtonInfoDialogsCommonValues" to "DialogVideoInfoButton"
| |
| |}
| |
| <br />
| |
| <br />
| |
| === Note To Skinners (Optional Feature) ===
| |
| :'''Overlay/Flag indicator'''
| |
| :If you wish to add an overlay or flag against TV Shows or Movies so that you can see if a given selection has any Extras without going into the Information Dialog, then a call can be made to:
| |
| | |
| <source lang="xml">
| |
| <onload condition="System.HasAddon(script.videoextras)">
| |
| XBMC.RunScript(script.videoextras,hasExtras,flag,"$INFO[ListItem.FilenameAndPath]")</onload>
| |
| </source>
| |
| | |
| :This will result in the current window (or dialog) getting a property set on it with the name matching "flag" with the value set to "true" if there are extras for the given FilenameAndPath. (No flag will be set if there are no extras)
| |
| <br />
| |
| <br />
| |
| | |
| === Request To Skinners (Detailed List Screen) ===
| |
| VideoExtras uses a custom window to show the extras, I have written the Window XML files for Confluence. With the large array of different skins available it is not possible to write versions for every skin. If you would be willing to support Video Extras I would really like to include a skin specific Window XML file for your skin and would be greatful for any contribution.
| |
| <br />
| |
| The files are very small, so hopefully will not take long to convert for your skin.
| |
| <br />
| |
| <br />
| |
| | |
| == Debugging ==
| |
| If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
| |
| * XBMC [[Settings/System#Debugging|logging]] from the main setting menu
| |
| * VideoExtras debug from the VideoExtras addon settings menu
| |
| Please do not paste the log into the forum thread, just link to it.
| |
| <br />
| |
| <br />
| |
| == 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.
| |
| | |
| [[Category:Frodo add-on repository]]
| |
