|Need help with this add-on? See here.|
TvTunes is equipped with powerful features that enable the fetching, organising and playing of themes whilst browsing your Kodi library, when used in conjunction with a compatible skin. (Special thanks to Ppic,Frost and ronie for their early work in developing TvTunes)
To install this add-on you must do so from the Add-on manager from within Kodi/XBMC by going to:
- Get add-ons
- Kodi/XBMC add-on repository
- Program Add-ons
2 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:
3 Theme File Names and Locations
If you wish to store your own theme files with each video and have TvTunes play them for you then the naming of the theme is important. There can be multiple themes with each video, but they must all start with the word "theme" and be of one of the supported types configured in the settings menu.
The search order for themes is:
- Themes in the same directory as the video file
- (If no theme found) search for themes in the parent directory
This allows for nested directories where seasons of TV Series are in separate directories, but all wish to use the same theme. It is also possible to store themes in a "Series directory" under a given TV Show, this can allow you to have different themes for each series of a given show. (Note: the TvTunes downloaded will only fetch themes at an entire TV Show level, not a per series level, so series specific themes need to be added or relocated manually)
For Movie Sets, all Movies in the set will be searched for themes, and these themes played in a random order when the Movie Set is selected in the Movie List screen.
There is also a settings option to define a directory (e.g. Themes) under the Movie or TV Show directory to look for themes, if themes are not found in this directory, then the previously defined order will be followed. (Note: Setting this value will result in downloaded themes also being saved into sub-directories)
Practical scenario of how themes are picked up by TvTunes
Regardless of how they are named and the file structure you have selected to use in TvTunes (Video folder, Themes folder or Custom path), TvTunes will play all audio files, which extensions are supported by TvTunes, as long as they include the string "theme" in their names. There is an additional feature provided only by the "Themes" folder, which allow you to even ignore the string "theme" in the names.
For example, all the following audio files will be played by TvTunes as themes for Maleficient (2014) regardless of the TvTunes' file system chosen:
- Maleficent (2014) 1080p BRRip H264 AAC-theme.ext
- Theme - Meleficient Suite.ext
- The Curse Won't Reverse theme.ext
- Arthemesia.ext (this will play too ;-))
- Theme.ext, theme1.ext, theme2.ext, theme3.ext, etc.
And if the themes are within the Themes folder, the following will also be played:
- Maleficient Suite.ext
- Battle of the Moors.ext
Obs. where .ext is any valid audio file supported by TvTunes. Remember you can also just have a tvtunes.nfo file pointing to a directory which contains the whole OST of the movie. Supported audio extensions refer to the extensions configured in TvTunes settings.
4 Video Themes
If you are using video themes and are storing them with your main videos (i.e. theme.avi) then you will need to ensure that they are not picked up when you run the scrapper to load your videos into the library. To ensure they are not picked up you can add the following to the advanced settings
<advancedsettings> <video> <!-- TvTunes: Section Start --> <excludefromscan action="append"> <regexp>/Themes/</regexp> <regexp>[\\/]Themes[\\/]</regexp> <regexp>theme\.(mp4|mkv|avi|mov|MP4|MKV|AVI|MOV)$</regexp> </excludefromscan> <excludetvshowsfromscan action="append"> <regexp>/Themes/</regexp> <regexp>[\\/]Themes[\\/]</regexp> <regexp>theme\.(mp4|mkv|avi|mov|MP4|MKV|AVI|MOV)$</regexp> </excludetvshowsfromscan> <!-- TvTunes: Section End --> </video> </advancedsettings>
There is also a button in the TvTunes settings that will do this for you.
5 NFO File Support
The themes for TvTunes to play can also be configured via a "tvtunes.nfo" file. This file should take the following format:
<tvtunes> <file>tvtunes.mp3</file> <file>C:\Kodi\SingleTheme\anothertvtunes.flac</file> <directory>C:\Kodi\RemoteThemes</directory> <playlistfile>playlist.m3u</playlistfile> <excludeFromScreensaver/> <checkThemeExists/> </tvtunes>
There can be any number of "file"/"directory"/"playlistfile" elements, where they represent:
- file - The name of a theme file in the same directory, or the full path if in a different directory
- directory - The name of a directory below the existing directory, or the full path to a remote directory
- playlistfile - Either the full path to a playlist file, a playlist file in the same directory or the name of an Kodi playlist file. (The extension "m3u" will be added if not already specified)
- excludeFromScreensaver - Will result in the given Movie or TvShow being excluded from the TvTunes screensaver
- checkThemeExists - Will check each file and directory location listed to see if it exists before adding it to the playlist (This can be useful if you have a removable drive with the themes that is not always attached)
Smart Playlists: To make use of a Smart Playlist in Kodi you can supply just the name of the playlist file (No path) but including the extension ".xsp"
Inclusive behavior:The tvtunes.nfo files are non-exclusive to any other valid set up through which the audio themes will play in TVTunes, which means that a tvtunes.nfo will follow same location, search and play criteria as described for 'Theme File Names and Locations', e.g.; any spare audio themes located within the same directory of the tvtunes.nfo will be played along (and shuffled, if option selected) with the themes defined by the latter.
6 Theme Scraper
TvTunes has the ability to retrieve themes from the web for a given TV Show, Movie or Music Video. The websites currently supported are:
TvTunes will search for two specific terms (<title> and <originaltitle> of the video) and will try and automatically filter the results in order to display only the best matches. If you wish to view the un-filtered version of results, then you can make use of the "Manual Search" option within TvTunes.
Obs: As it searches, TvTunes will show a progress bar; please be patient since sometimes the results to be filtered are in the magnitude of thousands.
6.1 Understanding the Entries List
6.1.1 Prioritisation of the entries
The priorities in which the filtered results are shown on the entries list are:
- priority 1 = * (full match: most accurate match in relation to TvTunes' pre-defined soundtrack music tags/appendixes)
- priority 2 = ~ (album only match: only the album name (not the artist) contains one of the search terms)
- priority 3 = + (title only match: only the track title contains one of the search terms)
- priority 4 = (everything else: all which was filtered out)
Obs: priority 2 is currently only applicable to Grooveshark and Goear retrieved results.
6.1.2 Tags & Separators
Entries from each scraper are listed using their available tag identifiers (in angled brackets) and separators (in blue), in the following order (identifiers are not always available or properly tagged at the source):
- Televisiontunes: <title name> e.g., Jaws
- Soundcloud: <title name> [hh:mm:ss] | e.g., Jaws Theme Song [00:02:16]
- Goear: <title name> / <artist name> [mm:ss] (###kbps) | e.g., Jaws Overture / John Williams [2:55] (320kbps)
- Grooveshark: <title name> / <album name> — <artist name> [hh:mm:ss] | e.g., Jaws Theme / OST Jaws - John Williams [00:02:37]
6.1.3 International characters
People from all over the world share their themes and hence many different languages are used to tag them. If some of these tags had special characters not compatible with certain Kodi fonts, you would see blank spaces instead. If this happened to you (1st item below), all you have to do is switch to a font such as 'arial base' (2nd item below) and you will see the missing content:
- / (Nausicaä of the Valley) - Joe Hisaishi [00:03:54]
- 風の伝説 / 风之谷交响乐(Nausicaä of the Valley) - 久石讓 Joe Hisaishi [00:03:54]
TvTunes has a built in screensaver. This can be used completely independently of the theme playing ability (So if you do not want Themes playing on your installation, you can still make use of the screensaver). There are several different formats of screensaver within TvTunes:
- Slider - This will slide the images into view from either the left, right, top or bottom of the screen.
- Crossfade - will fade one image in over the top of the next image
- TableDrop - will drop each image onto the screen at random overlaps and angles
- StarWars - will show a stream of images similar to the Star Wars intro sequence
- RandomZoomIn - will randomly zoom in to each image in turn
- AppleTVLike - like the Apple TV Screensaver, will scroll a mix of images up from the bottom of the screen
- GridSwitch - will show several images at the same time in a grid format
- Random - will randomly show one of the above screensaver formats
There are several options for each of the different screen saver that control the speed images move or how frequently the image changes.
This section details all the settings options for TvTunes
8.3 File System
9 Theme Browser
The "Theme Browser" enables you to look at which Movies/TV Shows/Music Videos already have themes available for. You can listen to them as it gives you the ability to download new themes. You can load the theme browser in the following ways:
- Via the TvTunes Settings screen "Download" -> "Browse Themes"
- From the Programs Menu -> TvTunes
- Videos -> Addons -> TvTunes
10 Skins With Build In Support
The following skins have built-in support for TV Tunes, so require no user skin modifications (Remember to enable TvTunes in the Skin Settings!):
- Aeon MQ 5
- Aeon Nox 5 (controls in custom_1119_ExtrasDialog.xml, line 93)
- Aeon Nox 4.1.9.x
- XBMC Immerse
- Cirrus Extended (V3)
- Confluence Modified
- Xperience1080++ (Fix for Gotham )
Obs: due to a natural delay between the dates of release of possible latest features (and fixed issues too) and actual implementation of these updates in the supported skins, such as support for Music Videos, these skins may still require some manual changes as per item 9 in certain skins with built-in support.
11 Skin Changes
Most skins support TvTunes OOTB, so no manual changes are required, the following information is aimed at skinners. The following show what the TvTunes changes in Confluence are (Other skins will have similar changes)
Add to near the foot of the file after the last control statement [Allows download of theme on a video by video basis]:
<control type="button" id="100"> <description>Fetch TvTunes stuff</description> <include>ButtonInfoDialogsCommonValues</include> <label>31127</label> <onclick>RunScript(script.tvtunes,mode=solo)</onclick> <visible>Skin.HasSetting(ActivateTvTunes) + System.HasAddon(script.tvtunes) + [Container.Content(TVShows) | Container.Content(movies) | Container.Content(musicvideos)] + IsEmpty(Window(movieinformation).Property("TvTunes_HideVideoInfoButton"))</visible> </control>
11.1.1 Location of XML files
- OS X: /Applications/Kodi.app/Contents/Resources/Kodi/addons/skin.confluence/720p
- Windows 8.1: Program Files (x86)\Kodi\addons\skin.confluence\720p
11.2 Skin - TvTunes Active Detection
If a skin (or other Addon) wishes to work out if TvTunes is currently playing a theme (and maybe not show something if TvTunes is running), then a check can be made to see if the PlayingBackgroundMedia value is set:
This can be useful if you wish to stop things like "Music Visualizations" while the theme is playing.
Note: In Pre 5.0 versions of TvTunes, this variable was called TvTunesIsAlive.
12 Skin/Addon - Blocking Theme Playing
If you wish to stop TvTunes from playing a theme , then you can set the value "TvTunesBlocked":
But please ensure you also clear the property when the plugin no longer needs to block themes playing
xbmcgui.Window(10025).clearProperty( "TvTunesBlocked" )
13 Skin - Custom Windows
By Default TvTunes will only activate when in the official "Videos" section. If you have a custom Window in a skin or Addon that you with a theme to be activated for, then you can add the following line to your window-xml file in addition to the previously detailed onLoad action.
For Movie Themes add:
For TV Themes add:
If you have an addon that is migrating between screens and you want to ensure that TvTunes does not have a break in playing, you can set a property on the home screen to force playing of an existing track continues. This can be done by:
xbmcgui.Window( 12000 ).setProperty( "TvTunesContinuePlaying", "True" )
But please ensure you also clear the property when the plugin no longer needs to force the theme to play
xbmcgui.Window( 12000 ).clearProperty( "TvTunesContinuePlaying" )
14 Known Issues
There is currently a known issue that can not currently be fixed, please do not raise an Issue on the google system for this, as there is currently nothing that can be done about this.
14.1 Sceensaver (Frodo Only)
When the screensaver is about to start, TvTunes stops playing the theme. Unfortunately this is seen as "activity" so the screensaver time is reset and will not kick in again until the screensaver idle time as expired for a second time. In frodo this can be avoided by set the "Fade out after playing for (minutes)" to less than the screen saver value in TvTunes setting
14.2 Addon Selection
In order for TvTunes to download themes via the Videos -> Add-on method, you must have the System setting for Video -> File lists -> "Default select action" set to "Play". With this set to the other values such as "Show Information" the addon will not even be called by Kodi. (Downloading via the Video Information Screen is unaffected by this setting)
14.3 Setting: Store tunes in a custom path
There is an issue with storing all the themes in a custom path if you use TvTunes to play themes for both TV Shows and Movies. This can occur when you have a TV Show and a Movie with the same name, as it will store them in the same sub-directory. This is a legacy setting that has been in TvTunes a while, ideally the TV Shows and Movies would be stored in different location, however making this change now would break existing users.
14.4 Video Themes And Looping
If you have a video theme and set it to loop then when it starts the second playing of a video theme, it will flash up full screen. This is a Kodi issue detailed on the following bug report: TRAC-16013
15 Creating Your Own Theme
If a theme is not available on www.televisiontunes.com for your TV Show or Movie, then it is possible to create your own from your video file. You can do this in many ways, but detailed below is one that is free.
First download ffmpeg
Then play your video file and take note of the timestamps of where your TV Theme starts playing and where it stops. Then on the command line you can run the command:
ffmpeg -ss 00:02:00 -t 00:04:00 -i VideoFile.mkv theme.mp3
Where the value after -ss is the start time in the format hh:mm:ss and the value after -t is the duration to extract for. (You can use -to hh:mm:ss after the filename instead of the -t option to specify an explicit stop time)
Once you have generated the theme, then maybe uploading your newly generated theme to www.televisiontunes.com would be a nice thing to do so other users can benefit from it. You may email any songs that you have to their e-mail address firstname.lastname@example.org, including the exact name and year of the tv shows/movies.
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
- Kodi logging from the main setting menu
- TvTunes debug from the TvTunes addon settings menu
Please do not paste the log into the forum thread, just link to it.
If you have found TvTunes useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
Please use the link on the top of the TvTunes Forum