Add-on:VideoExtras: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
(Created page with "<!-- See http://wiki.xbmc.org/index.php?title=Template:Addon and http://wiki.xbmc.org/index.php?title=Help:Add-on_page for help editing this page --> {{Add-on |Name= VideoEx...")
 
(Initial details)
Line 24: Line 24:


<!-- Page content goes here -->
<!-- Page content goes here -->
<br />
<br />
== 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 [http://wiki.xbmc.org/index.php?title=Add-on:TvTunes TvTunes] then you should use the version of [http://wiki.xbmc.org/index.php?title=Add-on:TvTunes TvTunes] from the same repository as VideoExtras. (Installing the robwebset repository will automatically update to that version).
<br />
:[http://robwebset.googlecode.com/svn/releases/repository.robwebset/repository.robwebset-1.0.0.zip RobWebset Repo]
<br />
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)
<br />
<br />
== 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:
:[http://forum.xbmc.org/showthread.php?tid=125024 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 &quot;Extras&quot; 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. 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 &quot;[0]Deleted Scenes.mkv&quot;, &quot;[1]Bloopers.mkv&quot;, and &quot;[2]Behind The Scenes.mkv&quot;. 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 />
=== Same Directory ===
If for some reason you don't want to create an &quot;Extras&quot; 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 &quot;-extras-Display name here&quot;. So if you wanted to associate an &quot;Extended Pilot&quot; feature with the first episode of a TV show named &quot;s01e01.mkv&quot;, you would create a file name &quot;s01e01-extras-Extended Pilot.mkv&quot;. When the script displays this file in the UI it will strip out all the extra data and just show &quot;Extended Pilot&quot;. To customize the order here you can use the same format as the extras folder. Example: &quot;s01e01-extras-[99]Extended Pilot.mkv&quot;
<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">
<video>
  <excludefromscan>
    <regexp>-extras-</regexp>
    <regexp>[\\/]Extras[\\/]</regexp>
  </excludefromscan>
  <excludetvshowsfromscan>
    <regexp>-extras-</regexp>
    <regexp>[\\/]Extras[\\/]</regexp>
  </excludetvshowsfromscan>
</video>
</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 />
== 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:
<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 />
== 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:Add-ons not in the XBMC.org repo]]
[[Category:Add-ons not in the XBMC.org repo]]

Revision as of 12:51, 22 October 2013

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
Home icon grey.png   ▶ Add-ons ▶ VideoExtras
Attention talk.png 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. 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.

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-Display name here". So if you wanted to associate an "Extended Pilot" feature with the first episode of a TV show named "s01e01.mkv", you would create a file name "s01e01-extras-Extended Pilot.mkv". When the script displays this file in the UI it will strip out all the extra data and just show "Extended Pilot". To customize the order here you can use the same format as the extras folder. Example: "s01e01-extras-[99]Extended Pilot.mkv"


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.

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:

<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.

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.