Official Kodi Wiki - User contributions [en]

Add-on:OpenWeatherMap Extended

2017-12-08T21:24:08Z

JustAnotherKODIUser: Added hint to required API Key

{{Addon
|Name=OpenWeatherMap Extended
|provider-name=ronie
|ID=weather.openweathermap.extended
|latest-version=4.2.3
|extension point=xbmc.python.weather
|provides=
|Summary=Weather forecast from openweathermap.org
|Description=Weather forecast provided by OpenWeatherMap (http://openweathermap.org/)
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE Version 2
|Forum=http://forum.kodi.tv/showthread.php?tid=207110
|Website=
|Source=https://github.com/ronie/weather.openweathermap.extended/
|Email=
|broken=
|icon url=http://mirrors.kodi.tv/addons/krypton/weather.openweathermap.extended/icon.png}}
== Personal API Key ==
To use this addon, it is required to get your own api key and enter it in the addon settings.
You can get your api key at: http://openweathermap.org/appid
[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:All add-ons]]
[[Category:Weather add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:VideoExtras

2016-09-06T19:35:05Z

JustAnotherKODIUser: /* Install VideoExtras */ no longer in official repro, link to robwebset

{{Addon
|Name=VideoExtras
|provider-name=robwebset
|ID=script.videoextras
|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 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=214289
|Website=
|Source=https://github.com/robwebset/script.videoextras
|Email=
|broken=
|icon url=https://github.com/robwebset/script.videoextras/raw/master/icon.png}}


== Introduction ==
You can install this addon from: [[Repository:robwebset]]
<br />
<br />
VideoExtras is an addon to allow you to store, list and play the "extras" for a given Movie or TV Series. (i.e. The extras that often come on DVD's or Blu-Rays)

:''Note:'' This Addon will allow you to view the Extras Videos you already own - it will NOT download extras for you from the internet. (Although there is an option to use YouTube and Vimeo to search and view for extra video content)
<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.kodi.tv/showthread.php?tid=214289 VideoExtras Forum]

<br />
== Quickstart Guide ==
This Quickstart guide is aimed at first time users of VideoExtras, who also have some freedom to re-arrange their video content to fit best with VideoExtras.
==== Install VideoExtras ====
VideoExtras is no longer in the official repo, you can install it from [[Repository:robwebset]]

==== Arranging Your Video Files ====
Although VideoExtras will support most structures (with various configuration changes), the easiest and best structure is as follows:

:''../<Movie Name>/<movie name>.ext''
:''../<Movie Name>/Extras/<extras name 1>.ext''
:''../<Movie Name>/Extras/<extras name 2>.ext''
:''...''
:where .ext is any video extension compatible with Kodi
More details of extras setup can be found in the [[Add-on:VideoExtras#File_Naming_Convention|File Naming Convention Section]]

==== Stopping The Extras Being Scanned Into Your Library ====
Now that you have copied your Extras files into the correct directories, you do not want them to be accidently picked up/scanned as a Movie or TV Series in their own right. To stop this you need to add "excludes" into the advancedsettings.xml file. This can be done for you by clicking on the [[Add-on:VideoExtras#Extras|"Update advancedsettings.xml File"]] operation on the first tab of the VideoExtras settings, or you could always do it yourself [[Add-on:VideoExtras#Kodi_File_Exclusions|manually]].
==== Scanning Media Into Your Library ====
Once you have updated the advancedsettings.xml file it should now be safe to perform any scans you wish to pull media into your library. At this point, the scanner should skip over any Extras files.
==== Viewing Your Extras ====
In order to view the Extras you have now stored with your Movies or TV Shows you will need one of the following 2 things:
* To update the default Confluence Skin, this can either be done [[Add-on:VideoExtras#Skin_Modifications|manually]] or by navigating to the Advanced tab of the VideoExtras settings and clicking on [[Add-on:VideoExtras#Advanced|"Update Confluence Skin"]].
* Use one of the non default [[Add-on:VideoExtras#Skins_With_Build_In_Support|skins that has built in support]] for VideoExtras
==== You Are Now Up And Running ====
That's it! You should now be able to navigate to your extras by either going to the Video Information Dialog for the given video, or by going via: ''[[Add-on:VideoExtras#Video_Extras_Browser|Videos -> Addons -> VideoExtras]]''
<br />
There are plenty more things you can do to improve your user experience such as adding [[Add-on:VideoExtras#Images:_Thumbnails.2C_Icons_and_Fanart|icons/fanart/thumbnails]] or giving detailed [[Add-on:VideoExtras#NFO_Files|titles or plots]]. However, this is a quickstart guide, and you should take a look at the rest of the wiki for those features.
<br />
<br />
== Using VideoExtras ==
Now that you have [[Add-on:VideoExtras#Quickstart_Guide|configured]] VideoExtras, you can start using it. If you are using Confluence with the supplied [[Add-on:VideoExtras#Viewing_Your_Extras|Confluence update]] then any Movies or TV Shows that have extras will be highlighted with an overlay image:
<center><br />[[File:VideoExtras-ThumbnailOverlay.JPG|VideoExtras Overlay|center|thumb|200px]]</center>
<br />Then if you navigate into the Video Information Screen you should see an Extras button available:
<center><br />[[File:VideoExtras-VideoInfoDialog.JPG|VideoExtras Button (Video Information Screen)|center|thumb|400px]]</center>
<br />Selecting this button will then result in seeing the list of extras available:
<center><br />[[File:VideoExtras-DetailedListScreen.JPG|VideoExtras - Extras list|center|thumb|400px]]</center>
<br />
<br />

== Video Extras Browser ==
The VideoExtras browser allows you to view all the Movies/Tv Shows/Music Videos that have extras, and then watch those extras. You can load the extras browser in the following ways:
# Via the [[Add-on:VideoExtras#Database|VideoExtras Settings screen]] "Database" -> "Browse Extras"
# From the Programs Menu -> VideoExtras
# Videos -> Addons -> VideoExtras
<br />
<br />
== Online Video Platforms Support ==
{| border="0"
|- valign=top
|
It you have the '''[[Add-on:YouTube|YouTube]]''' or '''[[Add-on:Vimeo|Vimeo]]''' addons installed and the options enabled in the [[Add-on:VideoExtras#Advanced|settings]] you can be forwarded directly to the videos that would result in a search of "<Movie Name> Extras", or by calling up the context menu there are options to search for other parameters.
|[[File:VideoExtras Youtube Support.png|VideoExtras Youtube Support|right|thumb|400px]]
[[File:VideoExtras Vimeo Support.png|VideoExtras Vimeo Support|right|thumb|400px]]
|}
<br />
<br />

== Settings ==
This section details all the settings options for VideoExtras
==== Extras ====
{| border="0"
|- valign=top
|
:'''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"
:<u>'''''Operations'''''</u>
::
:'''Update advancedsettings.xml File'''
::Will update (or create if it does not already exist) the advancedsettings.xml file so that your extras files are not accidently read into the library and incorrectly detected as actual Movies or TV Shows
| [[File:VideoExtras-Settings1.JPG|VideoExtras Settings - Extras tab|right|thumb|400px]]
|}

==== File System ====
{| border="0"
|- valign=top
|
:'''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)
:'''Custom Music Video Sub-Folder'''
::The name of the folder under the ''"Path"'' where Music Video extras are stored (Note: a directory with the Music Video name will be located under this directory containing the extras for that Music Video)
:<u>'''''Debugging'''''</u>
::
:'''Enable Debug logging'''
::Enables VideoExtras debug logging into the Kodi log file
| [[File:VideoExtras-Settings2.JPG|VideoExtras Settings - File System tab|right|thumb|400px]]
|}

==== Database ====
{| border="0"
|- valign=top
|
:'''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
:<u>'''''Operations'''''</u>
::
:'''Clean Database'''
::Clears the extras database (resets all play states for the extras) - Note: This does not do anything to the default Kodi database.
:'''Browse Extras'''
::Loads the Video Extras Browser plugin.
| [[File:VideoExtras-Settings3.JPG|VideoExtras Settings - Database tab|right|thumb|400px]]
|}

==== Advanced ====
{| border="0"
|- valign=top
|
:'''Enable YouTube Search Support'''
::Enabling this option will allow you to search for extra content for your video on YouTube (Requires the [[Add-on:YouTube|YouTube]] add-on)
:'''Enable Vimeo Search Support'''
::Enabling this option will allow you to search for extra content for your video on Vimeo (Requires the [[Add-on:Vimeo|Vimeo]] add-on)
:'''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.
:'''Allow caching of extras on startup'''
::Used to cache the video extras available so that it can be used for icon overlays in some skins, if you do not wish to see icon overlays (or do not use a skin that supports them) then disable this option.
:'''Use Custom Images'''
::Allows you to change the images used in the skin to highlight if extras exist (Note: Changing these values will only be visable after a restart of Kodi)
:'''- Overlay Image'''
::(If Use Custom Images is enabled) The image that is drawn over the top of the thumbnail/cover
:'''- List Image'''
::(If Use Custom Images is enabled) The image that is used when adding to a list
:<u>'''''Operations'''''</u>
::
:'''Update Confluence Skin'''
::Will add VideoExtras support to the default confluence skin
| [[File:VideoExtras-Settings4.JPG|VideoExtras Settings - Advanced tab|right|thumb|400px]]
|}
<br />
<br />

== File Naming Convention ==
For your video extras files to be found they must follow a specific naming convention. VideoExtras currently supports extras videos from Movies, TV Shows and Music Videos. 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 (Tagging) ===

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 which uses tagging. Simply use the same name as the file you want to associate the extra feature with and then append "-extras-" followed immediately (no spaces) by the name you want to displayed on the GUI for the extra, e.g. ''<main video name>-extras-<displayed name>.mkv'' . This default tag "-extras-" can be changed via the settings menu and MUST be turned on in order for the tagging to work.

This method will work whether your movies are in their own self-contained folder or all together in one folder only.

'''Example:''' So if you wanted to associate an Extended Pilot feature with the first episode of a tv show named "s1e1.mkv", you would create a file name "s1e1-extras-Extended Pilot.mkv". When the script displays this file in the UI it will strip out all the extra stuff and just show "Extended Pilot". To customize the displayed order here you can use NFO files or manual mode, just as in folder mode. Example of manual mode: "s1e1-extras-[#]Extended Pilot.mkv" where # is a number from 1 to 99.

'''Warning:''' if you don't append the <displayed name> after the tag -extras-, the file name will be displayed on the GUI instead, including the tag -extras-.
<br />

=== Remote Location ===

If you did not want your extras stored in the same directory structure as your Movies, TV Shows or Music Videos, 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 3 directories at the top level: "Movies", "TvShows" and "MusicVideos". Under each of these should be directories (That match the name of the directories containing the Movies, TV Shows and Music Videos) 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 />
Note: When using a custom path VideoExtras will first check for a directory name that matches the directory containing the actual TV Show or Movie. (As described above) If that is not found, then it will use the text title of the Movie or TV Show as the directory name to look for with the following replacements:
* : (Colon) removed from the name
* / or \\ (Forward or back slash) replaced with -
* . (dot) removed from the end of the name
* Non ascii characters are removed
<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://kodi.wiki/view/Advancedsettings.xml advanced settings].
<br />
<br />

== Kodi File Exclusions ==

Since these are video files sprinkled in among all of your other video files we need to tell the kodi 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://kodi.wiki/view/Advancedsettings.xml advanced settings]. This can be done for you by clicking on the [[Add-on:VideoExtras#Extras|"Update advancedsettings.xml File"]] operation on the first tab of the VideoExtras settings, or you can do this manually using some of the information below. It is recommended to add these settings and reboot Kodi for them to take effect BEFORE any library scan takes place, so the scanner doesn't try to parse them.

<source lang="xml">
<advancedsettings>
<video>
<excludefromscan action="append">
<regexp>-extras-</regexp>
<regexp>/Extras/</regexp>
<regexp>/extras/</regexp>
<regexp>[\\/]Extras[\\/]</regexp>
<regexp>[\\/]extras[\\/]</regexp>
</excludefromscan>
<excludetvshowsfromscan action="append">
<regexp>-extras-</regexp>
<regexp>/Extras/</regexp>
<regexp>/extras/</regexp>
<regexp>[\\/]Extras[\\/]</regexp>
<regexp>[\\/]extras[\\/]</regexp>
</excludetvshowsfromscan>
</video>
</advancedsettings>
</source>

<small>''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.''</small>

Obs.:

1) If you executed a library scan before the regexps have been put in place and found extra material accidentally scanned to your library, you can either remove/rename the extra material and conduct a 'clean library' under Kodi video settings or, delete the video sources and rescan them again after the regexps are operating properly.

2) Beware that if any of your sources contains the word 'extras' in it, e.g. a source named 'Extrasy' or 'Extrascent', nothing new that you put in it will be scanned to the library. This is because that source matches the exclude rule RegExp:'Extras'. To solve this either rename your source or change the default name 'extras', which VideoExtras operates with, to anything different.
<br />
<br />

== Images: Thumbnails, Icons and Fanart ==
=== Custom Artwork ===
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 (assigns same thumb to all those extras without one)
* folder.tbn/png/jpg (assings same thumb to all those extras without one)

For fanart, the images are picked up in the following order :
* <filename>-fanart.tbn/png/jpg
* fanart.tbn/png/jpg

<small>obs: should you experience image caching persistency of old <filename>-poster/thumb.ext after replacing them by new ones at folder level, this is due to the way Kodi handles the caching of certain images. If you need an immediate solution and don't want to wait for Kodi to cache the new images, there is a script available that solves this issue at database level [http://Just%20to%20help%20with%20the%20cleansing%20of%20thumbs%20cached%20in%20XBMC%20to%20allow%20VideoExtras%20to%20display%20updated%20thumbs%20for%20your%20extras here] called Texture Cache Maintenance utility by MilhouseVH. There aren't cases reported of image caching persistency when using the naming convention <filename>.tbn/png/jpg</small>

=== Default Artwork ===
* '''If no custom fanart:''' fanart is automatically inherited from the parent video file, if there's any.
* '''If no custom thumb (poster):''' default thumb is VideoExtras image icon and will only be displayed in the video overlay whilst playing the extra and not in the extras list.
<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 Kodi 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 Kodi behaviour), additional data in these files will be ignored as it is not relevant for the extras file. (Note: The only mandatory element is the "title")

=== Movie NFO Format ===
<source lang="xml">
<?xml version='1.0' encoding='UTF-8'?>
<movie>
<title>Who knows</title>
<sorttitle>Who knows 1</sorttitle>
<plot>Something happens</plot>
<thumb>thumbnail.jpg</thumb>
<fanart>background.jpg</fanart>
</movie>
</source>

=== TV Show NFO Format ===
<source lang="xml">
<?xml version='1.0' encoding='UTF-8'?>
<tvshow>
<title>Who knows</title>
<sorttitle>Who knows 1</sorttitle>
<plot>Something happens</plot>
<thumb>http://forum.kodi.tv/images/xbmc/xbmc-lettering.png</thumb>
<fanart>http://forum.kodi.tv/images/xbmc/xbmc-lettering.png</fanart>
</tvshow>
</source>

=== TV Episode NFO Format ===
<source lang="xml">
<?xml version='1.0' encoding='UTF-8'?>
<episodedetails>
<title>Who knows</title>
<season>2</season>
<episode>1</episode>
<plot>Something happens</plot>
<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 />
== "videoextras.nfo" Files ==

If you do not have your video extras files stored in a standard location (as already described in the previous sections) then it is possible to create a file with the name "videoextras.nfo" in the same directory as your Movie or TV Show. This file must be of the following format:

<source lang="xml">
<?xml version='1.0' encoding='UTF-8'?>
<videoextras>
<file>..\..\Extras\Extras01.mkv</file>
<directory>C:\Kodi\Sample-Data\Movies\Extras</directory>
</videoextras>
</source>

You can have multiple "file" or "directory" entries in the "videoextras.nfo" file (or none of one type). The "file" will result in just the given file being listed in the extras. The "directory" will result in the entire contents of the directory being listed.
: ''Note: It is only logical to use this approach if you have each movie in it's own directory, as adding a videoextras.nfo file to a directory containing multiple movies will result in every movie in that directory picking up the extras defined in the videoextras.nfo file''
=== Common extras content for Movie Sets ===
The videoextras.nfo's capabilities are useful to assign common extras content to movies within a set (collection), thus we would have only one physical copy of the 'Extras' folder somewhere whilst each videoextras.nfo is pointing at it.
<br />
<br />
== Skin Information ==
=== Skins With Build In Support ===
The following skins (except Confluence, since it requires the hooks) 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 !! Hooks Location
|-
| [[Add-on:Confluence|Confluence]] || <center>No</center>|| <center>Yes</center> || <center>VideoExtras</center> || <center>[https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/DialogVideoInfo.xml DialogVideoInfo.xml]</center>
|-
| [http://forum.kodi.tv/showthread.php?tid=145080 Confluence Modified] || <center>Yes</center> || <center>Yes</center> || <center>VideoExtras</center>
|-
| [http://forum.kodi.tv/showthread.php?tid=139712 Immersive] || <center>Yes</center> || <center>Yes</center> || <center>Immersive</center> || <center>[https://github.com/Sranshaft/skin.immersive/blob/master/720p/DialogVideoInfo.xml DialogVideoInfo.xml]</center>
|-
| [http://forum.kodi.tv/showthread.php?tid=165481 Xperience1080++] || <center>Yes</center> || <center>Yes</center> || <center>Xperience1080++</center> || <center></center>
|-
| [[Add-on:Aeon_MQ_5|Aeon MQ 5]] || <center>Yes</center> || <center>Yes</center> || <center>VideoExtras</center> || <center></center>
|-
| [[Add-on:Aeon_Nox|Aeon Nox 5]] || <center>Yes</center> || <center>Yes</center> || <center>VideoExtras</center> || <center>[https://github.com/BigNoid/Aeon-Nox/blob/master/1080i/custom_1119_ExtrasDialog.xml custom_1119_ExtrasDialog.xml]</center>
|-
| [http://forum.kodi.tv/showthread.php?tid=185290 Aeon Nox 4.1.9.x] || <center>Yes</center> || <center>Yes</center> || <center>Aeon Nox 4.1.9.x</center> || <center></center>
|-
| [[Add-on:Rapier|Rapier]] || <center>Yes</center> || <center>Yes</center> || <center>Rapier</center> || <center></center>
|-
| [http://forum.kodi.tv/showthread.php?tid=170954 Artic mk. ii] || <center>Yes</center> || <center>Yes</center> || <center>Artic</center> || <center></center>
|-
| [[Add-on:Metropolis| Metropolis]] ([http://forum.kodi.tv/showthread.php?tid=99317&pid=1726112#pid1726112 coming soon!]) || <center></center> || <center></center> || <center></center> || <center></center>
|-
| [[Add-on:XTV-SAF| xTV-SAF]] || <center>Yes</center> || <center>Yes</center> || <center>VideoExtras</center> || <center></center>
|-
| [[Add-on:Transparency!|Transparency!]] || <center>Yes</center> || <center>Yes</center> || <center>VideoExtras</center> || <center>[https://github.com/ronie/skin.transparency/blob/master/720p/custom_DialogExtras.xml custom_DialogExtras.xml]</center>
|-
| [[Add-on:Titan MediaBrowser| Titan MediaBrowser]] || <center>Yes</center> || <center>Yes</center> || <center>VideoExtras</center> || <center></center>
|-
| [[Add-on:Black_Glass_Nova|Black Glass Nova 3.x]] || <center>Yes</center> || <center>Yes</center> || <center>Black Glass Nova</center> || <center>[https://github.com/Tgxcorporation/skin.blackglassnova/blob/master/1080i/DialogVideoInfo.xml DialogVideoInfo.xml]</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.
# Use the default "Detailed List Screen" (May not fit in visually with the skin you are using)

<small>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 [[Add-on:VideoExtras#Skin_Modifications|item 10.2]] in certain skins with built-in support.</small>
<br />
<br />

=== Confluence Skin Support ===
A request has been made to the Kodi official repo to have VideoExtras included in the Confluence skin:
https://github.com/xbmc/xbmc/pull/4827
Unfortunately this did not get approved to go into the official repository.
<br />
<br />
Instead of this, there is an option that will update the Confluence skin for you in the settings. Just navigate to the [[Add-on:VideoExtras#Advanced|"Update Confluence Skin"]] operation in the VideoExtras settings.
<br />
<br />

;Note:
For this update to work, the directory containing the Confluence skin must have write permissions set. To get around this:
* ''' on Windows Vista, 7 and 8.x:''' right click Kodi and select "Run As administrator" and (if it prompts), click "Yes". Then navigate to the "Update Confluence Skin" operation in the VideoExtras settings. (If you select this option without doing a "run as administrator", it will say that it has updated the file successfully, but actually it won't.) - This is believed to only be an issue if you have "User Access Control" enabled<br />

As Confluence is the default skin, its directory is not user-modifiable on non-Windows systems. To get around this, it is recommended to copy the Confluence skin's directory from it's existing location to the standard location for user installed add-ons:<br />
* '''On Ubuntu Linux:''' the operation would be to copy the directory "/usr/share/kodi/addons/skin.confluence/" to "/home/<username>/.kodi/addons/".<br />
Upon restarting Kodi, you should now be able to use the "Update Confluence Skin" feature.<br />
<br />

=== Skin Modifications ===
A skin modification is required in order to see the extras button in the UI and enjoy all the features. This is a fairly simple process but will depend on your selected skin. The file that needs modified is DialogVideoInfo.xml. The following code is needed for the default confluence skin, which would result in the new, [https://dl.dropboxusercontent.com/u/56161346/XBMC/VideoExtras/DialogVideoInfo%20062015/DialogVideoInfo.xml modified DialogVideoInfo.xml] (as per June 2015) with support for VideoExtras:

Add to the top of the file (after <window>):
<source lang="xml">
<onload condition="System.HasAddon(script.videoextras)">
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>RunScript(script.videoextras,display,"$INFO[ListItem.FilenameAndPath]")</onclick>
<visible>System.HasAddon(script.videoextras)
+ [Container.Content(movies) | Container.Content(episodes) | Container.Content(TVShows)
| Container.Content(musicvideos)]
+ IsEmpty(Window(movieinformation).Property("HideVideoExtrasButton"))</visible>
</control>
</source>
You should be able to use something similar for other skins.

==== Location of XML ====
The DialogVideoInfo.xml's location listed by skin:
;Confluence
* '''Ubuntu Linux:''' /home/<username>/.kodi/addons/skin.confluence/720p/
* '''Ubuntu Linux (alternative):''': /usr/share/kodi/addons/skin.confluence/720p/
* '''OS X:''' /Applications/Kodi.app/Contents/Resources/Kodi/addons/skin.confluence/720p
* '''Windows 7/8.1:''' Program Files (x86)\Kodi\addons\skin.confluence\720p
;Aeon Nox 4
* '''Ubuntu Linux:''' /home/<username>/.kodi/addons/skin.aeon.nox/1080i/
* '''Windows 7/8.1:''' Program Files (x86)\Kodi\addons\skin.aeon.nox\1080i\

<small>Obs.: Remember to create a backup of any file before altering it i.e. DialogVideoInfo.xml.old.</small>

=== Icon Overlay on Video List Screen (Advanced Skinners Only) ===
If you are a skinner and wish to add support for some form of indication that a Movie/TV Show has extras, there is a way, it is not perfect but should get the overlays working. The first part is that you need to have "Allow caching of extras on startup" enabled in the VideoExtras settings. You then need the following in your skin:

<source lang="xml">
<control type="image">
<posx>950</posx>
<posy>14</posy>
<width>16</width>
<height>16</height>
<texture fallback="blank.png">$INFO[ListItem.DBID,special://profile/addon_data/script.videoextras/movies/,.png]</texture>
<visible>System.HasAddon(script.videoextras) + Window.IsVisible(Videos) + Container.Content(Movies)</visible>
</control>
</source>

This example would possibly be added to the confluence skin at line 554 to add an icon to movies on the "biglist" screen. There are 3 different values that can be used:

{| class="wikitable"
|-
| movies || Container.Content(Movies)
|-
| tvshows|| Container.Content(TVShows)
|-
| musicvideos|| Container.Content(MusicVideos)
|}

Where the first column supplies the value used in the <texture> element, and the second for the <visible> element.
<br />
<br />
There is a default image that is used to represent the existance of Video Extras, but this can be overridden by the skin by putting a file called "videoextras_overlay.png" in the skins "media" directory, or by updating the [[Add-on:VideoExtras#Advanced|VideoExtras settings]].
<br />
<br />
IMPORTANT: This is for advanced skinners only, please only post on the forum if you '''own the skin you are trying to update''' - this is because it will require lots of changes to patch an existing skin, and this feature is only intended to support skins that will support VideoExtras "Out Of The Box".
<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 />

== Known Issues ==
=== Cast List In Summary Screen Not Populated ===
There is a known issue that when you return from the detailed list screen that shows the extras back to the summary screen, the Cast section is not populated, the following was posted for this, but there is no solution:
http://forum.kodi.tv/showthread.php?tid=173502
<br />
=== Back Navigation For YouTube Incorrect ===
The Videos -> Addon -> VideoExtras Youtube route seems to work how you would expect, however the Video Information -> Extras route gives the option, but when you exit the YouTube list of files it will return to the "Home" screen and not back to the Extras screen.
<br />
<br />

== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[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 />

== Donations ==
If you have found VideoExtras useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
<br />
<br />
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=214289 VideoExtras Forum]
<br />
<br />

Advancedsettings.xml

2015-10-27T09:07:43Z

JustAnotherKODIUser: /* musiclibrary */ changed itemseparator -> delete database to rescan all

{{TOC right}}{{mininav|[[Settings]]|page=advancedsettings.xml}}
{{bigger|{{note|'''The advancedsettings.xml file does not exist by default. You have to create it first!'''}} }}

<section begin="intro" />The [[advancedsettings.xml]] file, which does not exist by default, can be created by a user in their '''[[userdata folder]]'''.

This file is used for advanced settings and options that do not have GUI controls inside of {{kodi}}. Some settings are experimental or very rarely set, so they can only be used via the advancedsettings.xml file. The file is simply a plain text file and can be edited by various text editors, so long as the name is "advancedsettings.xml". These advanced settings can be used to tweak various things such as episode naming patterns, special network ports, special behaviors, and more.<section end="intro" />

The following page will describe the structure of the advancedsettings.xml file and the various individual settings.

{{note|
# All XML tags must be lowercase. The start and end of the advancedsettings.xml file must have the <advancedsettings> and </advancedsettings> tags.
# Kodi will only read the advancedsettings.xml file when it starts up. If you make changes while it is running then you must restart Kodi.
# For some Windows versions, Kodi has two <code>\userdata\</code> folders. The correct one to put the advancedsettings.xml file in is not the one in Program Files, but in <code>%appdata%\Kodi\userdata\.</code>}}

== Layout ==

The layout of <code>advancedsettings.xml</code> is as follows:

<syntaxhighlight lang="xml" enclose="div">
<advancedsettings>
<setting>value</setting>
...
<setting>value</setting>
</advancedsettings>
</syntaxhighlight>

where "setting" gives the name of the setting, and "value" gives it's value.

A list of the available "setting" strings and their values is given below.

= List of available settings =

== Troubleshooting settings ==

=== loglevel ===
{{Anchor|.3Cloglevel.3E}}
{{see also|debug log}}
<section begin="loglevel" />
{{xml setting
| tag name = loglevel
| tag attribute = hide
| tag attribute values =
{{option values
| value1= true | value1 description= Hides "enable debugging" guisetting.
| value2= false | value2 description= "enable debugging" guisetting will switch between min(loglevel, 0) and max(loglevel, 2) for off and on respectively. '''(Default)'''
}}
| tag attribute default values = true
| option values =
{{option values
| value1= -1 | value1 description= No logging, suppresses all log output
| value2= 0 | value2 description= Normal logging, only logging errors '''(Default)'''
| value3= 1 | value3 description= Debug logging ''(without showing text on screen)''
| value4= 2 | value4 description= Debug logging with freemem, fps and cpu usage shown on screen
| value5= 3 | value5 description= Debug logging with freemem, fps and cpu usage and full smb logging
}}
| default values = 0
| description =
The logging level that Kodi will use to log errors and information. The "hide" attribute is optional.
| example =
Example:
<syntaxhighlight lang="xml" enclose="div">
<loglevel hide="false">1</loglevel>
</syntaxhighlight>

<br />

{{Note| If debugging is switched on in the GUI, loglevel will be set to 2 (''log to both file and on-screen information''); this will over-ride any <code>advancedsettings.xml</code> setting.}}<br />

{{Note| If debugging is switched on in the GUI when Kodi is shut down, then it will be automatically be re-enabled at level 2 when it is re-started. This is true even if 'hide' is subsequently set to 'true' - in other words, if you enable it in the GUI and then hide the GUI toggle, it will stay on level 2 irrespective of what you subsequently set in <code>advancedsettings.xml</code>.}}<br />
}}
<section end="loglevel" />

=== jsonrpc ===
{{Anchor|.3Cjsonrpc.3E}}
To make it easier for developers using the [[JSON RPC]] API in their (third party) applications to debug during development the json output of Kodi can be prettified by setting '''compactoutput''' to '''false'''. Default json output mode is a compact print which does not contain any unnecessary whitespaces and therefore is difficult to read for humans.
Furthermore using the '''tcpport''' setting it is possible to change the default TCP port used by Kodi for JSON RPC (which is 9090) to any other valid port.

Example:
<syntaxhighlight lang="xml" enclose="div">
<jsonrpc>
<compactoutput>false</compactoutput>
<tcpport>9999</tcpport>
</jsonrpc>
</syntaxhighlight>

=== other - enableairtunesdebuglog ===
{{see|#enableairtunesdebuglog}}

== Audio/video playback settings ==

=== skiploopfilter ===
{{anchor|.3Cskiploopfilter.3E}}
The amount of the loop filter to skip on h264 decoding. This can help the performance of slower machines when decoding h264 content. Values, in decreasing CPU usage (and decreasing quality)
* -16 None
* 0 Skip only empty frames (default)
* 8 Skip non-reference frames (default on ATV)
* 16 Skip bi-dir frames
* 32 Skip all non-key frames
* 48 Skip all frames
Example:
<syntaxhighlight lang="xml" enclose="div">
<skiploopfilter>8</skiploopfilter>
</syntaxhighlight>

=== video ===
{{anchor|.3Cvideo.3E}}
{{see also|HOW-TO:Modify automatic watch and resume points|HOW-TO:Modify time seeking}}
<syntaxhighlight lang="xml" enclose="div">
<video>
<subsdelayrange>10</subsdelayrange> 
<audiodelayrange>10</audiodelayrange> 

<smallstepbackseconds>7</smallstepbackseconds>  
<usetimeseeking>true</usetimeseeking> 
<timeseekforward>30</timeseekforward>  
<timeseekbackward>-30</timeseekbackward>  
<timeseekforwardbig>600</timeseekforwardbig> 
<timeseekbackwardbig>-600</timeseekbackwardbig> 
<percentseekforward>2</percentseekforward> 
<percentseekbackward>-2</percentseekbackward> 
<percentseekforwardbig>10</percentseekforwardbig> 
<percentseekbackwardbig>-10</percentseekbackwardbig> 

<blackbarcolour>1</blackbarcolour> 

<fullscreenonmoviestart>true</fullscreenonmoviestart> 

<defaultplayer>dvdplayer</defaultplayer> 

<excludefromscan> 
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromscan>
<excludefromlisting> 
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromlisting>

<playcountminimumpercent>90</playcountminimumpercent> 
<ignoresecondsatstart>180</ignoresecondsatstart> 
<ignorepercentatend>8</ignorepercentatend> 

<forcevaapienabled>true</forcevaapienabled> 

<vdpauscaling>true</vdpauscaling> 

<enablehighqualityhwscalers>true</enablehighqualityhwscalers> 

<dxvaallowhqscaling>false</dxvaallowhqscaling> 

<ppffmpegdeinterlacing>linblenddeint</ppffmpegdeinterlacing> 

<ppffmpegpostprocessing>ha:128:7,va,dr</ppffmpegpostprocessing> 
<autoscalemaxfps>30</autoscalemaxfps> 


<adjustrefreshrate>



<override>
<fps>23.976</fps> 
<refresh>60.0</refresh> 
</override>

<override>
<fpsmin>29.96</fpsmin> 
<fpsmax>30.01</fpsmax>
<refreshmin>59.0</refreshmin> 
<refreshmax>61.0</refreshmax>
</override>


<fallback>
<refresh>50.0</refresh> 
</fallback>


<fallback>
<refreshmin>49.0</refreshmin>
<refreshmax>51.0</refreshmax>
</fallback>


</adjustrefreshrate>

<checkdxvacompatibility>value</checkdxvacompatibility> 

<useocclusionquery>-1</useocclusionquery> 
<fpsdetect>1</fpsdetect> 

<latency> 

<delay>0</delay> 




<refresh>
<min>23</min>
<max>24</max>
<delay>125</delay>
</refresh>


<refresh>
<rate>50</rate>
<delay>50</delay>
</refresh>

</latency>

<stereoscopicregex3d>[-. _]3d[-. _]</stereoscopicregex3d> 
<stereoscopicregexsbs>[-. _]h?sbs[-. _]</stereoscopicregexsbs>
<stereoscopicregextab>[-. _]h?tab[-. _]</stereoscopicregextab>

<stagefright> 
<useavccodec>-1</useavccodec>
<usehevccodec>-1</usehevccodec> 
<usevc1codec>-1</usevc1codec>
<usevpxcodec>-1</usevpxcodec>
<usemp4codec>-1</usemp4codec>
<usempeg2codec>-1</usempeg2codec>
<useswrenderer>false</useswrenderer>
</stagefright>

<disableswmultithreading>false</disableswmultithreading> 

<useffmpegvda>false</useffmpegvda> 

</syntaxhighlight>
{{isengard box|1=
<syntaxhighlight lang="xml" enclose="div">
<assfixedworks>false</assfixedworks> 
</syntaxhighlight>
}}
<syntaxhighlight lang="xml" enclose="div">

</video>
</syntaxhighlight>

=== audio ===
{{anchor|.3Caudio.3E}}
<syntaxhighlight lang="xml" enclose="div">
<audio>

<headroom>0</headroom>

<defaultplayer>paplayer</defaultplayer>

<excludefromscan>
<regexp>[-\._ ](podcast)[-\._ ]</regexp>
</excludefromscan>

<excludefromlisting>
<regexp>[-\._ ](podcast)[-\._ ]</regexp>
</excludefromlisting>

<ac3downmixgain>12.0</ac3downmixgain>

<playcountminimumpercent>99</playcountminimumpercent>

<applydrc>-1.0</applydrc>

<dvdplayerignoredtsinwav>false</dvdplayerignoredtsinwav>

<limiterhold>0.025</limiterhold>

<limiterrelease>0.1</limiterrelease>
</audio>
</syntaxhighlight>

For more information on the configuration of audio under Frodo see [[AudioEngine/HOW-TO: Configure audio]]

=== measurerefreshrate ===
{{anchor|.3Cmeasurerefreshrate.3E}}
When using "Sync playback to display" on Windows, the detected refreshrate might be wrong.
When enabling measurerefreshrate, the refreshrate is measured instead, which makes it more accurate.

<syntaxhighlight lang="xml" enclose="div">
<measurerefreshrate>true</measurerefreshrate>
</syntaxhighlight>

=== edl ===
{{anchor|.3Cedl.3E}}
{{main|EDL}}
Commercial break detection not as good you think it could be? Are some commercial breaks in a series of adverts not being skipped? Are some parts being skipped that are clearly not commercials? Does the end of the previous recording still show? The following advanced settings can be used to better identify full commercial break sequences, remove incorrectly flagged commercial breaks, and have playback start at the actual beginning of the recording.

<syntaxhighlight lang="xml" enclose="div">
<edl>

<mergeshortcommbreaks>false</mergeshortcommbreaks>

<maxcommbreaklength>250</maxcommbreaklength>

<mincommbreaklength>90</mincommbreaklength>

<maxcommbreakgap>120</maxcommbreakgap>

<commbreakautowait>0</commbreakautowait>

<commbreakautowind>0</commbreakautowind>
</edl>
</syntaxhighlight>

=== pvr ===
{{anchor|.3Cpvr.3E}}
<syntaxhighlight lang="xml" enclose="div">
<pvr>
<timecorrection>0</timecorrection> 
<infotoggleinterval>3000</infotoggleinterval> 
<minvideocachelevel>5</minvideocachelevel> 
<minaudiocachelevel>10</minaudiocachelevel> 
<cacheindvdplayer>true</cacheindvdplayer> 
<channeliconsautoscan>true</channeliconsautoscan> 
<autoscaniconsuserset>false</autoscaniconsuserset> 
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> 
</pvr>
</syntaxhighlight>

=== epg ===
{{anchor|.3Cpvr.3E}}
<syntaxhighlight lang="xml" enclose="div">
<epg>
<lingertime>1440</lingertime> 
<updatecheckinterval>300</updatecheckinterval> 
<cleanupinterval>900</cleanupinterval> 
<activetagcheckinterval>60</activetagcheckinterval> 
<retryinterruptedupdateinterval>30</retryinterruptedupdateinterval> 
<updateemptytagsinterval>60</updateemptytagsinterval> 
<displayupdatepopup>true</displayupdatepopup> 
<displayincrementalupdatepopup>false</displayincrementalupdatepopup> 
</epg>
</syntaxhighlight>

=== forcedswaptime ===
{{anchor|.3Cforcedswaptime.3E}}
Use to force a backbuffer->frontbuffer swap while vsync is enabled. Set to the time (in ms) to allow for the swap (e.g. <forcedswaptime>1</forcedswaptime> is typical).

Default: Off



== Video library settings ==

=== videoextensions ===
{{anchor|.3Cvideoextensions.3E}}<section begin="videoextensions" />
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Video windows.

Default extensions for VIDEOS:
<pre>
.m4v .3gp .nsv .ts .ty .strm .rm .rmvb .m3u .ifo .mov .qt .divx .xvid .bivx .vob .nrg .img
.iso .pva .wmv .asf .asx .ogm .m2v .avi .bin .dat .dvr-ms .mpg .mpeg .mp4 .mkv .avc .vp3
.svq3 .nuv .viv .dv .fli .flv .rar .001 .wpl .zip
</pre>
Examples:
<syntaxhighlight lang="xml" enclose="div">
<videoextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</videoextensions>
</syntaxhighlight>
<section end="videoextensions" />

=== discstubextensions ===
{{anchor|.3Cdiscstubextensions.3E}}
A list of additional file-extensions that will (<tt><add></tt>) or will not (<tt><remove></tt>) be treated as disc stubs.

Default extensions for DISC STUBS:
<pre>
.disc
</pre>

Examples:
<syntaxhighlight lang="xml" enclose="div">
<discstubextensions>
<add>.dvd|.blu</add>
<remove>.cd|.vhs</remove>
</discstubextensions>
</syntaxhighlight>

=== languagecodes ===
{{anchor|.3Clanguagecodes.3E}}
Translation table for subtitle and audio names. Contains entries of the form

<syntaxhighlight lang="xml" enclose="div">
<languagecodes>
<code>
<short>alt</short>
<long>Alternate</long>
</code>
</languagecodes>
</syntaxhighlight>

=== sorttokens ===
{{anchor|.3Csorttokens.3E}}
Allows you to specify additional tokens that will be ignored at the start of lines during sorting.
{{note|Sort tokens are case sensitive.}}
<syntaxhighlight lang="xml" enclose="div">
<sorttokens>
<token>the</token>
</sorttokens>
</syntaxhighlight>

=== moviestacking ===
{{anchor|.3Cmoviestacking.3E}}<section begin="moviestacking" />
{{main|File stacking}}
This is used by the [[file stacking]] algorithm to combine multi-part files and contains a list of "''[[Regular Expression (RegEx) Tutorial|regular expressions]]''". For stacking videos that are contained in folders, such as VIDEO_TS folders, see '''[[advancedsettings.xml#folderstacking|<folderstacking>]]'''

As of v9.11, video stacking regular expressions '''must''' contain exactly four (4) capture expressions.

Default:
<syntaxhighlight lang="xml" enclose="div">
<moviestacking>

<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[0-9]+)(.*?)(\.[^.]+)$</regexp>

<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[a-d])(.*?)(\.[^.]+)$</regexp>

<regexp>(.*?)([ ._-]*[a-d])(.*?)(\.[^.]+)$</regexp>
</moviestacking>
</syntaxhighlight>

If the argument <tt>action="append"</tt> or <tt>append="yes"</tt> is supplied, the default moviestacking regular expressions will remain intact and the user specified ones will be added to the end.

Example:
<syntaxhighlight lang="xml" enclose="div">
<moviestacking action="append">

<regexp>(.*?)([ ._-]*[0-9])(.*?)(\.[^.]+)$</regexp>
</moviestacking>
</syntaxhighlight>

If the argument <tt>action="prepend"</tt> is supplied, the default moviestacking regular expressions will remain intact and the user specified ones will be added to the beginning.

Example:
<syntaxhighlight lang="xml" enclose="div">
<moviestacking action="prepend">
<regexp>(Title)(Volume)(Ignore)(Extension)</regexp>
</moviestacking>
</syntaxhighlight>

If no argument is supplied, or the argument <tt>append="no"</tt> is supplied, the default moviestacking regular expressions are overwritten by the user specified ones.
<section end="moviestacking" />

=== folderstacking ===
{{main|File stacking}}
This is similar to '''[[advancedsettings.xml#moviestacking|<moviestacking>]]''', but is used for videos that are contained in folders that use the folder names to stack, such as VIDEO_TS folders (DVD rips that are not in ISO format).

Default:
<syntaxhighlight lang="xml" enclose="div">
<folderstacking>

<regexp>((cd|dvd|dis[ck])[0-9]+)$</regexp>
</folderstacking>
</syntaxhighlight>

=== cleandatetime ===
{{anchor|.3Ccleandatetime.3E}}
Matches a year number in a string using a ''[[Regular Expression (RegEx) Tutorial|Regular Expression]]''

Default expression:
<syntaxhighlight lang="xml" enclose="div">
<video>
<cleandatetime>(.+[^ _\,\.\[\]\-])[ _\.\[\]\-]+(19[0-9][0-9]|20[0-1][0-9])([ _\,\.\[\]\-][^0-9]|$)</cleandatetime>
</video>
</syntaxhighlight>
:* The string found before will be used as basis string getting cleaned by the cleanstrings expressions.
:* By default date formats like MM:YY are ignored.

=== cleanstrings ===
{{anchor|.3Ccleanstrings.3E}}
Clean unwanted characters from filenames or folders by using a list of ''[[Regular Expression (RegEx) Tutorial|Regular Expressions]]''. Please note that everything right of the match (at the end of the file name) is removed, so if you would have a file named ''Super movie.mp4'' and would add <tt><regexp> </regexp></tt> (only a space), the only thing that would be left is ''Super'', which is probably not what you want.

Default expressions:
<syntaxhighlight lang="xml" enclose="div">
<video>
<cleanstrings>
<regexp>[ _\,\.\[\]\-](ac3|dts|custom|dc|divx|divx5|dsr|dsrip|dutch|dvd|dvdrip|dvdscr|dvdscreener|screener|dvdivx|cam|fragment|fs|hdtv|hdrip|hdtvrip|internal|limited|multisubs|ntsc|ogg|ogm|pal|pdtv|proper|repack|rerip|retail|cd[1-9]|r3|r5|bd5|se|svcd|swedish|german|read.nfo|nfofix|unrated|ws|telesync|ts|telecine|tc|brrip|bdrip|480p|480i|576p|576i|720p|720i|1080p|1080i|hrhd|hrhdtv|hddvd|bluray|x264|h264|xvid|xvidvd|xxx|www.www|\[.*\])([ _\,\.\[\]\-]|$)</regexp>
<regexp>(\[.*\])</regexp>
</cleanstrings>
</video>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== tvshowmatching ===
{{anchor|.3Ctvshowmatching.3E}}
Matches the season and episode numbers in file paths by using a list of ''[[Regular Expression (RegEx) Tutorial|Regular Expressions]]''

Defaults:
<syntaxhighlight lang="xml" enclose="div">
<tvshowmatching>
<regexp>[Ss]([0-9]+)[][ ._-]*[Ee]([0-9]+)([^\\/]*)$</regexp> 
<regexp>[\._ -]()[Ee][Pp]_?([0-9]+)([^\\/]*)$</regexp> 
<regexp>([0-9]{4})[\.-]([0-9]{2})[\.-]([0-9]{2})</regexp> 
<regexp>([0-9]{2})[\.-]([0-9]{2})[\.-]([0-9]{4})</regexp> 
<regexp>[\\/\._ \[\(-]([0-9]+)x([0-9]+)([^\\/]*)$</regexp> 
<regexp>[\\/\._ -]([0-9]+)([0-9][0-9])([\._ -][^\\/]*)$</regexp> 
<regexp>[\/._ -]p(?:ar)?t[_. -]()([ivx]+)([._ -][^\/]*)$</regexp> 
</tvshowmatching>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)
:* Paths are converted to lower case before matching.
:* Examples of matching regexps for certain filenames can be found on the [[TV Shows (Video Library)|TV shows]] page.

:* For multi-episode matching to work, there needs to be a third set of parentheses '()' at the end, this part is fed back into the regexp engine.

:* A [http://forum.kodi.tv/showthread.php?t=51614 forum thread] has a discussion of pre-made regex lists to match common names. These might improve Kodi's ability to match TV show names in some situations, at the risk of additional false positives.

==== Filenames without Season ====
There are two methods to add episodes without a season in their file path. Both ways will force the season to '1' by default, so that you can use
the 'Use Absolute Ordering (Single Season)' setting from the TheTvDb.com scraper.

; Simple Method ''(XBMC v9.11 onwards and Kodi)''
: Use only one pair of parentheses
<syntaxhighlight lang="xml" enclose="div"><regexp>[/\._ \-]([0-9]+)</regexp></syntaxhighlight>
; Advanced Method ''(XBMC v10.05 onwards and Kodi)''
: Supports multi-episode files without season
: Use an empty pair of parentheses for the season
<syntaxhighlight lang="xml" enclose="div"><regexp>[/\._ \-]()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight>

; Specifying Default Season ''(XBMC v12.0 onwards and Kodi)''
It is possible to set the default season for specific regular expressions by setting the 'defaultseason' attribute.
: Works with both the simple method and advanced method
: If not used, the season will be set to '1'
: Useful for setting specials to season '0'
<syntaxhighlight lang="xml" enclose="div"><regexp defaultseason="0">[/\._ \-]X()([0-9]+)(-[0-9]+)?</regexp>
<regexp defaultseason="1">[/\._ \-]E()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight>

=== tvmultipartmatching ===
{{anchor|.3Ctvmultipartmatching.3E}}
Matches a multipart episode number based on a previously identified episode file, using a list of ''[[Regular Expression (RegEx) Tutorial|Regular Expressions]]''.

Default:
<syntaxhighlight lang="xml" enclose="div">
<tvmultipartmatching>^[-_ex]+([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)</tvmultipartmatching>
</syntaxhighlight>
:* Text matching is compared case-insensitive.
:* Specifying this option '''replaces''' the default value

=== excludefromscan ===
{{anchor|.3Cexcludefromscan.3E}}
Matches filenames or folders which should be excluded from a library scan (except tvshows) using a list of ''[[Regular Expression (RegEx) Tutorial|Regular Expressions]]''. This can be for both Video or Audio sections of <tt>advancedsettings.xml</tt>.

Defaults:
<syntaxhighlight lang="xml" enclose="div">
<video>
<excludefromscan>
<regexp>-trailer</regexp>
<regexp>[!-._ \\/]sample[-._ \\/]</regexp>
</excludefromscan>
</video>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== excludefromlisting ===
{{anchor|.3Cexcludefromlisting.3E}}
<syntaxhighlight lang="xml" enclose="div">
<video>
<excludefromlisting> 
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromlisting>
</video>
</syntaxhighlight>

=== excludetvshowsfromscan ===
{{anchor|.3Cexcludetvshowsfromscan.3E}}
Matches filenames or folders which should be excluded from a tvshow library scan using a list of ''[[Regular Expression (RegEx) Tutorial|Regular Expressions]]''

Defaults:
<syntaxhighlight lang="xml" enclose="div">
<video>
<excludetvshowsfromscan>
<regexp>[!-._ \\/]sample[-._ \\/]</regexp>
</excludetvshowsfromscan>
</video>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== trailermatching ===
{{anchor|.3Ctrailermatching.3E}}
Contains "''[[Regular Expression (RegEx) Tutorial|Regular Expression]]''" syntax (commonly referred to as "''[[Regular Expression (RegEx) Tutorial|RegEx]]''" or "''[[Regular Expression (RegEx) Tutorial|RegExp]]''") to match the locally stored trailers to movies in the library.

<syntaxhighlight lang="xml" enclose="div">
<trailermatching>

<regexp>(.*?)(_Trailer)(\.[^.]+)$</regexp>
</trailermatching>
</syntaxhighlight>

=== videolibrary ===
{{anchor|.3Cvideolibrary.3E}}
Options specific to the Video Library

<syntaxhighlight lang="xml" enclose="div">
<videolibrary>
<allitemsonbottom>false</allitemsonbottom> 
<backgroundupdate>false</backgroundupdate> 

<cleanonupdate>false</cleanonupdate> 
<usefasthash>true</usefasthash> 
<hideemptyseries>false</hideemptyseries> 
<recentlyaddeditems>35</recentlyaddeditems> 
<itemseparator> / </itemseparator> 
<exportautothumbs>false</exportautothumbs> 
<importwatchedstate>false</importwatchedstate> 
<importresumepoint>false</importresumepoint> 
<mymovies> 
<categoriestogenres>false</categoriestogenres> 
</mymovies>
<dateadded>1</dateadded> 
</videolibrary>
</syntaxhighlight>

=== videoscanner ===
{{anchor|.3Cvideoscanner.3E}}
Options specific to the Video scanner
<syntaxhighlight lang="xml" enclose="div">
<videoscanner>
<ignoreerrors>true</ignoreerrors> 
</videoscanner>
</syntaxhighlight>

=== myth ===
{{anchor|.3Cmyth.3E}}
Not seeing all the recordings you expected in the Movies folder? If so, it's very likely that the electronic program guide (EPG) used by MythTV doesn't accurately distinguish between TV Shows and Movies all the time. The following setting allows the length of the recording to also be used to determine if a recording is a Movie.

<syntaxhighlight lang="xml" enclose="div">
<myth>

<movielength>0</movielength>
</myth>
</syntaxhighlight>

== Library artwork ==

=== imageres ===
{{anchor|.3Cimageres.3E}}
This tag is new for v12 (Frodo), replacing <thumbsize>.

<section begin="imageres description" />Specify the maximal resolution that art should be resized to in pixels. The width is automatically calculated as being 16/9*height. The image will be resized to fit within this size. e.g. an image that is 2000x500 will be cached at size 1280x320. An image that is 500x800 will be cached at size 450x720 using the default value of 720.<section end="imageres description" />

<syntaxhighlight lang="xml" enclose="div">
<imageres>720</imageres>
</syntaxhighlight>

=== fanartres ===
{{anchor|.3Cfanartres.3E}}
This tag is new for v12 (Frodo), replacing <fanartheight>.

<section begin="fanartres description" />Specify the resolution that cached fanart should be resized to in pixels. The width is automatically calculated as being 16/9*height. Only images that are exactly 16x9 and equal to or greater than this resolution will be cached at this size - all other images will be cached using <imageres>. The default value is 1080.<section end="fanartres description" />

<syntaxhighlight lang="xml" enclose="div">
<fanartres>1080</fanartres>
</syntaxhighlight>

=== fanart ===
{{anchor|.3Cfanart.3E}}
As of v12 (Frodo), this tag is only used for music and not video.

A list of additional files to try when searching for fanart images. (The defaults are fanart.jpg and fanart.png which can be removed.)

Example:
<syntaxhighlight lang="xml" enclose="div">
<fanart>
<remove>fanart.jpg</remove>
<add>backdrop.jpg</add>
</fanart>
</syntaxhighlight>

=== musicthumbs ===
{{anchor|.3Cmusicthumbs.3E}}
A list of additional files to try when searching for music thumbnail images. (The default is folder.jpg which can be removed.)

Example:
<syntaxhighlight lang="xml" enclose="div">
<musicthumbs>
<remove>folder.jpg</remove>
<add>thumb.jpg|cover.jpg</add>
</musicthumbs>
</syntaxhighlight>

=== useddsfanart ===
{{anchor|.3Cuseddsfanart.3E}}
This settings allows Kodi to use your GPU rendering fanart and some other images. This will make loading images considerably faster, especially on systems with slower processors (e.g. atom based systems). Do not use this option on ARM based systems (Apple TV2/iOS/RPi/many Android systems) as it is likely to degrade performance because DDS images are not supported.

<syntaxhighlight lang="xml" enclose="div">
<useddsfanart>true</useddsfanart>
</syntaxhighlight>

=== imagescalingalgorithm ===
{| width="100%" style="background-color: #EBE6FF; border: 1px solid #808000; font-size: 95%; clear: both" |
| width="57px" | [[File:Future.png|50px|link=]]
| align="left" | <big>{{{raw|'''{{{2|Current Kodi v16 development version feature}}}:'''<br />{{{1|This page or section describes a feature that is only available in Kodi v16 currently in development.}}}</big> }}}
|}

Specify the image scaling algorithm for image resizing/caching i.e. posters, fanart, etc.
<br />
<syntaxhighlight lang="xml" enclose="div">
<imagescalingalgorithm>bicubic</imagescalingalgorithm>
</syntaxhighlight>

[https://github.com/xbmc/xbmc/blob/1a8753d5cd93890dc6a9f9d4b2ce8848066ea5d0/xbmc/pictures/PictureScalingAlgorithm.cpp#L32-L43 Available image scaling algorithms]

<syntaxhighlight lang="text" enclose="div">
fast_bilinear
bilinear
bicubic
experimental
nearest_neighbor
averaging_area
bicublin
gaussian
sinc
lanczos
bicubic_spline
</syntaxhighlight>

== Video and music library settings ==

=== playlistasfolders ===
{{anchor|.3Cplaylistasfolders.3E}}
In the recent releases, playlists are treated as folders. Selecting a playlist no longer plays it, but opens it, as if it were a folder.

Set to false to revert to the previous behaviour. When you select a playlist, its content is added to the list of elements to be played.

:{{note|This setting will not affect smart playlists, they will always show as folders.}}

;Example
<syntaxhighlight lang="xml" enclose="div">
<playlistasfolders>true</playlistasfolders>
</syntaxhighlight>

=== playlistretries ===
{{anchor|.3Cplaylistretries.3E}}
The number of retries attempted if a source is offline. With this control you can alter the number of consecutive failed items before a playlist fails.

Default:
<syntaxhighlight lang="xml" enclose="div">
<playlistretries>100</playlistretries>
</syntaxhighlight>

=== playlisttimeout ===
{{anchor|.3Cplaylisttimeout.3E}}
The timeout, in seconds, before item failure.

Default:
<syntaxhighlight lang="xml" enclose="div">
<playlisttimeout>20</playlisttimeout>
</syntaxhighlight>

=== musicdatabase/videodatabase ===
{{anchor|.3Cmusicdatabase.3E/.3Cvideodatabase.3E}}
{{main|MySQL}}
<section begin="videodatabase" />
Allows advanced customization of the default database settings for both music and video.

:{{note| '''It is HIGHLY recommended that you not attempt to place an sqlite3 database outside of kodi's path. sqlite3 contains no filesystem abstraction, so this will plain break on any non-local (as far as Kodi is concerned) paths. Use this for mysql only.'''}}

'''type'''
: Can be either "sqlite3" or "mysql" (default: sqlite3)

;host
* sqlite3: defines the relative path to the database file (eg. /usr/local/kodi/databases).
* mysql: defines the host of the mysql socket (eg. localhost, 192.168.0.1, etc)

;port
* sqlite3: silently ignored
* mysql: defines the port of the mysql socket (default: 3306)

;name
:by default "MyVideos"+DB number will be used.
* sqlite3: defines the name of the database file to read from, excluding the ".db" extension.
* mysql: defines the name of the database to use

;user
* sqlite3: silently ignored
* mysql: defines the user with privileged access to the database

;pass
* sqlite3: silently ignored
* mysql: defines the password for the user with privileged access to the database

;key
: Optional SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;cert
: Optional SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;ca
: Optional SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;capath
: Optional SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;ciphers
: Optional SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

{{future box|1=
;compression
: Defaults to false. Set to "true" to enable MySQL compression protocol. Performance benefit is going to be largely dependent on the network bandwidth, latency between database and clients and on the size of the result sets. [https://github.com/xbmc/xbmc/pull/6484]
: {{Note|Slower clients (such as the RPi and others) won't benefit from it as the zlib de-compression overhead is higher than the actual compression savings}}
}}

'''Examples:'''

1) Configure a database for MySQL.
:{{note| ''The videodatabase and musicdatabase tags are interchangeable here.''}}
<syntaxhighlight lang="xml" enclose="div">
<videodatabase>
<type>mysql</type>
<host>192.168.0.10</host>
<name>kodi_video</name>
<user>kodi</user>
<pass>kodi</pass>
</videodatabase>
</syntaxhighlight>

2) Configure a database for an sqlite database.
:{{note|''The videodatabase and musicdatabase tags are interchangeable here.''}}
<syntaxhighlight lang="xml" enclose="div">
<musicdatabase>
<type>sqlite3</type>
<host>/usr/local/share/kodi/databases</host>
<name>kodi_music</name>
</musicdatabase>
</syntaxhighlight>

<section end="videodatabase" />

=== externalplayer ===
{{anchor|.3Cexternalplayer.3E}}
{{see|External players}}

== Music settings ==

=== musicextensions ===
{{anchor|.3Cmusicextensions.3E}}
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Music windows.

Default extensions for MUSIC:
<pre>
.nsv .m4a .flac .aac .strm .pls .rm .mpa .wav .wma .ogg .mp3 .mp2 .m3u .mod .amf .669 .dmf .dsm .far .gdm
.imf .it .m15 .med .okt .s3m .stm .sfx .ult .uni .xm .sid .ac3 .dts .cue .aif .aiff .wpl .ape .mac .mpc
.mp+ .mpp .shn .zip .rar .wv .nsf .spc .gym .adplug .adx .dsp .adp .ymf .ast .afc .hps .xsp
</pre>

Examples:
<syntaxhighlight lang="xml" enclose="div">
<musicextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</musicextensions>
</syntaxhighlight>

=== cddbaddress ===
{{anchor|.3Ccddbaddress.3E}}
The address of the online CDDb database. You may set this to another freedb mirror if there is a more suitable one.

Default:
<syntaxhighlight lang="XML" enclose="div>
<cddbaddress>freedb.freedb.org</cddbaddress>
</syntaxhighlight>

=== songinfoduration ===
{{anchor|.3Csonginfoduration.3E}}
This controls how long the song information will remain onscreen when the song changes during visualisations. The valid range is "1" to "Indefinite (0)", in seconds. This does not include the duration of any transition effects.

Default:
<syntaxhighlight lang="xml" enclose="div">
<songinfoduration>10</songinfoduration>
</syntaxhighlight>

=== musicfilenamefilters ===
{{anchor|.3Cmusicfilenamefilters.3E}}
Contains filters to match music information (artist, title etc.) from a tag-less music filename. The first <filter> to match completely is used. Matched items include:

<pre>
%A - Artist
%T - Title
%B - Album
%N - Track number
%S - Part of set (disk number)
%D - Duration
%G - Genre
%Y - Year
%R - Rating
</pre>

Example:
<syntaxhighlight lang="xml" enclose="div">
<musicfilenamefilters>
<filter>%A - %T</filter>
</musicfilenamefilters>
</syntaxhighlight>

=== musiclibrary ===
{{anchor|.3Cmusiclibrary.3E}}
Options specific to the Music Library

<syntaxhighlight lang="xml" enclose="div">
<musiclibrary>
<hideallitems>true</hideallitems>  
<allitemsonbottom>true</allitemsonbottom> 
<backgroundupdate>true</backgroundupdate> 
<recentlyaddeditems>35</recentlyaddeditems> 
<albumssortbyartistthenyear>true</albumssortbyartistthenyear> 
<albumformat>%B - %Y</albumformat> 
<albumformatright>%A</albumformatright> 
<prioritiseapetags>true</prioritiseapetags> 
<itemseparator> / </itemseparator> 
</musiclibrary>
</syntaxhighlight>
<br />
{{Note|Changing the <itemseparator> will only affect newly added items. Even a rescan won't change the added ones, you have to delete the music database to achieve this.}}

=== karaoke ===
{{anchor|.3Ckaraoke.3E}}
{{Main|Karaoke}}<section begin="karaoke" />
<syntaxhighlight lang="xml" enclose="div">
<karaoke>

<syncdelaycdg>0.0</syncdelaycdg>

<syncdelaylrc>0.0</syncdelaylrc>

<alwaysreplacegenre>false</alwaysreplacegenre>

<storedelay>true</storedelay>

<autoassignstartfrom>1</autoassignstartfrom>

<nocdgbackground>true</nocdgbackground>

<defaultbackground type="video" path="special://masterprofile/karaokevideobg.avi"/>

<nextsongpopuptime>0.0</nextsongpopuptime>
</karaoke>
</syntaxhighlight>
<section end="karaoke" />

== Photos settings ==

=== pictureextensions ===
{{anchor|.3Cpictureextensions.3E}}
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Pictures window.

Default extensions for PICTURES:
<pre>
.png .jpg .jpeg .bmp .gif .ico .tif .tiff .tga .pcx .cbz .zip .cbr .rar .m3u
</pre>

Examples:
<syntaxhighlight lang="xml" enclose="div">
<pictureextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</pictureextensions>
</syntaxhighlight>

=== pictureexcludes ===
{{anchor|.3Cpictureexcludes.3E}}
Matches filenames or folders which should be excluded from being displayed in My Pictures using a list of ''[[Regular Expression (RegEx) Tutorial|Regular Expressions]]''

<syntaxhighlight lang="xml" enclose="div">
<pictureexcludes> 
<regexp>small</regexp>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</pictureexcludes>
</syntaxhighlight>

=== slideshow ===
{{anchor|.3Cslideshow.3E}}
<syntaxhighlight lang="xml" enclose="div">
<slideshow>

<panamount>2.5</panamount>

<zoomamount>5.0</zoomamount>



<blackbarcompensation>20</blackbarcompensation>
</slideshow>
</syntaxhighlight>

== Network settings ==

=== samba ===
{{anchor|.3Csamba.3E}}
<syntaxhighlight lang="xml" enclose="div">
<samba>
<doscodepage></doscodepage> 
<clienttimeout>10</clienttimeout> 
<statfiles>true</statfiles> 
</samba>
</syntaxhighlight>

=== hosts ===
{{anchor|.3Cfhosts.3E}}
Static dns entries which take precedence over your dns server.
<syntaxhighlight lang="xml" enclose="div">
<hosts>
<entry name="HOSTNAME">IPADDRESS</entry>
</hosts>
</syntaxhighlight>

=== network ===
{{anchor|.3Cnetwork.3E}}
{{see also|HOW-TO:Modify the cache}}
<syntaxhighlight lang="xml" enclose="div">
<network>
<curlclienttimeout>10</curlclienttimeout> 
<curllowspeedtime>5</curllowspeedtime> 
<httpproxyusername></httpproxyusername> 
<httpproxypassword></httpproxypassword> 
<cachemembuffersize>20971520</cachemembuffersize> 
<buffermode>0</buffermode> 
<readbufferfactor>1.0</readbufferfactor> 
</network>
</syntaxhighlight>

=== tuxbox ===
{{anchor|.3Ctuxbox.3E}}
<syntaxhighlight lang="xml" enclose="div">
<tuxbox>

<audiochannelselection>false</audiochannelselection>

<submenuselection>false</submenuselection>

<defaultrootmenu>0</defaultrootmenu>

<defaultsubmenu>4</defaultsubmenu>

<pictureicon>true</pictureicon>

<epgrequesttime>10</epgrequesttime>

<zapwaittime>0</zapwaittime>
</tuxbox>
</syntaxhighlight>

=== airtunesport ===
{{anchor|.3Cairtunesport.3E}}<section begin="airtunesport" />
This overwrites the defalt listening port of the AirTunes server (announced via zeroconf).
<section end="airtunesport" />

=== airplayport ===
{{anchor|.3Cairplayport.3E}}<section begin="airplayport" />
This overwrites the default listening port of the AirPlay server (announced via zeroconf).
<section end="airplayport" />

== File system settings ==

=== packagefoldersize ===
<section begin="packagefoldersize" />
{{anchor|.3Cpackagefoldersize.3E}}
{{xml setting
| tag name = packagefoldersize
| option type = numerical
| option values =
| default values = 200
| platform = all
| XBMC version = 12
| description = The amount (in megabytes) of add-on zip packages saved from previous add-on installs. These packages are mainly used for the [[add-on]] rollback feature. Increasing the size should increase the amount of past versions saved.
| example = Example: <syntaxhighlight lang="xml" enclose="div"><packagefoldersize>200</packagefoldersize> </syntaxhighlight>
}}
<section end="packagefoldersize" />
=== detectasudf ===
{{anchor|.3Cdetectasudf.3E}}
Set to true if you wish to detect joint ISO9660/UDF disks as UDF.

Default: False

=== pathsubstitution ===
{{anchor|.3Cpathsubstitution.3E}}
{{main|Path substitution}}
Path substitutions are for use for redirecting file paths. These are processed in order, and are useful for substituting an absolute path on a PC with a path suitable for Kodi to handle.

Default: No path substitutions defined.

Example:
<syntaxhighlight lang="xml" enclose="div">
<pathsubstitution>
<substitute>
<from>G:\dvds\</from>
<to>smb://somecomputer/g-share/dvds/</to> 
</substitute>
</pathsubstitution>
</syntaxhighlight>

== Input control settings ==

=== remotedelay ===
{{anchor|.3Cremotedelay.3E}}
The repeat delay for a LIRC remote control. A delay value between 1 and 20 before a remote button starts repeating on a long keypress (i.e. continuously sending button pushes while it's held down).

Default: 3
<syntaxhighlight lang="xml" enclose="div">
<remotedelay>10</remotedelay>
</syntaxhighlight>

=== remoterepeat ===
{{anchor|.3Cremoterepeat.3E}}
This used to adjust the amount of time in milliseconds between repeated keystrokes. Used to prevent key-bounce, in other words prevents Kodi (lirc?) seeing one key press as multiple key presses with certain remotes.

<syntaxhighlight lang="xml" enclose="div">
<remoterepeat>800</remoterepeat>
</syntaxhighlight>

=== controllerdeadzone ===
{{anchor|.3Ccontrollerdeadzone.3E}}
The controller deadzone is the region of movement around the center which is not recognized by the device. Because joysticks can have noise (report motion when still) and bias (report an offset when centered), spurious events can be reported even though the controller isn't being touched. If you notice these kinds of events, you most likely need to increase your controller's deadzone (both axes recommended). The values range from 0.0 (no deadzone, Kodi will see all input your controller is capable of registering) to 1.0 (it will ignore all input inside of the device's physical limits).

<syntaxhighlight lang="xml" enclose="div">
<controllerdeadzone>0.2</controllerdeadzone>
</syntaxhighlight>

=== enablemultimediakeys ===
{{anchor|.3Cenablemultimediakeys.3E}}
This setting only has any effect on Windows versions of Kodi, and only applies to builds from 28th May 2011 onwards.
In Windows the multimedia keys generate a WM_APPCOMMAND message in addition the keypress. Kodi processes both keypresses and the WM_APPCOMMAND messages, and the end result would be that the command is executed twice. To avoid this, by default multimedia keypresses are disabled. Although it should rarely be necessary, the enablemultimediakeys setting allows you to enable the multimedia keys.

Example:
<syntaxhighlight lang="xml" enclose="div">
<enablemultimediakeys>true</enablemultimediakeys>
</syntaxhighlight>

=== seeksteps ===
{{Main|Skip steps}}

This setting changes which increments are available in the settings GUI for additive seeking. Note that <code><seeksteps></code> is not used to actually choose which seek steps are enabled.

'''Default:'''
<syntaxhighlight lang="xml" enclose="div">
<seeksteps>7, 15, 30, 60, 180, 300, 600, 900, 1800</seeksteps>
</syntaxhighlight>

{{editor note|the defaults need to be updated for seeksteps.}}

== Other interface settings ==

=== window ===
{{anchor|.3Cwindow.3E}}
This allows you to manually set the default size of Kodi's windowed mode. If you resize the window, it will return to the set size when restarting.

WIDTH and HEIGHT are the values for each dimension, in pixels.

<syntaxhighlight lang="xml" enclose="div">
<window><width>WIDTH</width><height>HEIGHT</height></window>
</syntaxhighlight>

=== allowd3d9ex ===
{{anchor|.3Callowd3d9ex.3E}}
Applies only to Windows Vista and up. Values: true/false. Allows Kodi to use Direct3D 9Ex, which is a bit more stable and robust than Direct3D 9.

Default:
<syntaxhighlight lang="xml" enclose="div">
<allowd3d9ex>true</allowd3d9ex>
</syntaxhighlight>

=== restrictcapsmask ===
{{anchor|.3Crestrictcapsmask.3E}}
Windows only. A bitmask to prevent Kodi from using detected texture capabilities of the GPU. This helps work around buggy hardware/drivers.

1: prevent the use of compressed textures (DXT1, DXT3, DXT5)
2: prevent the use of non-power-of-two dimensions for textures
4: prevent the use of compressed textures with non-power-of-two dimensions.

<syntaxhighlight lang="xml" enclose="div">
<restrictcapsmask>0</restrictcapsmask>
</syntaxhighlight>

=== forced3d9ex ===
{{anchor|.3Cforced3d9ex.3E}}
Windows only: Kodi attempts to detect drivers released for a version earlier than Vista, to avoid using advanced features which are often not emulated correctly. The detection may be incorrect and this setting allows forcing the using of D3D9Ex.

<syntaxhighlight lang="xml" enclose="div">
<forced3d9ex>false</forced3d9ex>
</syntaxhighlight>

=== algorithmdirtyregions ===
{{anchor|.3Calgorithmdirtyregions.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="algorithmdirtyregions" /> {{note|Some GPU/hardware configurations will have some minor issues (such as a visual "flicker"). For those situations try mode 2 or use the default (mode 3, which requires no advancedsetting). Almost all ARM-based devices (such as [[Android]]) willl likely have flickering issues.}}

Enable dirty-region processing. Dirty regions are any parts of the screen that have changed since the last frame. By not re-rendering what hasn't changed the GUI can be sped up. Because all GPUs work differently, only Mode 3, combined with nofliptimeout=0, is guaranteed to work for everyone without flickering issues. This mode will reduce CPU/GPU usage, but will not increase GUI speed.

{| class="prettytable"
! value !! result !! description
|-
! 0
| Off
| The entire viewport is always rendered.
|-
! 1
|Union
|All dirty regions are grouped into the smallest possible rectangle. This is typically the fastest mode for slower GPUs due to only making one pass.
|-
! 2
| {{nowrap|Cost reduction}}
| Each dirty region is presented separately, in as many passes as there are regions.
|-
! 3
| {{nowrap|Whole Screen}}
| The entire screen is rendered if there are any dirty regions. This, combined with nofliptimeout is a safe default for drivers that clear buffer contents (manifests as blinking or vibrating images). '''Default'''
|}<section end="algorithmdirtyregions" />

Example:
<syntaxhighlight lang="xml" enclose="div">
<gui>
<algorithmdirtyregions>1</algorithmdirtyregions>
</gui>
</syntaxhighlight>

=== nofliptimeout ===
{{anchor|.3Cnofliptimeout.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="nofliptimeout" />Specifies the timeout in milliseconds after which Kodi will not flip the graphics buffers anymore when nothing has been rendered, this lowers both CPU and GPU usage. Sometimes adjusting this value can help prevent flickering.

* -1: disabled
* 0 or higher: timeout in milliseconds '''(0 is default)'''
<section end="nofliptimeout" />
Example:
<syntaxhighlight lang="xml" enclose="div">
<gui>
<nofliptimeout>1000</nofliptimeout>
</gui>
</syntaxhighlight>

=== visualizedirtyregions ===
{{anchor|.3Cvisualizedirtyregions.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="visualizedirtyregions" />Enable dirty-region visualization. Paints a rectangle over marked controls.

* true: on
* false: off '''(Default)'''

{{note|This is only a development mode and isn't of use to normal users.}}
<section end="visualizedirtyregions" />
Example:
<syntaxhighlight lang="xml" enclose="div">
<gui>
<visualizedirtyregions>true</visualizedirtyregions>
</gui>
</syntaxhighlight>

=== showexitbutton ===
{{anchor|.3Cshowexitbutton.3E}}
Setting to hide the exit button, useful for people running appliance based setup's where exit would only confuse/complicate the user. Modifiable via the advancedsettings.xml by setting showexitbutton to false, default is true (show)

Example:
<syntaxhighlight lang="xml" enclose="div">
<showexitbutton>true</showexitbutton>
</syntaxhighlight>

=== fullscreen ===
{{anchor|.3Cfullscreen.3E}}
Starts Kodi in full screen (check resolutions!).

<syntaxhighlight lang="xml" enclose="div">
<fullscreen>false</fullscreen>
</syntaxhighlight>

=== splash ===
{{anchor|.3Csplash.3E}}
Set to false if you wish to disable the startup splash image. Defaults to true.

<syntaxhighlight lang="xml" enclose="div">
<splash>true</splash>
</syntaxhighlight>

=== cputempcommand ===
{{anchor|.3Ccputempcommand.3E}}
Provide a shell command Kodi will use to get CPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia and Raspberry Pi</u>
<syntaxhighlight lang="xml" enclose="div">
<cputempcommand>sed -e 's/$[0-9]*$[0-9]\{3\}.*/\1 C/' /sys/class/thermal/thermal_zone0/temp</cputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang="xml" enclose="div">
<cputempcommand>echo "$(sensors -u | tail -n64 | grep temp1_input | awk '{print $2 }' |awk '{printf("%d\n",$1 + 0.5);}') C"</cputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang="xml" enclose="div">
<cputempcommand>sensors|sed -ne "s/temp1: \+[-+]$[0-9]\+$.*/\1 C/p"</cputempcommand>
</syntaxhighlight>

=== gputempcommand ===
{{anchor|.3Cgputempcommand.3E}}
Provide a shell command Kodi will use to get GPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia</u>
<syntaxhighlight lang="xml" enclose="div">
<gputempcommand>echo "$(nvidia-settings -tq gpuCoreTemp) C"</gputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang="xml" enclose="div">
<gputempcommand>echo "$(nvidia-smi -q -d TEMPERATURE | grep Gpu | cut -c35-36) C"</gputempcommand>
</syntaxhighlight>
;<u>For ATI/AMD</u>
<syntaxhighlight lang="xml" enclose="div">
<gputempcommand>/usr/bin/aticonfig --od-gettemperature | grep Temperature | cut -f 2 -d "-" | cut -f 1 -d "." | sed -e "s, ,," | sed 's/$/ C/'</gputempcommand>
</syntaxhighlight>

;<u>For Raspberry Pi</u>
<syntaxhighlight lang="xml" enclose="div">
<gputempcommand>/opt/vc/bin/vcgencmd measure_temp | sed -e "s/temp=//" -e "s/\..*'/ /"</gputempcommand>
</syntaxhighlight>

=== glrectanglehack ===
{{anchor|.3Cglrectanglehack.3E}}
Problems with ghosting or videos which are only played back in the left upper quarter? The following ATI hack may solve it.
<syntaxhighlight lang="xml" enclose="div">
<glrectanglehack>yes</glrectanglehack>
</syntaxhighlight>

=== alwaysontop ===
{{anchor|.3Calwaysontop.3E}}
Added in XBMC v9.11 (Windows OS only). Keeps Kodi always on top when windowed.
<syntaxhighlight lang="xml" enclose="div">
<alwaysontop>yes</alwaysontop>
</syntaxhighlight>

Alternate code.
<syntaxhighlight lang="xml" enclose="div">
<videoscreen>
<fakefullscreen>false</fakefullscreen>
</videoscreen>
</syntaxhighlight>

== Recently removed tags ==
* {{anchor|.3Cthumbsize.3E}}'''<thumbsize>''' - replaced by <[[#imageres|imageres]]> in v12 Frodo
* {{anchor|.3Cfanartheight.3E}}'''<fanartheight>''' - replaced by <[[#fanartres|fanartres]]> in v12 Frodo
* {{anchor|.3Cdvdthumbs.3E}}'''<dvdthumbs>''' - removed in v12 Frodo
* {{anchor|.3Cbusydialogdelayms.3E}}'''<busydialogdelayms>''' - removed in v12 Frodo
* {{anchor|.3Cbginfoloadermaxthreads.3E}}'''<bginfoloadermaxthreads>''' - removed in v13 Gotham
* '''<showepginfoonselect>''' - replaced by a GUI setting in v13 Gotham
* '''<resample>''', '''<forceDirectSound>''', '''<audiophile>''', '''<audiosinkbufferdurationmsec>''', '''<allowtranscode44100>''', and '''<streamsilence>''' - These were various sub-tags for <audio> that were removed in v13 Gotham and either replaced by GUI settings or were no longer needed.
* {{anchor|.3Cenableairtunesdebuglog.3E}}'''<enableairtunesdebuglog>''' - replaced by a GUI option in v14 Helix
* '''<videoDisableHi10pMultithreading>''' - renamed to <disableswmultithreading> in v14 Helix
* '''<hideallitems>''' - For both the <code><videolibrary></code> and <code><musiclibrary></code> sections, this is replaced by a GUI option in v15 Isengard
* '''<SmallStepBackSeconds>''' - In v15 the <code>SmallStepBack</code> [[action ID]] has been replaced by <code>seek(-7)</code> in default keymaps. See '''[[skip steps]]''' for details. When the original <code>SmallStepBack</code> action ID is used it defaults to the first backwards [[skip steps|additive seeking value]].
* '''<timeseekforward>/<timeseekbackward>''' - In v15 these tags are replaced by GUI options via [[skip steps|additive seeking]], which is configured in the GUI. See '''[[skip steps]]''' for details.

== guisettings.xml settings ==
You can also define the settings normally defined in the GUI (and stored in guisettings.xml) in advancedsettings.xml. Most guisettings.xml settings defined in advancedsettings.xml will override the guisettings.xml values, and the settings will be removed completely from the interface.

The easiest way to include a guisettings.xml setting is to first change the setting in the interface to the value that you want, and then open the '''[[userdata]]/guisettings.xml''' file and find the XML entry that corresponds to that setting.

Then just add that entry to the advancedsettings.xml file.

For instance, to set the Font Character Set (found in the appearance setting, in the Look and Feel section), you'd open up guisettings.xml and find:

<syntaxhighlight lang="xml" enclose="div">
<lookandfeel>
<charset>Hebrew (Windows)</charset>
</lookandfeel>
</syntaxhighlight>

Simply take that entry and place it in advancedsettings.xml. The option in Kodi's interface for the character set will then no longer be visible, and Kodi will always use the Hebrew (Windows) character set.

{{Helix updated}}
{{DISPLAYTITLE:advancedsettings.xml}}

[[Category:Settings]]
[[Category:Manual]]
[[Category:Advanced topics]]

User talk:JustAnotherKODIUser

2015-10-27T08:59:55Z

JustAnotherKODIUser: Blanked the page