Official Kodi Wiki - User contributions [en]

Add-on rules

2026-05-31T19:41:18Z

Karellen: Protected "Add-on rules" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

{{mininav|[[Development]]|[[Add-on development]]}}

== Repository Submission Guidelines - Please Read Before Submitting Your Addon ==

Inclusion in the Kodi.org repository is at the sole discretion of Team Kodi. Because maintaining such a large repository is a large task, we have set some guidelines for inclusion. Please ensure that these guidelines are met before submitting request to be added. In order to be considered for the official repository, the following guidelines must be met:

* All add-ons must be developed as described on the [https://kodi.wiki/view/Add-on_development Add-on development] page.
* All add-ons must be compatible with Python 3. Contributions requiring Python 2 are no longer accepted. For more details see: [https://kodi.tv/article/the-sun-sets-on-python-2/ The Sun Sets on Python 2]
* You '''must''' include a license file (named <code>LICENSE.txt</code>). We recommend the [http://creativecommons.org/choose/non-web-popup?license_code=by-sa&jurisdiction=&version=3.0&lang=en CC-BY-SA 3.0] for skins and the [http://www.gnu.org/licenses/gpl-howto.html GPL v2+] for others, but most copy left licenses will suffice. Proprietary licenses will not be allowed. Please investigate which license suits your needs and you fully understand the contents.
* All files must be free and legal to distribute.
* The add-on must not violate any known copyright laws - if in doubt, let us know and we'll look into it for you.
* All source files must be included. No pre-compiled or obfuscated files will be allowed. The only exception may be granted for minified JS/CSS files of web interface addons.
* You acknowledge that you are the maintainer of your add-on.
* Team-Kodi reserves the right to update or remove it at any time as we deem necessary.
* If a new stable Kodi is going to be released no new submissions are accepted to the repository for the previous version. This will start from when the first [http://en.wikipedia.org/wiki/Release_candidate#Release_candidate release candidate (RC)] of the new version is released. Only fixes and updates will be accepted and processed for the previous version (e.g. if the current stable is 13.x, no updates are allowed for 11.x any more). See: [https://kodi.wiki/view/Submitting_Add-ons#Allowed_submissions Allowed submissions]
* Monetization of add-ons (for instance advertising or paid subscriptions) will not be allowed. We can make an exception in case you own the copyright for the content the add-on provides. Please contact us on the forum if you believe such an exception may apply to your add-on.
* All <code>xbmc.python.module</code> addons must be used by at least one other add-on in official repository.

== Updates ==

Keep in mind that add-ons in the official repository should be considered '''stable'''. This means that they should be well-tested before you submit them for inclusion. Because they are for stable users, they should avoid being updated too often. Too often is of course subjective. If your add-on is in rapid development, and features are constantly being added, hold off until you have hit a good stopping point and '''tested''' the current version.

This means that you should '''not''' submit a request every time you change your code. If you are submitting updates more than once per week something is wrong. Once or twice per month is probably a better goal, barring unforeseen conditions (like a content source changing its paths). With good reasons provided we will of course make exceptions as we strive to provide the best user experience.

== General requirements ==

Here's a list of what basic sanity checks are done by repository maintainer on each submission.

=== Basic file checks ===

* all strings used by add-ons must be localized, no hard-coded language strings should ever be used
* all paths should be treated as case-sensitive, so that they work on all OSs and file systems.
* all paths and files should be lower-case due to the previous point
** exceptions are README, COPYING, <code>LICENSE.txt</code> that should be upper-case and the "Default" directory in <code>resources/skins</code>, for add-ons that need it.
* the following file-types are not allowed: <code>.so .dll .pyo .exe .xbt .xpr Thumbs.db</code> and so on (any binary files)
* all text files should use UNIX end-of-line
* all <code>.xml</code> files must pass xml validation
* all <code>.xml</code> files must have xml declaration as header
* all <code>.xml/.txt</code> must have unix style EOL's
* don't use a BOM at the start of your files
* file permissions: files should not be marked as executable
* filenames must have correct encoding (for skins: check your studio logos for corrupt filenames)
* use 4-letter '''lc_CC''' language codes for localized addon metadata in <code>addon.xml</code>
* <code>addon.xml</code> must have at least '''en_GB''' metadata.

=== Things that must be included ===

* [https://kodi.wiki/view/Add-on_structure#addon.xml addon.xml] must contain correct and valid info / version
* [https://kodi.wiki/view/Add-on_structure#icon.png icon.png] must be present (256x256) or (512x512) with solid colors (no transparency)
* [https://kodi.wiki/view/Add-on_structure#fanart.jpg fanart.jpg] must be present (1280x720 or 1920x1080 or 3840x2160)
* [https://kodi.wiki/view/Add-on_structure#LICENSE.txt LICENSE.txt] must be present

See also: [https://kodi.wiki/view/Add-on_structure '''Add-on structure''']

=== Things that can't be included ===

* no <code>.xbt</code> files (these will be generated by our repository)
* no other add-ons included (skinners: if you need a script, submit it separately and depend on it)
* don't include unneeded files (<code>.pdf</code>, <code>.doc</code>, <code>thumbs.db</code>, etc...)
* no licensed fonts / background images / anything
* binary/compiled/obfuscated files (with possible exception for minified JS/CSS files)

== Requirements for skins ==

=== Basic checks ===

* The file size must be sane. There is no hard limit, but a 100mb skin is pushing it.
* No mods. Mods are great, and pop up frequently in the forums. But we would rather not have several versions of the same skin in our repo. But if your mod is substantial different enough from the original (and by giving it a different name), we will of course take it in consideration. Also if the original skin is no longer available through our repo, we would have no problem replacing it with a mod.
* In order to compile your images with TexturePacker, all graphics files should have a resolution of at least 4x4.
* themes must be in a subfolder of the <code>themes/</code> folder in the skin root (eg. <code>skin.foo/themes/blue/</code>). The <code>.xbt</code> file will be created by our repo backend.
* If you want to have some images outside of <code>Textures.xbt</code>, then make sure you place those images outside of the <code>media/</code> folder and reference them using <code>special://skin/backdrops/</code> or similar. This is most useful for backgrounds - it keeps the size of the packed textures down. Any images you have in the <code>media/</code> folder will be placed in <code>Textures.xbt</code> in the official repository.
* Please be careful with addon dependencies. Only add dependencies that are needed for the skin to function properly.

=== Code checks ===

* all labels must be localized
* code should be case-sensitive
* skins should not create warning/errors in the logfile, this can be a lot of things:
** invalid includes
** undefined actions
** unable to evaluate condition
** undefined vars
** can't focus 'id'

'''Note:''' This of course also applies to script add-ons that use skin files

==== Optional support ====

This is optional and should not block inclusion in official repo.

* Mouse support
* Touchscreen support
* Peripheral dialogs
* PVR support
* ADSP support
* RDS support
* Game support

== Requirements for all python addons ==

We do not enforce any specific code style rules or coding practices. It's the developer's responsibility to ensure proper functioning of their addons.

General requirements:

* all <code>special://</code> paths should be translated using <code>xbmc.translatePath("special://foo/bar")</code>
* <code>xbmc.translatePath(xbmcaddon.Addon().getAddonInfo('path'))</code> should be used for files included with the add-on
* <code>xbmc.translatePath(xbmcaddon.Addon().getAddonInfo('profile'))</code> should be used for storing add-on related files
* direct access to the Kodi database is '''not''' allowed. You must use [https://kodi.wiki/view/JSON-RPC_API JSON RPC] for this.
* directly using any kind of analytics (Google Analytics for example) from within add-ons is not allowed. This should be handled server side by using user-agent.
* addons should use the <code>xbmc.log()</code> method to write to the logfile and use the debug logging level only. <code>print()</code> functions should not be used.
* Plugins should '''not''' force certain skin viewtypes on their own by calling <code>Container.SetViewMode(id)</code> or <code>Container.SetSortMethod(id)</code> built-in functions. They should set the correct media content from which the correct skin view type is automatically provided.
* add-ons should store all their data in their own profile subfolder inside the <code>addon_data</code> folder (accessed via <code>Addon.getAddonInfo('profile')</code> or <code>special://profile</code>). Access (read/write/delete) to any other files or folders is not allowed by default and should require an explicit user confirmation, e.g. via a UI modal dialog or a file selector. Short-lived files may also be stored in the Kodi temp folder <code>special://temp</code> directory but the addon profile folder is preferable.
* addons must not install other addons or modify their files.

''Exceptions to this rule may be granted in specific cases only. Please contact Team XBMC's add-on repository maintainers on github if your add-on needs access to such files.''

In case we grant such an exception for your addon, access (read/write/delete) to other files/directories must be opt-in by the user, and be clear for the user to understand what is being accessed.

== Specific requirements for scrapers ==

* scraper must return the following minimum information: movie title, year, plot, cast, poster, fanart
* Scrapers should store their file cache in <code>special://temp/scrapers/<addon_id></code> folder that is monitored by Kodi.

[[Category:Add-on development]]

Add-on rules

2026-05-30T18:28:53Z

Karellen: Removed protection from "Add-on rules"

{{mininav|[[Development]]|[[Add-on development]]}}

=== Repository Submission Guidelines - Please Read Before Submitting Your Addon ===

Inclusion in the Kodi.org repository is at the sole discretion of Team Kodi. Because maintaining such a large repository is a large task, we have set some guidelines for inclusion. Please ensure that these guidelines are met before submitting request to be added.
In order to be considered for the official repository, the following guidelines must be met:
* All add-ons must be developed as described on the [[Add-on development]] page.
* All add-ons must be compatible with Python 3. Contributions requiring Python 2 are no longer accepted. For more details see: [https://kodi.tv/article/the-sun-sets-on-python-2/ The Sun Sets on Python 2]
* You ''must'' include a license file (named LICENSE.txt). We recommend the [http://creativecommons.org/choose/non-web-popup?license_code=by-sa&jurisdiction=&version=3.0&lang=en CC-BY-SA 3.0] for skins and the [http://www.gnu.org/licenses/gpl-howto.html GPL v2+] for others, but most copy left licenses will suffice. Proprietary licenses will not be allowed. Please investigate which license suits your needs and you fully understand the contents.
* All files must be free and legal to distribute.
* The add-on must not violate any known copyright laws - if in doubt, let us know and we'll look into it for you.
* All source files must be included. No pre-compiled files will be allowed.
* You acknowledge that you are the maintainer of your add-on.
* Team-Kodi reserves the right to update or remove it at any time as we deem necessary.
* If a new stable Kodi is going to be released no new submissions are accepted to the repository for the previous version. This will start from when the first [http://en.wikipedia.org/wiki/Release_candidate#Release_candidate release candidate (RC)] of the new version is released. Only fixes and updates will be accepted and processed for the previous version (e.g. if the current stable is 13.x, no updates are allowed for 11.x any more). See: [[Submitting_Add-ons#Allowed_submissions|Allowed submissions]]
* Monetization of add-ons (for instance advertising or paid subscriptions) will not be allowed. We can make an exception in case you own the copyright for the content the add-on provides. Please contact us on the forum if you believe such an exception may apply to your add-on.
* All xbmc.python.module addons must be used by at least one other add-on in official repository.

=== Updates ===
Keep in mind that add-ons in the official repository should be considered ''stable''. This means that they should be well-tested before you submit them for inclusion.
Because they are for stable users, they should avoid being updated too often. Too often is of course subjective. If your add-on is in rapid development, and features are constantly being added, hold off until you have hit a good stopping point and ''tested'' the current version.

This means that you should ''not'' submit a request every time you change your code. If you are submitting updates more than once per week something is wrong. Once or twice per month is probably a better goal, barring unforeseen conditions (like a content source changing its paths). With good reasons provided we will of course make exceptions as we strive to provide the best user experience.

=== General requirements ===
Here's a list of what basic sanity checks are done by repository maintainer on each submission.

'''Basic file checks:'''

* all strings used by add-ons must be localized, no hard-coded language strings should ever be used
* all paths should be treated as case-sensitive, so that they work on all OSs and file systems.
* all paths and files should be lower-case due to the previous point
** exceptions are README, COPYING, LICENSE.txt that should be upper-case and the "Default" directory in <tt>resources/skins</tt>, for add-ons that need it.
* exception are the translation language folders which should be first letter capitalized.
* the following file-types are not allowed: .so .dll .pyo .exe .xbt .xpr Thumbs.db and so on<any binary files>
* all text files should use UNIX end-of-line
* all .xml files must pass xml validation
* all .xml files must have xml declaration as header
* all .xml/.txt must have unix style EOL's
* don't use a BOM at the start of your files
* file permissions: files should not be marked as executable
* filenames must have correct encoding (for skins: check your studio logos for corrupt filenames)

'''Things that must be included:'''

* [[Add-on structure#addon.xml|addon.xml]] must contain correct and valid info / version
* [[Add-on structure#icon.png|icon.png]] must be present (256x256) or (512x512)
* [[Add-on structure#fanart.jpg|fanart.jpg]] must be present (1280x720 or 1920x1080 or 3840x2160)
* [[Add-on structure#LICENSE.txt|LICENSE.txt]] must be present
{{See also|Add-on_structure}}

'''Things that can't be included:'''

* no .xbt files (these will be generated by our repository)
* no other add-ons included (skinners: if you need a script, submit it separately and depend on it)
* don't include unneeded files (.pdf, .doc, thumbs.db, etc...)
* no licensed fonts / background images / anything

=== Requirements for skins ===

'''Basic checks:'''

* The file size must be sane. There is no hard limit, but a 100mb skin is pushing it.
* No mods. Mods are great, and pop up frequently in the forums. But we would rather not have several versions of the same skin in our repo. But if your mod is substantial different enough from the original (and by giving it a different name), we will of course take it in consideration. Also if the original skin is no longer available through our repo, we would have no problem replacing it with a mod.
* In order to compile your images with TexturePacker, all graphics files should have a resolution of at least 4x4.
* themes must be in a subfolder of the themes/ folder in the skin root (eg. skin.foo/themes/blue/<files>). The .xbt file will be created by our repo backend.
* If you want to have some images outside of Textures.xbt, then make sure you place those images outside of the media/ folder and reference them using special://skin/backdrops/* or similar. This is most useful for backgrounds - it keeps the size of the packed textures down. Any images you have in the media/ folder will be placed in Textures.xbt in the official repository.
* Please be careful with addon dependencies. Only add dependencies that are needed for the skin to function properly.

'''Code checks:'''

* all labels must be localized
* code should be case-sensitive
* skins should not create warning/errors in the logfile, this can be a lot of things:
:* invalid includes
:* undefined actions
:* unable to evaluate condition
:* undefined vars
:* can't focus 'id'

{{Note|This of course also applies to script add-ons that use skin files}}

==== Optional support ====

This is optional and should not block inclusion in official repo.

* Mouse support
* Touchscreen support
* Peripheral dialogs
* PVR support
* ADSP support
* RDS support
* Game support

=== Requirements for all python addons ===

* all special:// paths should be translated using xbmc.translatePath("special://foo/bar")
* xbmc.translatePath(xbmcaddon.Addon().getAddonInfo('path')).decode('utf-8') should be used for files included with the add-on
* xbmc.translatePath(xbmcaddon.Addon().getAddonInfo('profile')).decode('utf-8') should be used for storing add-on related files
* direct access to the Kodi database is '''not''' allowed. You must use [[JSON-RPC_API|JSON RPC]] for this.
* directly using any kind of analytics (Google Analytics for example) from within add-ons is not allowed. This should be handled server side by using user-agent.
* addons should use the xbmc.log() method to write to the logfile and use the debug logging level only. print statements should not be used.
* Plugins should '''not''' force certain skin viewtypes on their own. They should set the correct media content from which the correct skin view type is automatically provided.
* add-ons should store all their data in their own subfolder inside the addon_data directory. Access (read/write/delete) to any other files / folders is not allowed by default.
:''Exceptions to this rule may be granted in specific cases only. Please contact Team XBMC's add-on repository maintainers on github if your add-on needs access to such files.''
:In case we grant such an exception for your addon, access (read/write/delete) to other files/directories must be opt-in by the user, and be clear for the user to understand what is being accessed.

=== Specific requirements for scrapers ===
* scraper must return the following minimum information: movie title, year, plot, cast, poster, fanart
* use 'chain function' for calling functions in common scrapers
* remove the deprecated XML tags from the scraper header in case you use a scraper editor made for pre-Dharma versions of XBMC

[[Category:Add-on development]]

Import-export library/Music

2026-05-29T01:37:06Z

Karellen:

{|class="infobox" style="width:200px"
! Import-Export Contents
|-
|
* '''[[Import-export_library|Import-Export]]'''
** '''[[Import-export_library/Music|Music Library]]'''
** '''[[Import-export_library/Video|Video Library]]'''
* '''[[HOW-TO:Create_Music_Library|Return to Music Guide]]'''
|}

{{mininav|[[Music_library|Music Library]] | [[Import-export_library|Import Export Library]]}}
{{see also|NFO files|Artwork|Backup}}

= Introduction =
The main data in the music library comes from metadata embedded in the music files, and the export facility does not export this data at all. Likewise import will not populate an empty library as it requires scanning the music file tags into the library first. What is imported and exported is any additional artist and album information that has been previously scraped from NFO files or online sources.

The Import-Export function has been overhauled for v18 and adds more functionality and integrates the new '''[[Artist information folder]]'''.

Song history and ratings are exported when using the Single File method in v18.2 and later. advancedsettings.xml entries are not required.

= Artist Information Folder =
:{{main|Artist information folder}}
{{#lst:Artist_information_folder|intro}}

{{#lst:Artist_information_folder|intro1}}

= Export =
<gallery mode="packed-overlay" widths="500px" heights="283px">
File:LibExp01.jpg|Location of options
File:MusicExport01.jpg|Export types
</gallery>

The Export and Import Library options are accessed via the Settings menu as detailed in the first image above.

The Export Library function has a number of options as depicted in the second image above. Each one is explained below.

{{red|If you intend to export artwork from cache, be aware of the modifications that {{kodi}} makes to cached artwork. If you have local artwork, do not export artwork.}}

'''''See: [[Artwork#Cache|Artwork Cache]]'''''

== Single File ==
<gallery mode="packed-overlay" widths="500px" heights="283px">
File:MusicExport02.jpg|Available options
File:LibExp06.jpg|Selecting the destination folder
File:MusicExport03.jpg|Selection of items to export
</gallery>

'''Summary:'''
*Exports a single ''.xml'' file saved to a destination folder specified by the user.
*Each export is a full export. There are no incremental exports.
*The only method to export user rating, play counts, last played and scraped ratings and votes. Requires v18.2 or later <ref name="PR15864" />
*No artwork is exported.
*Each file is named ''kodi_musicdbyyyymmdd_hhmmss''. The date is appended to all export files, and the time is only appended to subsequent exports on the same day. <ref>https://forum.kodi.tv/showthread.php?tid=319284&pid=2644557#pid2644557</ref>

'''Using:'''
;Destination folder
:Enter the location where Kodi will save the single xml file.

;Items to export
:Select what type of information to be exported

:;Albums
::Additional data for albums

:;Songs
::Will export song rating and history information. Requires v18.2 or later <ref name="PR15864">https://github.com/xbmc/xbmc/pull/15864</ref>. This includes:
::*User rating
::*Scraped rating and votes
::*Last played and play count

:;Album artists
::Will export the artist that released the album, but will not include guest or collaboration artists on the album

:;Song artists
::Will export the guest or collaboration artists that appear on an album

:;Other artists
::Will create folders for the remaining artists that do not fall into Album or Song artist category. This may include those artists (individual people or groups of individuals) with a specific '''role''' but not credited with being album or song artists. For example musicians, orchestra, choir, producer, lyricist, composer, DJ mixer, engineer etc.

== To library folders ==
<gallery mode="packed-overlay" widths="500px" heights="283px">
File:MusicExport04.jpg|Available options
File:MusicExport05.jpg|Selection of items to export
</gallery>

{{red|Note: This option requires the [[Artist information folder]] to be set.}}
:'''''See: [[Settings/Media/Music#Library|Artist Information Folder Setting]]'''''

'''Summary'''
*Artists will be exported to the Artist Information Folder.
*Additional Album metadata will be exported to the album folder containing the song files.
*Disambiguation of Artists is by appending the first 4 digits of the ''<musicBrainzArtistID>'' to the folder name.
*Disambiguation of Albums is by appending the first 4 digits of the ''<musicbrainzalbumid>'' to the folder name. <ref name="PR14257" />

'''Using:'''
;Items to export
:Select what type of information to be exported

:;Albums
::Additional data for albums

:;Album artists
::Will export the artist that released the album, but will not include guest or collaboration artists on the album

:;Song artists
::Will export the guest or collaboration artists that appear on an album

:;Other artists
::Will create folders for the remaining artists that do not fall into Album or Song artist category. This may include those artists (individual people or groups of individuals) with a specific '''role''' but not credited with being album or song artists. For example musicians, orchestra, choir, producer, lyricist, composer, DJ mixer, engineer etc.

;Output information to NFO files
:When enabled the export will create NFO files containing the metadata

;Include art works such as thumbnails and fanart
:When enabled this also exports all the artwork associated with the exported artists and or albums as separate image files
:Note that Kodi exports the images from cache in the resolution that it uses them, and this may be lower than the original images. If you have original local artwork in higher resolutions take great care with this export option. It will overwrite these higher images if you tell it to do so and they will be lost
:'''''See: [[Advancedsettings.xml#Library_artwork|Library Artwork in advancedsettings.xml]]'''''

;Overwrite existing files
:Affects the previous two settings
:When disabled, no NFO files (and artwork if enabled) will be exported for albums and artists that already have them. Only those Albums and Artists that do not have them will recieve the export.
:When enabled, all existing NFO files (and artwork if enabled) will be overwritten.

'''Note:''' When the last three settings are all disabled, the export becomes the '''Artist folders only''' type export

== Separate Files for each item ==
<gallery mode="packed-overlay" widths="500px" heights="283px">
File:MusicExport06.jpg|Available options
File:LibExp06.jpg|Selecting the destination folder
File:MusicExport05.jpg|Selection of items to export
</gallery>

'''Summary'''
*A diagnostic export that can be used to check the status of your library without interfering with your live folders and files
*Will '''not''' export to your existing Artist Information Folder and music sources
*Exports to a user nominated destination
*Kodi does not use this export in any way. It can be deleted once you have no further use for it

It will export the selected items to the user nominated Destination folder as follows:
*Artist folder name is derived from artist name as scanned into the library
*For each Artist, a folder will be created containing the NFO File and Artwork, if these options were enabled.
*Album Artists will contain sub-folders for each album. The album NFO file is exported to these album sub-folders.
*The album folder name is taken from the music folder containing the music files if there is a unique one, otherwise from the album name.
*Collaboration albums (more than 1 album artist) are placed under the first album artist.
*Disambiguation of Artists is by appending the first 4 digits of the ''<musicBrainzArtistID>'' to the folder name.
*Disambiguation of Albums is by appending the first 4 digits of the ''<musicbrainzalbumid>'' to the folder name. <ref name="PR14257">https://github.com/xbmc/xbmc/pull/14257</ref>

'''Using:'''
;Destination folder
:Enter the location where Kodi will save the export to.

;Items to export
:Select what type of information to be exported

:;Albums
::Additional data for albums

:;Album artists
::Will export the artist that released the album, but will not include guest or collaboration artists on the album

:;Song artists
::Will export the guest or collaboration artists that appear on an album

:;Other artists
::Will create folders for the remaining artists that do not fall into Album or Song artist category. This may include those artists (individual people or groups of individuals) with a specific '''role''' but not credited with being album or song artists. For example musicians, orchestra, choir, producer, lyricist, composer, DJ mixer, engineer etc.

;Output information to NFO files
:When enabled the export will create NFO files containing the metadata

;Include items that have not been scraped (to create template NFO files)
:If an artist or album has not been scraped from online or other sources, then there is no information available to export.
:Enabling this setting will force an export by creating a blank template style NFO file. This template can be used to easily add information to be refreshed into the library.

;Include art works such as thumbnails and fanart
:When enabled, will export all cached artwork

;Overwrite existing files
:Affects the previous two settings
:When disabled, no NFO files (and artwork if enabled) will be exported for albums and artists that already have them. Only those Albums and Artists that do not have them will recieve the export.
:When enabled, all existing NFO files (and artwork if enabled) will be overwritten.

== Artist folders only ==
<gallery mode="packed-overlay" widths="500px" heights="283px">
File:MusicExport07.jpg|Available options
File:MusicExport08.jpg|Selection of items to export
</gallery>

'''Summary'''
*Used to create '''empty''' artist folders in your new [[Artist information folder]]
*Used to add new artist folders when new music is added to your library
*Requires setting the [[Artist information folder]]
*Introduced in v18.2 <ref>https://github.com/xbmc/xbmc/pull/15821</ref>

'''Using:'''
;Items to export
:Select which artists will have folders created

:;Album artists
::Will create a folder for the artist that released the album.

:;Song artists
::Will create a folder for guest or collaboration artists that appear on an album

:;Other artists
::Will create folders for the remaining artists that do not fall into Album or Song artist category. This may include those artists (individual people or groups of individuals) with a specific '''role''' but not credited with being album or song artists. For example musicians, orchestra, choir, producer, lyricist, composer, DJ mixer, engineer etc.

= Import - Single File =
<gallery mode="packed-overlay" widths="500px" heights="283px">
File:LibExp06.jpg|Selecting the location of the single file
</gallery>

If you exported your library using the '''Single File''' method, use the Music Library Import option to import the data
*Ensure your music Sources have been added to the ''Music►Files'' section of {{kodi}}
*As each Source is added, you will be prompted to ''Do you want to add the media from this source to your library?''
**In the Settings option, ensure ''Fetch additional information and art during scan'' is ''disabled'' and select '''OK'''
**Select '''Yes''' to add the media.

Once all the sources have been added, and the music file tags have been scanned into the library,
*Select '''Import''' from the [[Settings/Media/Library#Import_library_2|Settings►Media►Library►]] page.
**Ensure you have selected ''Import'' under Music Lbrary, and not the Video Library Import.
*Navigate to the folder where you previously saved the single file export
*Select the appropriate ''kodi_musicdbyyyymmdd_hhmmss'' file
*Select '''OK''' and the import process will commence
*Once complete, your library should be functional again

Be aware:
*if you have removed Albums or Artists since the export, the metadata for those Albums and Album Artists will be re-imported. To remove the unwanted entries, run the '''Clean Library''' option as shown in the above image.



= References =
<references />

{{top}}
{{updated|20}}

[[Category:Karellen]]
[[Category:Music library]]

Official:Forum rules/Banned add-ons

2026-05-05T09:37:29Z

Karellen:

{{mininav| [[Official:Forum rules]]}}

This is an example list of repositories and add-ons that have been identified as violating the {{kodi}} '''[[Official:Forum rules]]'''. This means they have been banned from any official {{kodi}} forums, websites, IRC channels and any social media accounts that are under the control of Team Kodi or the [[XBMC Foundation]].

'''{{big|{{red|This list is only an example. Due to the dynamic nature of Piracy streams and the add-ons that access them, it is impossible to list all Builds/Repositories/Add-ons that violate the [[Official:Forum_rules#Piracy_Policy|forum rules]]}}}}'''

While Team Kodi does not regulate what users install or use, we offer no support when your install includes add-ons that violate the forum rules. Failure to do so may result in a ban.

== How do I tell if something is allowed or not==
{{collapse top|click "Expand" to view the rules on piracy/bootleg video content -->}}
{{main|Official:Forum rules}}
{{#lst:Official:Forum rules|piracy policy}}
{{collapse bottom}}

The basic rule of thumb for what is not allowed, is that if the Add-on is offering something for free that you would normally expect to pay for by any other means, then it'll most likely be using pirate feeds.

If the Add-on simply allows access to web feeds from the rights holders then discussion of these is normally allowed, in this case there generally will be a website equivalent of the service, for example Youtube, BBC iPlayer, Netflix.

'''Note -''' If the Add-on is from our Official Add-on Repo then it has already been checked that it doesn't break our rules, therefore anything contained in the Official Repo is safe to discuss in any of our websites/channels.

== Kodi Forks ==
* Nodi
* QODI
* Streamsmart
* TVMC

== Wizards ==
All Wizards and addon installers

== Builds ==
Any build featuring or offering one or more of the repositories or add-ons listed below
* <4k Colors>
* alluneed
* <Apollo>
* Balkan Green
* Buildstube
* Buildstuben
* Breezz
* <Bucks>
* cMaNWizard 
* Crewnique
* <Diamond>
* Doomzday
* EzzerMac
* FTMC TTM
* FMC
* Funsterplace
* Grindhouse
* GTKing 
* Infenity
* Kelebek
* Kodianer
* Luar
* Magic Dragon
* <Magnetic> 
* NarcacistWizard 
* One Nation
* Redbox
* Skydarks
* SkyMashi TV
* Slamious 
* Spartan 
* Sports 101
* StreamDigitalRepo
* Supreme build 
* The Crew
* Twistednutz
* Xanax
* Xenon
* Xtasy

== Repository blacklist ==
* 13Clowns 
* 5Star 
* 667repo
* 709 
* Absolut 
* addons4kodi 
* Adjaranet
* Adryan Lists 
* Aenemapy 
* Aftershock 
* <Agent> 
* <AH> 
* Alado 
* AJ Builds 
* Alfa 
* Aliunde 
* AllEyezOnMe 
* Androidbboy 
* <Apollo> 
* <Ares> 
* Atomic 
* Atom Reborn 
* <Awesome> 
* Balandro 
* Bamf 
* Beau B 
* BC Repo 
* Black Ghost 
* Blamo 
* <Blaze> 
* BlissTV 
* Brettus 
* Bubbles 
* Bugatsinho 
* Bulldog Streams 
* Bookmark Lite 
* Camaradas 
* Canal Nereo 
* <Canvas> 
* Carnamaleon 
* Catoal 
* Cazlo 
* Cellar Door TV 
* Cerebro 
* Chains 
* Chikiry 
* Colossus 
* Cosmic Saints 
* Cyberflix
* Cyphers Locker 
* Dandy Media 
* Dark Media 
* Decosub 
* DejaVu 
* Deliverance 
* Diablo 
* <Diamond> 
* Diamondback 
* Diggz 
* Dimitrology 
* Dobbelina 
* Docshadrach 
* Doomsday 
* Duckpool 
* Dudehere 
* Durex 
* Eggman (Overeasy) madtitansports
* Eleazar 
* Elementum 
* Elysium 
* EntertainmentRepo 
* Exodus 
* Exodus Redux 
* Ezra 
* EzzerMacs 
* FanFilms 
* <Flawless> 
* Fido 
* Fierce Gorilla 
* FilmKodi 
* FireTVGuru 
* FireStick Plusman 
* Flecha Nega 
* Foxystreams 
* Fractured 
* FracturedWizard 
* funstersplace 
* Fusion 
* Gaia 
* <Galaxy> 
* GenTec 
* GenieTV 
* Ghost IPTV 
* Goodfellas 
* GB160 
* Goliath 
* Griffin 
* Grindhouse 
* GTKing 
* <Gujal> 
* <Hacky> 
* HalowTV 
* Hellhounds 
* HEVC Video Club
* Hiraya 
* HSK 
* Host 505 
* House of el 
* Humla
* Iceballs 
* Illuminati 
* Incursion 
* Infiniflix 
* Jewrepo 
* J1nx
* Jesus box tv 
* Jsergio 
* Juggernaut 
* K3l3vra 
* Kaosbox2 
* <kb> 
* KDC 
* Kdil
* Kinkin 
* Kirks Build
* KNE 
* Kod1
* Kodi Addons Club
* Kodiadictos
* Kodi Balkan 
* Kodibae 
* Kodi-CZSK 
* Kodi Ghost 
* Kodi Israel for
* Kodil 
* Kodi Neu Erleben 
* Kodi Rae 
* Kodi Tips 
* KoDIYhelp 
* Kodi UKTV 
* Kodiwpigulce 
* Krogsbell IPTV
* K.U.S. 
* LastShip 
* Lazarus 
* <Lambda> 
* Lazy Kodi
* Legion 
* Leviathan 
* <Lockdown> 
* Loki 
* Looking Glass 
* LoonaticsAsylum 
* <Loop> 
* Man Cave 
* Maestro 
* Mad Titan Sports 
* Magicality 
* Magnetic 
* Maniac 
* Markop159 
* Mar33 
* MasterZD 
* Mats Builds 
* Maverick 
* Mbebe 
* Megatron 
* <Merlin> 
* Metal Kettle 
* Mhancoc 
* Milhano 
* Misfit Mod Light
* Mobie
* MorePower 
* Movie shark
* MoviesHD 
* MrandMrsSmith 
* MrBlamo
* MrFreeworld 
* Mr Stealth 
* MTL FREETV
* Mucky Ducks 
* MyShows.me 
* Narcacist 
* Nixgates 
* No-issue
* Noledynasty 
* Noobs and nerds 
* <Notsure> 
* Number 1 Guru 
* <Numbers>
* Numb3r5
* Oblivion 
* <Octopus> 
* <Oculus> 
* Onealliance 
* OneNation 
* Openeleq 
* Open Wizard 
* <Origin> 
* Orion 
* Ororo TV 
* Otaku 
* Pandoras Box 
* <Phoenix Reborn> 
* Pipcan 
* Players Klub 
* Playon Monkey 
* Plexus 
* Podgod 
* Premiumize 
* <Press Play> 
* Prototype 
* Ptom 
* Pulsar 
* <Pulse> 
* PureRepo 
* Quasar 
* raeenterprises 
* Razer 
* Red Hood 
* Redditreaper 
* Renegades 
* Repoil Club 
* Retromania 
* Ring of Saturn 
* Rising Tides 
* Robin Hood 
* Rodrigo 
* Rockcrusher 
* Sanctuary 
* Sandman 
* Sarcasm 
* Sasta TV 
* Scarecrew 
* Sdarot 
* Seren
* Shani 
* Simply caz 
* Skydarks 
* Slam 
* SpinzTV 
* Sports Devil 
* Sports Access 
* Smash repo 
* Smash Wizard 
* Smoothstreams 
* Stealth 
* <Stefano> 
* Steptoes 
* SteamDigitalRepo 
* StreamArmy 
* Stream Hub 
* SubZero 
* SuicideTV 
* Super Repo 
* Supremacy 
* Sweetwork 
* T2K 
* Targetin Wizard
* Tantrum TV 
* TDW1980 
* Team DNA 
* Team Nutz
* Tempest 
* The Crew 
* TheGroove 
* The Mania Services 
* <The Loop> 
* The Real Urban Kingz 
* The Unjudged
* The Vibe 
* The wiz
* Thgiliwt 
* <Titan> 
* Tikipeter 
* Tivustream 
* Tk Norris 
* Total Installer 
* TOTALXBMC
* Tsunami OG 
* TVADDONS 
* TV King 
* Twilight0 
* Ufo 
* Underdog 
* UK Turk 
* UK Turks 
* Ukodil 
* Umbrella 
* <Unity>
* <Universal Scrapers> 
* uRepo 
* Vader Streams 
* <Venom> 
* Vidtime 
* VIP Secret TV 
* <Vista> 
* VKKodi 
* VS247 
* Vstream 
* Warehouse
* Where the monsters live 
* White Devil 
* WikiXBMC
* Willows 
* Wolfpack 
* Wookie 
* Wrestling on Demand 
* Xan 
* XBMC HUB 
* Xfinity
* <Xstream> 
* Xunity
* XvBMC 
* Whitecream 
* Zero Tolerance 

== Add-on blacklist ==
* 123Movies 
* 13Clowns 
* 1Angels
* 1Channel 
* <1x2> 
* 80sstuff 
* AceStreams
* Adryanlist 
* Aftershock 
* Alfa 
* AllDebrid
* All Eyez on Me
* All Movies Stream
* <Alpha> 
* Alvin
* Amigos
* Animeram 
* Aragon 
* Area 51
* <Ares> 
* Arrakis 
* Asgard 
* Aspis 
* At The Flix 
* Atomic 
* Atom Reborn 
* BaddAssMovies4U 
* Bandicoot
* Bassfox-official
* BBTS 
* BBTSIP
* <Beast>
* Bennu 
* Binky TV 
* Black Ghost 
* Blamo 
* Bob Unleashed 
* BrazucaPlay 
* Brettus
* Bubbles 
* Cannabis 
* <Canvas> 
* Caretaker
* CartoonHD
* Cartoons8 
* cCloud 
* Cellar Door
* Cerebro 
* Chappa'ai 
* Chronos 
* Cine 
* Cloud 9 
* Cloudword
* coalition 
* cocoscrapers 
* Community Portal
* Configurator for Kodi
* Config wizard
* Continuum
* Cosmic Saints
* Covenant \
* Cristal Azul 
* DaddyLive 
* Daffys 
* Deccan Delight
* Dexter TV 
* Diabolik 
* Diesel
* Ditto Rain
* Ditto HotRain
* DOCU HUB 
* DosMovies
* Dreamcatcher
* Duck Shitmancave
* Durex 
* Dynasty
* Einthusan
* Eldorado 
* Elementum 
* Eliplex TV
* Elysium 
* Entertainment Hub
* Exodus 
* ExodusRedux 
* Exoshark
* Ezra
* EzzerMan 
* Fan Film
* F_50ci3ty
* F.T.V. 
* F4M proxy 
* F4M tester 
* <Fantastic> 
* Fen 
* Feren
* Film Kodi
* Film Dictator
* Filmux
* Final Gear
* Fine and Dandy 
* Fire TV Guru
* Flixnet
* FutbolTream 
* Free Streams 
* <Fresh start> 
* Gaia
* <Galaxy>
* <Genesis> 
* Genesis Reborn 
* Genie TV
* Goliath
* Good fellas 
* GoMovies
* GoTV
* gratis 
* Green Revolution
* Gurzil 
* HalowIPTV
* Hard Nox
* HDFilme.cx 
* HDHub4u
* Horus 
* Hot rain
* I4a TV
* I Watch Online
* Icarus 
* Ice Films 
* Incursion 
* Indian TV
* Indigo 
* Infiniflix 
* IPTV Stalker
* IPTV Simple Client 2
* Ironman 
* IStream
* IVue TV 
* Iwannawatch 
* J1nxPack
* Jango Music
* Jeckyll Hyde
* Jesus Box
* JokerSports 
* Jor El 
* Kaito 
* Kartina TV 
* Kids1ClickMovie 
* Kidsflix
* Kino.pub
* Kiss Anime 
* Klugscheisser
* KodiCat
* Kodiland
* KodiOnDemand
* Kodi Popcorn Time 
* KodiUK TV
* Kratos 
* Kratos Reborn 
* Lastship
* Latest Dude
* Legendary 
* Leviathan
* Limitless 
* Livehub 
* Live Streams Pro 
* <Logan> 
* Loki 
* Looking Glass
* LoopTV 
* Lucky IP TV 
* Mad Titans 
* Maestro IP TV 
* Magic Dragon 
* Magicality 
* Magyck PI
* MandraKodi 
* Marvin
* MashUp
* Maverick 
* MD repo
* Mega Reborn 
* Mega Search
* Mercury 
* Metallik 
* Metalliq 
* MK Sports
* Mobdina 
* Mobdro 
* Modbro
* Money Sports
* Moria 
* MotorReplays 
* <Movie Hub>
* Movie Hut
* Movie Night
* Movies Tape
* Movie25
* Movie4k 
* Movie Rulz
* Movies XK
* MovieStorm
* Mp3streams
* MrKnow 
* MrPiracy 
* Mucky Duck
* MuchMovies
* Mutts Nuts
* Navi X 
* Navy Seal
* Nemesis 
* Neptune Rising 
* Nextgen 
* Nightwing 
* NLView
* No Limits
* Nole Cinema
* Numb3r5
* <Numbers>
* Numbersbynumbers 
* OCW Reborn 
* Odin 
* One Alliance
* One Click Moviez 
* One Nation 
* Online Movies Pro
* Operation Robocop
* Open Wizard 
* Orion 
* Ororo TV 
* Otaku 
* Overeasy 
* P2P Streams 
* Palantir 
* Paradox
* Paragon
* <Phoenix> 
* phstreams 
* Picasso 
* Placenta 
* Players Klub
* Plexus 
* Popcorn Time
* Poseidon 
* POV
* Premiumize 
* Prime Links
* Prime Streams 
* Primewire
* Project Cypher
* Project Free TV 
* <Promise>
* Pro Sport; Pro-Sport; ProSport 
* Pulsar 
* Pyramid 
* Q Sports
* Quantum
* Quasar 
* Rapid Bit
* Real Debrid
* Real Movies 
* Rebirth 
* ReleaseBB
* Release Hub
* Renegades TV
* Rising Tides 
* RockCrusher
* RL series
* RobinHood Project 
* Resistance 
* Royal We 
* SALTS 
* Sanctuary
* Sasta TV 
* Schism 
* Scrubs 
* Season Dream 
* Seren 
* Settv
* Selfless
* Sdarot.tv 
* < Shadow > 
* Showbox 
* Silent Hunter
* Simple Kodi Wizard 
* <Smash> 
* Smooth streams 
* Soap Catchup
* Soulless
* Sparkle 
* Specto 
* Spinz TV
* Sport A Holic
* Sport365
* SportHDme 
* Sports Access 
* Sports Devil 
* Sportsmania
* SportzTV 
* Stallion
* Stream4Me
* Stream army 
* Stream Cinema 
* Stream hub 
* Stream on Demand
* Stream Storm TV
* Stream This TV
* Subzero 
* Super Streams
* SuperTV
* Supremacy 
* Swa Desi
* Swiftstreamz 
* Tantrumtv 
* TARDIS 
* TATA.TO-TV
* TATA.TO-VIDEO
* TAZ
* TeamZT Kriptix
* Teatv
* TecnoTV
* TeeVee 
* TempTV 
* Tempest 
* Terrarium TV
* The Chains 
* The Crew 
* The Dog's Bollocks 
* <The Loop> 
* The Oath 
* The Promise 
* The Yid 
* Tiggers
* Tiki 
* Tivustream 
* T Killa
* Toon Mania 
* truncatetables 
* TurkVod
* TV One 
* TVOnline 
* TVsupertuga 
* UK Turk Playlist 
* UK TV Now 
* Ultimate installer
* Ultimate IPTV
* Umbrella
* <Universal Scrapers> 
* Uranus 
* Vader Streams 
* Vdubt25
* Velocity 
* <Venom> 
* Video devil 
* Videodevil 
* Vip secret
* Vortech TV
* Vstream 
* White cream
* White Devil
* Wolfpack 
* Wookie
* Wraith
* Wrestling On Demand
* Xan 
* Xfinity Installer
* XMovies8
* <Xstream>
* Xunity 
* Xship 
* xxxodus 
* Yify Movies 
* Yoda 
* Zem TV 
* Zeta TV
* Zeus 

==So where do I get support?==
Every Add-on should contain the authors name, this is found by opening the Context menu on the Add-on and selecting '''Add-on Information'''

Generally a search of the Add-on's name together with the author name will give the location of where the author is active.

For example a search term might be:

'''Kodi TheCollective Youtube'''

[[File:add-on-context.JPG|400px]]
[[File:add-on-info.JPG|400px]]

<i style="display:none; speak:none;">
* Abortion
* airline
* Airlines
* Airways
* Astrologer
* Astrology
* Asshole
* Attapoll
* Babaji
* Cash Loan
* Credit card
* cruise
* Crypto
* cunt\w*
* Customer
* Divorce
* được
* flight
* fuck\w*
* FullZ
* Gestapo
* Helpline
* Hitler
* India
* payday loans
* PhonePe Support
* Lasix
* Marriage
* Moderator
* Moderators
* Mumbai
* Nazi
* Những
* omegle
* omglz
* Onlyfans
* Real Love
* refund
* Shein
* Switchonshop
* Switch0sh0p
* Switch0nsh0p
* Switchonsh0p
* Switch0nshop
* \$witchon\$hop
* \$witch0\$hop
* \$witchon\$hop
* \$witch0n\$h0p
* p\.com
* teléfono
* Temu
* tutorials-iptv-xbmc.blogspot
* Viagra
* VPN
* Witch
* ¿Cómo
</i>

{{top}}

__NOINDEX__
[[Category:XBMC_Foundation]]

Movie set information folder

2026-05-04T01:36:14Z

Karellen:

{{mininav|[[Video library]]|[[Video management|Management]] }}

= Introduction =
<section begin="intro" />The Movie Set Information Folder ('''MSIF''') is a user nominated folder that {{kodi}} will scan to locate '''local artwork''' for movie sets/collections.<section end="intro" />

If you do not use local artwork, and rely on the scrapers to provide your artwork, then there is no requirement for you to use this feature.

Most users are familiar with the movie Source added in {{kodi}} which contains movie folders which in turn contain the video file, artwork and NFO file for a movie. The Movie Set Information Folder is the same concept and will contain a sub-folder for each movie set which in turn contains the artwork for the movie set.

'''Notes:'''
* This is a v19 and later feature.
* Only one MSIF can be used in {{kodi}}.
* From v19 [https://rmrector.github.io/script.artwork.beef/ Artwork Beef] will no longer be available to load movie set artwork from local files.
* This is the only method that {{kodi}} will use to search and cache '''local''' movie set artwork. Movie set artwork saved in the movie folders will not be recognised.

<gallery mode="packed" widths="700px" heights="394px">
File:LocalMovieSetsArt01.jpg|Image 1
</gallery>

= Create Your MSIF =
The first step is to create your Movie Set Information Folder.

* The folder can be created anywhere {{kodi}} can access
* Avoid creating the folder inside another {{kodi}} Source. ie do not create it inside your movie or tv show source folders
* Image 1 above shows the folder ''f:\Movies- Sets Art\'' as the Movie Set Information Folder

= Set MSIF =
The second step is to set the new Movie Set Information Folder in {{kodi}}.

# Go to {{highlight| [[Settings/Media/Videos#Movie_Set_Information_Folder|Settings > Media > Videos]]}}
# Locate the setting '''Movie set information folder''' and select it
# Navigate to the new Movie Set Information Folder, enter it and select '''OK''' <sup>&dagger;</sup>
# Your new setting should be saved

* <sup>&dagger; </sup> If you are having problems adding the folder to the setting in step 3, first add the folder as a source in the [[File manager]], then at step 2 above select the folder from the offered list.

If you have not already done so, set the artwork types to be scanned into the library. This is a new process for v19. There is no longer a need to adjust artwork settings in scrapers.
# From the above '''Movie set information folder''' setting scroll down the page to '''Artwork level'''
# Select your preferred artwork level:
## Maximum - All available artwork in the folder will be scanned. This includes all artwork regardless of name and type.
## Basic - Minimal artwork- Poster and Fanart only for Movies and Movie Sets
## Custom - Create a whitelist of artwork to scan
## None - No artwork will be scanned.

'''Note: '''
* The advancedsettings.xml method of whitelisting artwork has been removed in v19.
* Any whitelisted tags in the advancedsettings.xml file will be automatically saved to the ''Custom'' artwork level in v19 the first time you run {{kodi}} with that advancedsettngs.xml file.

= Create Movie Set Sub Folders =
The third step is to create your movie set sub-folders which will contain the local artwork. There are a few ways to accomplish this as listed below. Choose the method that best suits your setup.

Regardless of which method you choose, the following requirements apply:
* The Movie Set Information Folder must contain movie set sub-folders.
* The movie set sub-folder must be named exactly as the collection is named in the {{kodi}} library. The name you see in {{Kodi}} or in an NFO file is the name you use.
* Artwork in each movie set folder must be named in the short format. eg ''fanart, poster, clearart'' etc See image 1 above.

'''Note-''' Illegal characters in the movie set name are replaced with an underscore '''_''' eg ''Mission: Impossible Collection'' becomes '''''Mission_ Impossible Collection'''''

== Manual ==
Create each movie set sub-folder manually and transfer your local artwork.

== Artwork Dump ==
Artwork Dump is the v19 replacement of Artwork Beef and is the '''recommended''' method for creating the MSIF sub-folders

'''Note:''' This method will not work if...
# you have used a media manager to create nfo files and download local artwork. Media managers strip out all artwork links from nfo files which is what Artwork Dump relies on to find artwork online. If you have used a media manager it should have already created the MSIF sub-folders for you during the scraping process.
# your nfo files contain no artwork links.

After updating to v19, install Artwork Dump and adjust the settings
# Enable ''Add artwork for new videos after library updates''
# Nominate which ''Media types to process automatically''
# Enable ''Automatically preload local video library artwork to {{kodi}} texture cache''
# Run the add-on. This will create your movie set folders and download the original artwork to the sub-folders

See: '''''[https://forum.kodi.tv/showthread.php?tid=360078 Artwork Dump forum thread]'''''

== Export ==
Once you update to v19, run an '''''[[Import-export_library/Video#Separate_Files|Export to Separate Files]]'''''
# Ensure you have adjusted all the settings described above
# Choose '''Yes''' to ''Export Artwork''
# Choose '''No''' to ''Overwrite old files''
# {{Kodi}} will create all the movie set sub-folders with artwork from the cache.
# Run a search and delete to remove the artwork files from the movie set sub-folders and replace with your original artwork files

'''Note''': This method will export nfo files and modified artwork for your entire library. We recommend using the Artwork Dump method.

= Using MSIF =
No special procedure is required to scan the artwork from the movie set sub-folder. When a movie is scraped that belongs to a collection, and a correct movie set sub-folder is available, {{kodi}} will scan the artwork.

If a movie set sub-folder is added after a collection is already created in the {{kodi}} library:
* Scanning/scraping another movie from the collection will load the artwork from the movie set sub-folder
* Alternatively you can load the artwork manually using the Choose Art method:
** Navigate to the collection in the {{kodi}} library
** From the '''[[Basic_controls#Context_Menu|Context menu]]''' select {{highlight|Manage > Choose art}}
** Select artwork for the required artwork types

= See Also =
* [[Movie_sets|Movie Sets]]
* [[Movie_sets_artwork|Movie Sets Artwork]]
* [[NFO_files/Movie_sets|Movie Sets nfo file]]
* [[HOW-TO:Movie_universe|Cinematic Universes]]

= References =
<References />

{{Top}}

{{updated|22}}
[[Category:Karellen]]
[[Category:Video library]]

Official:Forum rules/Banned add-ons

2026-04-24T08:52:27Z

Karellen:

{{mininav| [[Official:Forum rules]]}}

This is an example list of repositories and add-ons that have been identified as violating the {{kodi}} '''[[Official:Forum rules]]'''. This means they have been banned from any official {{kodi}} forums, websites, IRC channels and any social media accounts that are under the control of Team Kodi or the [[XBMC Foundation]].

'''{{big|{{red|This list is only an example. Due to the dynamic nature of Piracy streams and the add-ons that access them, it is impossible to list all Builds/Repositories/Add-ons that violate the [[Official:Forum_rules#Piracy_Policy|forum rules]]}}}}'''

While Team Kodi does not regulate what users install or use, we offer no support when your install includes add-ons that violate the forum rules. Failure to do so may result in a ban.

== How do I tell if something is allowed or not==
{{collapse top|click "Expand" to view the rules on piracy/bootleg video content -->}}
{{main|Official:Forum rules}}
{{#lst:Official:Forum rules|piracy policy}}
{{collapse bottom}}

The basic rule of thumb for what is not allowed, is that if the Add-on is offering something for free that you would normally expect to pay for by any other means, then it'll most likely be using pirate feeds.

If the Add-on simply allows access to web feeds from the rights holders then discussion of these is normally allowed, in this case there generally will be a website equivalent of the service, for example Youtube, BBC iPlayer, Netflix.

'''Note -''' If the Add-on is from our Official Add-on Repo then it has already been checked that it doesn't break our rules, therefore anything contained in the Official Repo is safe to discuss in any of our websites/channels.

== Kodi Forks ==
* Nodi
* QODI
* Streamsmart
* TVMC

== Wizards ==
All Wizards and addon installers

== Builds ==
Any build featuring or offering one or more of the repositories or add-ons listed below
* <4k Colors>
* alluneed
* <Apollo>
* Balkan Green
* Buildstube
* Buildstuben
* Breezz
* <Bucks>
* cMaNWizard 
* Crewnique
* <Diamond>
* Doomzday
* EzzerMac
* FTMC TTM
* FMC
* Funsterplace
* Grindhouse
* GTKing 
* Infenity
* Kelebek
* Kodianer
* Luar
* Magic Dragon
* <Magnetic> 
* NarcacistWizard 
* One Nation
* Redbox
* Skydarks
* SkyMashi TV
* Slamious 
* Spartan 
* Sports 101
* StreamDigitalRepo
* Supreme build 
* The Crew
* Twistednutz
* Xanax
* Xenon
* Xtasy

== Repository blacklist ==
* 13Clowns 
* 5Star 
* 667repo
* 709 
* Absolut 
* addons4kodi 
* Adjaranet
* Adryan Lists 
* Aenemapy 
* Aftershock 
* <Agent> 
* <AH> 
* Alado 
* AJ Builds 
* Alfa 
* Aliunde 
* AllEyezOnMe 
* Androidbboy 
* <Apollo> 
* <Ares> 
* Atomic 
* Atom Reborn 
* <Awesome> 
* Balandro 
* Bamf 
* Beau B 
* BC Repo 
* Black Ghost 
* Blamo 
* <Blaze> 
* BlissTV 
* Brettus 
* Bubbles 
* Bugatsinho 
* Bulldog Streams 
* Bookmark Lite 
* Camaradas 
* Canal Nereo 
* <Canvas> 
* Carnamaleon 
* Catoal 
* Cazlo 
* Cellar Door TV 
* Cerebro 
* Chains 
* Chikiry 
* Colossus 
* Cosmic Saints 
* Cyberflix
* Cyphers Locker 
* Dandy Media 
* Dark Media 
* Decosub 
* DejaVu 
* Deliverance 
* Diablo 
* <Diamond> 
* Diamondback 
* Diggz 
* Dimitrology 
* Dobbelina 
* Docshadrach 
* Doomsday 
* Duckpool 
* Dudehere 
* Durex 
* Eggman (Overeasy) madtitansports
* Eleazar 
* Elementum 
* Elysium 
* EntertainmentRepo 
* Exodus 
* Exodus Redux 
* Ezra 
* EzzerMacs 
* FanFilms 
* <Flawless> 
* Fido 
* Fierce Gorilla 
* FilmKodi 
* FireTVGuru 
* FireStick Plusman 
* Flecha Nega 
* Foxystreams 
* Fractured 
* FracturedWizard 
* funstersplace 
* Fusion 
* Gaia 
* <Galaxy> 
* GenTec 
* GenieTV 
* Ghost IPTV 
* Goodfellas 
* GB160 
* Goliath 
* Griffin 
* Grindhouse 
* GTKing 
* <Gujal> 
* <Hacky> 
* HalowTV 
* Hellhounds 
* HEVC Video Club
* Hiraya 
* HSK 
* Host 505 
* House of el 
* Humla
* Iceballs 
* Illuminati 
* Incursion 
* Infiniflix 
* Jewrepo 
* J1nx
* Jesus box tv 
* Jsergio 
* Juggernaut 
* K3l3vra 
* Kaosbox2 
* <kb> 
* KDC 
* Kdil
* Kinkin 
* Kirks Build
* KNE 
* Kod1
* Kodi Addons Club
* Kodiadictos
* Kodi Balkan 
* Kodibae 
* Kodi-CZSK 
* Kodi Ghost 
* Kodi Israel for
* Kodil 
* Kodi Neu Erleben 
* Kodi Rae 
* Kodi Tips 
* KoDIYhelp 
* Kodi UKTV 
* Kodiwpigulce 
* Krogsbell IPTV
* K.U.S. 
* LastShip 
* Lazarus 
* <Lambda> 
* Lazy Kodi
* Legion 
* Leviathan 
* <Lockdown> 
* Loki 
* Looking Glass 
* LoonaticsAsylum 
* <Loop> 
* Man Cave 
* Maestro 
* Mad Titan Sports 
* Magicality 
* Magnetic 
* Maniac 
* Markop159 
* Mar33 
* MasterZD 
* Mats Builds 
* Maverick 
* Mbebe 
* Megatron 
* <Merlin> 
* Metal Kettle 
* Mhancoc 
* Milhano 
* Misfit Mod Light
* Mobie
* MorePower 
* Movie shark
* MoviesHD 
* MrandMrsSmith 
* MrBlamo
* MrFreeworld 
* Mr Stealth 
* MTL FREETV
* Mucky Ducks 
* MyShows.me 
* Narcacist 
* Nixgates 
* No-issue
* Noledynasty 
* Noobs and nerds 
* <Notsure> 
* Number 1 Guru 
* <Numbers>
* Numb3r5
* Oblivion 
* <Octopus> 
* <Oculus> 
* Onealliance 
* OneNation 
* Openeleq 
* Open Wizard 
* <Origin> 
* Orion 
* Ororo TV 
* Otaku 
* Pandoras Box 
* <Phoenix Reborn> 
* Pipcan 
* Players Klub 
* Playon Monkey 
* Plexus 
* Podgod 
* Premiumize 
* <Press Play> 
* Prototype 
* Ptom 
* Pulsar 
* <Pulse> 
* PureRepo 
* Quasar 
* raeenterprises 
* Razer 
* Red Hood 
* Redditreaper 
* Renegades 
* Repoil Club 
* Retromania 
* Ring of Saturn 
* Rising Tides 
* Robin Hood 
* Rodrigo 
* Rockcrusher 
* Sanctuary 
* Sandman 
* Sarcasm 
* Sasta TV 
* Scarecrew 
* Sdarot 
* Seren
* Shani 
* Simply caz 
* Skydarks 
* Slam 
* SpinzTV 
* Sports Devil 
* Sports Access 
* Smash repo 
* Smash Wizard 
* Smoothstreams 
* Stealth 
* <Stefano> 
* Steptoes 
* SteamDigitalRepo 
* StreamArmy 
* Stream Hub 
* SubZero 
* SuicideTV 
* Super Repo 
* Supremacy 
* Sweetwork 
* T2K 
* Targetin Wizard
* Tantrum TV 
* TDW1980 
* Team DNA 
* Team Nutz
* Tempest 
* The Crew 
* TheGroove 
* The Mania Services 
* <The Loop> 
* The Real Urban Kingz 
* The Unjudged
* The Vibe 
* The wiz
* Thgiliwt 
* <Titan> 
* Tikipeter 
* Tivustream 
* Tk Norris 
* Total Installer 
* TOTALXBMC
* Tsunami OG 
* TVADDONS 
* TV King 
* Twilight0 
* Ufo 
* Underdog 
* UK Turk 
* UK Turks 
* Ukodil 
* Umbrella 
* <Unity>
* <Universal Scrapers> 
* uRepo 
* Vader Streams 
* <Venom> 
* Vidtime 
* VIP Secret TV 
* <Vista> 
* VKKodi 
* VS247 
* Vstream 
* Warehouse
* Where the monsters live 
* White Devil 
* WikiXBMC
* Willows 
* Wolfpack 
* Wookie 
* Wrestling on Demand 
* Xan 
* XBMC HUB 
* Xfinity
* <Xstream> 
* Xunity
* XvBMC 
* Whitecream 
* Zero Tolerance 

== Add-on blacklist ==
* 123Movies 
* 13Clowns 
* 1Angels
* 1Channel 
* <1x2> 
* 80sstuff 
* AceStreams
* Adryanlist 
* Aftershock 
* Alfa 
* AllDebrid
* All Eyez on Me
* All Movies Stream
* <Alpha> 
* Alvin
* Amigos
* Animeram 
* Aragon 
* Area 51
* <Ares> 
* Arrakis 
* Asgard 
* Aspis 
* At The Flix 
* Atomic 
* Atom Reborn 
* BaddAssMovies4U 
* Bandicoot
* Bassfox-official
* BBTS 
* BBTSIP
* <Beast>
* Bennu 
* Binky TV 
* Black Ghost 
* Blamo 
* Bob Unleashed 
* BrazucaPlay 
* Brettus
* Bubbles 
* Cannabis 
* <Canvas> 
* Caretaker
* CartoonHD
* Cartoons8 
* cCloud 
* Cellar Door
* Cerebro 
* Chappa'ai 
* Chronos 
* Cine 
* Cloud 9 
* Cloudword
* coalition 
* cocoscrapers 
* Community Portal
* Configurator for Kodi
* Config wizard
* Continuum
* Cosmic Saints
* Covenant \
* Cristal Azul 
* DaddyLive 
* Daffys 
* Deccan Delight
* Dexter TV 
* Diabolik 
* Diesel
* Ditto Rain
* Ditto HotRain
* DOCU HUB 
* DosMovies
* Dreamcatcher
* Duck Shitmancave
* Durex 
* Dynasty
* Einthusan
* Eldorado 
* Elementum 
* Eliplex TV
* Elysium 
* Entertainment Hub
* Exodus 
* ExodusRedux 
* Exoshark
* Ezra
* EzzerMan 
* Fan Film
* F_50ci3ty
* F.T.V. 
* F4M proxy 
* F4M tester 
* <Fantastic> 
* Fen 
* Feren
* Film Kodi
* Film Dictator
* Filmux
* Final Gear
* Fine and Dandy 
* Fire TV Guru
* Flixnet
* FutbolTream 
* Free Streams 
* <Fresh start> 
* Gaia
* <Galaxy>
* <Genesis> 
* Genesis Reborn 
* Genie TV
* Goliath
* Good fellas 
* GoMovies
* GoTV
* gratis 
* Green Revolution
* Gurzil 
* HalowIPTV
* Hard Nox
* HDFilme.cx 
* HDHub4u
* Horus 
* Hot rain
* I4a TV
* I Watch Online
* Icarus 
* Ice Films 
* Incursion 
* Indian TV
* Indigo 
* Infiniflix 
* IPTV Stalker
* IPTV Simple Client 2
* Ironman 
* IStream
* IVue TV 
* Iwannawatch 
* J1nxPack
* Jango Music
* Jeckyll Hyde
* Jesus Box
* JokerSports 
* Jor El 
* Kaito 
* Kartina TV 
* Kids1ClickMovie 
* Kidsflix
* Kino.pub
* Kiss Anime 
* Klugscheisser
* KodiCat
* Kodiland
* KodiOnDemand
* Kodi Popcorn Time 
* KodiUK TV
* Kratos 
* Kratos Reborn 
* Lastship
* Latest Dude
* Legendary 
* Leviathan
* Limitless 
* Livehub 
* Live Streams Pro 
* <Logan> 
* Loki 
* Looking Glass
* LoopTV 
* Lucky IP TV 
* Mad Titans 
* Maestro IP TV 
* Magic Dragon 
* Magicality 
* Magyck PI
* MandraKodi 
* Marvin
* MashUp
* Maverick 
* MD repo
* Mega Reborn 
* Mega Search
* Mercury 
* Metallik 
* Metalliq 
* MK Sports
* Mobdina 
* Mobdro 
* Modbro
* Money Sports
* Moria 
* MotorReplays 
* <Movie Hub>
* Movie Hut
* Movie Night
* Movies Tape
* Movie25
* Movie4k 
* Movie Rulz
* Movies XK
* MovieStorm
* Mp3streams
* MrKnow 
* MrPiracy 
* Mucky Duck
* MuchMovies
* Mutts Nuts
* Navi X 
* Navy Seal
* Nemesis 
* Neptune Rising 
* Nextgen 
* Nightwing 
* NLView
* No Limits
* Nole Cinema
* Numb3r5
* <Numbers>
* Numbersbynumbers 
* OCW Reborn 
* Odin 
* One Alliance
* One Click Moviez 
* One Nation 
* Online Movies Pro
* Operation Robocop
* Open Wizard 
* Orion 
* Ororo TV 
* Otaku 
* Overeasy 
* P2P Streams 
* Palantir 
* Paradox
* Paragon
* <Phoenix> 
* phstreams 
* Picasso 
* Placenta 
* Players Klub
* Plexus 
* Popcorn Time
* Poseidon 
* POV
* Premiumize 
* Prime Links
* Prime Streams 
* Primewire
* Project Cypher
* Project Free TV 
* <Promise>
* Pro Sport; Pro-Sport; ProSport 
* Pulsar 
* Pyramid 
* Q Sports
* Quantum
* Quasar 
* Rapid Bit
* Real Debrid
* Real Movies 
* Rebirth 
* ReleaseBB
* Release Hub
* Renegades TV
* Rising Tides 
* RockCrusher
* RL series
* RobinHood Project 
* Resistance 
* Royal We 
* SALTS 
* Sanctuary
* Sasta TV 
* Schism 
* Scrubs 
* Season Dream 
* Seren 
* Settv
* Selfless
* Sdarot.tv 
* < Shadow > 
* Showbox 
* Silent Hunter
* Simple Kodi Wizard 
* <Smash> 
* Smooth streams 
* Soap Catchup
* Soulless
* Sparkle 
* Specto 
* Spinz TV
* Sport A Holic
* Sport365
* SportHDme 
* Sports Access 
* Sports Devil 
* Sportsmania
* SportzTV 
* Stallion
* Stream4Me
* Stream army 
* Stream Cinema 
* Stream hub 
* Stream on Demand
* Stream Storm TV
* Stream This TV
* Subzero 
* Super Streams
* SuperTV
* Supremacy 
* Swa Desi
* Swiftstreamz 
* Tantrumtv 
* TARDIS 
* TATA.TO-TV
* TATA.TO-VIDEO
* TAZ
* TeamZT Kriptix
* Teatv
* TecnoTV
* TeeVee 
* TempTV 
* Tempest 
* Terrarium TV
* The Chains 
* The Crew 
* The Dog's Bollocks 
* <The Loop> 
* The Oath 
* The Promise 
* The Yid 
* Tiggers
* Tiki 
* Tivustream 
* T Killa
* Toon Mania 
* truncatetables 
* TurkVod
* TV One 
* TVOnline 
* TVsupertuga 
* UK Turk Playlist 
* UK TV Now 
* Ultimate installer
* Ultimate IPTV
* Umbrella
* <Universal Scrapers> 
* Uranus 
* Vader Streams 
* Vdubt25
* Velocity 
* <Venom> 
* Video devil 
* Videodevil 
* Vip secret
* Vortech TV
* Vstream 
* White cream
* White Devil
* Wolfpack 
* Wookie
* Wraith
* Wrestling On Demand
* Xan 
* Xfinity Installer
* XMovies8
* <Xstream>
* Xunity 
* Xship 
* xxxodus 
* Yify Movies 
* Yoda 
* Zem TV 
* Zeta TV
* Zeus 

==So where do I get support?==
Every Add-on should contain the authors name, this is found by opening the Context menu on the Add-on and selecting '''Add-on Information'''

Generally a search of the Add-on's name together with the author name will give the location of where the author is active.

For example a search term might be:

'''Kodi TheCollective Youtube'''

[[File:add-on-context.JPG|400px]]
[[File:add-on-info.JPG|400px]]

<i style="display:none; speak:none;">
* Abortion
* airline
* Airlines
* Airways
* Astrologer
* Astrology
* Asshole
* Babaji
* Cash Loan
* Credit card
* cruise
* Crypto
* cunt\w*
* Customer
* Divorce
* được
* flight
* fuck\w*
* FullZ
* Gestapo
* Helpline
* Hitler
* India
* payday loans
* PhonePe Support
* Lasix
* Marriage
* Moderator
* Moderators
* Mumbai
* Nazi
* Những
* omegle
* omglz
* Onlyfans
* Real Love
* refund
* Shein
* Switchonshop
* Switch0sh0p
* Switch0nsh0p
* Switchonsh0p
* Switch0nshop
* \$witchon\$hop
* \$witch0\$hop
* \$witchon\$hop
* \$witch0n\$h0p
* p\.com
* teléfono
* Temu
* tutorials-iptv-xbmc.blogspot
* Viagra
* VPN
* Witch
* ¿Cómo
</i>

{{top}}

__NOINDEX__
[[Category:XBMC_Foundation]]

Smart playlists

2026-04-15T01:47:07Z

Karellen:

{{:Smart_playlists/Contents}}
{{mininav|[[Playlists]] }}

== Introduction ==
<section begin="intro"/>Smart Playlists are a versatile feature that allow you to create customised lists of media that may be more suited to your browsing preference. They are a set of rules/filters that allow you to display a sub set of the media in your library.<section end="intro"/>

Once a smart playlist is created, it can be browsed like any other list in the {{kodi}} library.

A Smart Playlist can also be set as a menu item on the main menu using any compatible skin. See: '''''[[Custom home items]]'''''

'''Notes:'''
* Smart Playlists work by using the information in the databases. A correctly scanned/scraped library is required for accurate results
* It is not possible to combine different classes of media into a playlist. eg you cannot combine Movies and TV Shows. The only combining allowed is Music and Music Videos as these may share a common Artist

These pages are a basic guide to help you understand the process of creating a smart playlist. The easiest way to discover the power of smart playlists is to create and test. Create as many as you like, they can all be deleted and there is no effect on the rest of your setup.

== Methods ==
Playlists can be created and edited using either of the two following methods :

{{big|'''[[Smart_playlists/GUI Method|GUI Method]]'''}} - Create and edit playlists directly in {{kodi}} using the playlist editor

{{big|'''[[Smart_playlists/XSP Method|XSP Method]]'''}} - Advanced users can create and edit the XSP files located in the '''[[userdata]]\playlists''' folder

Also...

: '''[[Smart_playlists/Rules_and_groupings|Rules & Groupings]]''' - A list of Rules, Fields, Operators and Values that can be used in the XSP files

: '''[[Smart_playlists/Examples|Example XSP files]]''' - Example XSP files that can be copied into your own setup

: '''[[HOW-TO:Movie_universe|Movie Universes]]''' - Create Movie Universes using Smart Playlists

{{updated|20}}

[[Category:Karellen]]
[[Category:Video library]]
[[Category:Music library]]

NFO files/Movies

2026-04-13T07:09:27Z

Karellen: default values

{{NFO_content}}
{{mininav|[[NFO files]]}}

__TOC__

= Introduction =
NFO files to be scraped into the movie library are relatively simple and require only a single nfo file per title.

= nfo Name and Location =
'''{{resize|1.2em|Regardless of what settings you have set for the source and scraper, {{Kodi}} will always search for and scan the nfo file first where available.}}'''

There are two naming schemes for movie nfo files. Both are explained and {{kodi}} recommends using the ''<VideoFileName>.nfo'' format.

<section begin="MovieNFONaming" />;<VideoFileName>.nfo
:*NFO Files are named the same as the video file except with the ''.nfo'' extension.
:*We recommend using this filename format to name nfo files.

;movie.nfo
:{{Kodi}} may also scan nfo files named '''''movie.nfo'''''. To use this name, the setting '''Movies are in separate folders that match the movie title''' must be '''Enabled''' in the '''[[Adding_video_sources#Set_Content|Set Content Screen]]'''
:*If the above setting is not enabled, {{kodi}} will ignore the ''movie.nfo''. If the ''<VideoFileName>.nfo'' file is available, {{kodi}} will scan this one instead, otherwise an online scrape will be performed if a valid scraper is set for the Source.
:*If you use ''movie.nfo'' and later Export your library to Separate Files, {{kodi}} will still create the nfo file in the ''<VideoFileName>.nfo'' format and two nfo files will exist. If a Refresh or rescan is run in future, and the above setting is still enabled, the ''<VideoFileName>.nfo'' file will be ignored in favour of ''movie.nfo'', which means any changes you may have made to the library entry (play counts, watched status etc) will not be re-scanned back into the library.
:*We recommend using the ''<VideoFileName>.nfo'' format for nfo files to avoid the above traps.<section end="MovieNFONaming" />

The below image details naming and location for Single File, DVD and Bluray movies:

<gallery mode="packed" widths="1000px" heights="562px">
File:LocalMovieArtwork01.jpg|'''''Example of correct use of Movie Folder with artwork, nfo file, trailer and theme.<br> Take note of file naming and location.'''''
</gallery>

= nfo Tags =
The following table lists available XML tags. <ref>https://github.com/xbmc/xbmc/blob/master/xbmc/video/VideoInfoTag.cpp</ref>

The "Required" column indicates whether a tag can be optionally added or ommitted when creating the nfo to suit your purpose. The less tags used, the less information added to the library.

{|class="prettytable"
! width=430px | NFO (xml) Tag || Required || Multiple || Notes
|-
|<movie></movie> || {{Yes}} || No || The top level parent tag for the nfo file. All other tags must be contained within these two tags
|-
|<title></title> || {{Yes}} || No || The title for the movie
|-
|<originaltitle></originaltitle> || No || No || Displays the original title of the movie. <br>
For example, if the scraper is set to german language and the scraped movie in german is "Der mit dem Wolf tanzt" the original title will be "Dances with Wolves"
|-
|<sorttitle></sorttitle> || No || No || Allows alternate title sort without modifying movie title. Not displayed in any library listing. See: ''[[Movie_sets#Sort_Title|Sort Title]]''
|-
|
<ratings>
<rating name="" max="10" default="">
<value></value>
<votes></votes>
</rating>
</ratings>
|| No || No || ''default="true"'' ''default="false"''<br>
::Only one rating can be set as ''default="true"'', additional ratings must be set as ''default="false"'' or omit the default attribute<br>

''name="identifier"''. Do not use "default". Examples of identifier include...<br>
::''<rating name="imdb" max="10">''<br>
::''<rating name="trakt" max="10">''<br>
::''<rating name="themoviedb" max="10">''<br>
::''<rating name="metacritic" max="10">''<br>
::''<rating name="tomatometerallcritics" max="10">''<br>
::''<rating name="tomatometerallaudience" max="10">''<br>

Example of complete entry...
::''<rating name="themoviedb" max="10" default="true">''<br>
::''<rating name="imdb" max="10" default="false"> or <rating name="themoviedb" max="10">''<br>
|-
|<userrating></userrating> || No || No || Personal rating set by the user
|-
|<top250></top250> || No || No || Ranking in IMDB Top 250 movies
|-
|<outline></outline> || || || Should be short, will be displayed on a single line (scraped from IMDB only)
|-
|<plot></plot> || || || Can contain more information on multiple lines, will be wrapped
|-
|<tagline></tagline> || No || No || Short movie slogan. "The true story of a real fake" is the tagline for "Catch me if you can"
|-
|<runtime></runtime> || No || No || Minutes only. If ommitted, {{kodi}} will add runtime upon scanning
|-
|<thumb aspect="" preview=""></thumb> || No || Yes || Path to available Movie Posters. Not needed when using local artwork<br>
Example use of ''aspect=""''
:<thumb aspect="banner"
:<thumb aspect="clearart"
:<thumb aspect="clearlogo"
:<thumb aspect="discart"
:<thumb aspect="keyart"
:<thumb aspect="landscape"
:<thumb aspect="poster"
|-
|
<fanart>
<thumb preview=""></thumb>
</fanart>
|| No || Yes^ || Path to available movie fanart.<br>
:^ Multiple <thumb> entries allowed between the <fanart></fanart> tags
|-
|<mpaa></mpaa> || No || No || Country specific mpaa rating system. Check with skin author which prefix is required to diplay your country certification flags
|-
|<playcount></playcount> || No || No || Number of times movie has been played.<br>See... [[Import-export_library/Video#Watched.2C_PlayCount.2C_ResumePoints|Import-Export]]
|-
|<lastplayed></lastplayed> || No || No || Date last played as ''yyyy-mm-dd''
|-
|<id></id> || No || No || The default ID. <br>
Do not use. This is a Kodi generated tag. See next item.
|-
|<uniqueid type="" default=""></uniqueid> || {{Yes}} || Yes ||The ID from the scraper site.<br>
''type=""'' Identifier of the ID. Do not use "default". Examples of identifier include...<br>
::''<uniqueid type="imdb"''<br>
::''<uniqueid type="tvdb"''<br>
::''<uniqueid type="tmdb"''<br>
::For non-scraped items, use simple values like ''"home", "sport", "doco"'' etc<br>
::The value can be alpha-numeric eg ''tt3480556'' for imdb, ''286668'' for tmdb, ''home001'' for home movies, etc<br>
''default="true"'' ''default="false"''<br>
::Only one uniqueID can be set as ''default="true"'', additional uniqueID's must be set as ''default="false"'' or ommit the default attribute<br>
Example of complete entry...
::''<uniqueid type="tmdb" default="true">''<br>
::''<uniqueid type="imdb" default="false"> or <uniqueid type="imdb">''<br>
|-
|<genre></genre> || No || Yes || Movie genre.
|-
|<tag></tag> || No || Yes || Library Tags. See...'''[[Video library tags]]'''
|-
|
<set>
<name></name>
<overview></overview>
</set>
|| No || No || Movie set tags <br />
The <overview> tag allows a short summary of the movie set. It can be displayed by some skins.
<br />See... '''[[Movie sets]]'''
|-
|<country></country> || No || Yes || Country of origin
|-
|<credits></credits> || No || Yes || Field for writers.
|-
|<director></director> || No || Yes || Movie Director
|-
|<premiered></premiered> || No || No || Release date of movie. Format as ''yyyy-mm-dd''
|-
|<year></year> || No || No || Release Year.<br>
{{note|Kodi v17: Tag deprecated, use <premiered> tag instead.}}
{{note|Kodi v20: Use <premiered> tag only.}}
|-
|<status></status> || No || No || Not used
|-
|<nowiki><code></code></nowiki> || No || No || Not used
|-
|<aired></aired> || No || No || Not used
|-
|<studio></studio> || No || Yes || Production studio
|-
|<trailer></trailer> || No || No || Local or online path to movie trailer<br> Do not add local path to trailer. {{kodi}} will automatically scan for local trailers.<br> See... '''[[Trailers]]'''
|-
|
<fileinfo>
<streamdetails>
<video>
<codec></codec>
<aspect></aspect>
<width></width>
<height></height>
<durationinseconds></durationinseconds>
<stereomode></stereomode>
<hdrtype></hdrtype>
</video>
<audio>
<codec></codec>
<language></language>
<channels></channels>
</audio>
<subtitle>
<language></language>
</subtitle>
</streamdetails>
</fileinfo>
|| No || Yes || For a full list of values, see the next section "Values" below.
Multiple entries of <audio> and <subtitles> accepted<br>
In v17 and prior, {{kodi}} would overwrite these values on first play of the file.<br>
In v18 that process was removed and values in these tags will remain.<ref>https://github.com/xbmc/xbmc/pull/16342</ref><br><br>
|-
|
<actor>
<name></name>
<role></role>
<order></order>
<thumb></thumb>
</actor>
|| No || Yes || The <order> tag determines where in the list the actor will appear. 0 = first in the list
|-
|<showlink></showlink> || No || No || Connect movie to TV Show. Use the TV Show <title></title> name.
|-
|
<resume>
<position></position>
<total></total>
</resume>
|| No || No || Movie resume point in Seconds<br>See... [[Import-export_library/Video#Watched.2C_PlayCount.2C_ResumePoints|Import-Export]]
|-
|<dateadded></dateadded> || No || No || mTime of the playable video file. Can be altered in advancedsettings.xml<br>See... '''[[Advancedsettings.xml#videolibrary]]'''
|-
|<originallanguage></originallanguage> || No || No || Main spoken language of the movie (import: ISO 639-1, 639-2, BCP 47 or English language name. export: BCP 47)<br>
example uses:<br>
:<originallanguage>fr</originallanguage>
:<originallanguage>fr-CA</originallanguage>
:<originallanguage>French</originallanguage>
Added in Kodi v22
|}

= Values =
Possible values for tags.

== fileinfo ==
{{kodi}} reads details the streams contained in the video file. These values are added to the database. Some values match a predetermined list (eg codec) while others are free form (eg width/height).

The current predetermined list for the <code><fileinfo></fileinfo></code> child tags can be found on Github...
{{Github_link|[https://github.com/XBMC/xbmc/blob/master/xbmc/GUIInfoManager.cpp]}}

=== video ===

<code><codec></codec></code>
{{collapse top}}
3iv2
av1
avc1
div2
div3
divx
divx 4
dx50
flv
h264
microsoft
mp42
mp43
mp4v
mpeg1video
mpeg2video
mpg4
rv40
svq1
svq3
theora
vp6f
wmv2
wmv3
wvc1
xvid
{{collapse bottom}}

<code><aspect></aspect></code>
{{collapse top}}
1.00
1.19
1.33
1.37
1.66
1.78
1.85
2.00
2.20
2.35
2.40
2.55
2.76
{{collapse bottom}}

<code><stereomode></stereomode></code>
{{collapse top}}
mono
split_vertical
split_horizontal
row_interleaved
anaglyph_cyan_red
anaglyph_green_magenta
{{collapse bottom}}

<code><hdrtype></hdrtype></code>
{{collapse top}}
empty = SDR
hdr10
dolbyvision
hlg
{{collapse bottom}}

=== audio ===

<code><codec></codec></code>
{{collapse top}}
aac
aac_lc
he_aac
he_aac_v2
aac_ssr
aac_ltp
ac3
cook
dca
dtshd_hra
dtshd_ma
dtshd_ma_x
dtshd_ma_x_imax
eac3
eac3_ddp_atmos
mp1
mp2
mp3
pcm_s16be
pcm_s16le
pcm_u8
truehd
truehd_atmos
vorbis
wmapro
wmav2
{{collapse bottom}}

<code><language></language></code><br/>
Use 3-letter language code

<code><channels></channels></code>
{{collapse top}}
1
2
4
5
6
8
10
{{collapse bottom}}

=== subtitle ===

<code><language></language></code><br/>
Use 3-letter language code

= References =
<references />

{{top}}
{{updated|20}}

[[Category:Karellen]]
[[Category:Video library]]

NFO files/Templates

2026-01-17T02:21:00Z

Karellen:

{{NFO_content}}
{{mininav|[[NFO files]]}}

__TOC__

= Introduction =
<section begin="intro" />Basic templates as a starting point to create your own NFO files.<section end="intro" />

These are simple NFO templates with the following changes from a full nfo file.
*System generated tags are removed
*Assumes local artwork is being used
*Assumes no online information is available, so items like Ratings have no relevance
*This will be the first time scanned into library so watched status and play counts are not required.
If any of these removed tags are required, simply add back the appropriate tags. If unsure, refer to the appropriate sample nfo file in each section.

= album.nfo Template =
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<album>
<title></title>
<genre></genre>
<style></style>
<mood></mood>
<theme></theme>
<compilation></compilation> 
<boxset>false</boxset> 
<review></review>
<type></type>
<releasedate></releasedate> 
<label></label>
<rating max="10"></rating>
<userrating max="10"></userrating>
<votes></votes>
<year></year>
<albumArtistCredits>
<artist></artist>
<musicBrainzArtistID></musicBrainzArtistID>
</albumArtistCredits>
</album>
</syntaxhighlight>

{{collapse top| SAMPLE - album.nfo file }}
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<album>
<title>Greatest Hits, Volume I & Volume II</title>
<musicbrainzalbumid>8bd9c465-28bb-37e4-bab5-aad725246bd7</musicbrainzalbumid>
<musicbrainzreleasegroupid>4a8f66b9-2ebf-3ebf-bd5e-ad19386e76c0</musicbrainzreleasegroupid>
<scrapedmbid>false</scrapedmbid>
<artistdesc>Billy Joel</artistdesc>
<genre>Rock</genre>
<style>Rock/Pop</style>
<mood>Happy</mood>
<theme>Affection/Fondness</theme>
<theme>At the Office</theme>
<theme>Cool & Cocky</theme>
<theme>Drinking</theme>
<theme>Guys Night Out</theme>
<theme>Hanging Out</theme>
<theme>Open Road</theme>
<theme>Partying</theme>
<theme>TGIF</theme>
<compilation>false</compilation>
<boxset>false</boxset>
<review>Billy Joel's Greatest Hits is a collection released in two sets, 12 years apart. The first set, consisting of two discs, titled Volume I and Volume II, was released in 1985. The second, single disc titled Volume III was released in 1997. All songs but the last three on Volume III, "To Make You Feel My Love", "Hey Girl" and "Light as the Breeze" were written by Joel. "You're Only Human (Second Wind)" and "The Night Is Still Young" are only available on the first set. The other songs appear mostly in order of their release dates and generally represent Joel's most successful singles.</review>
<type>album / compilation</type>
<releasestatus>official</releasestatus>
<releasedate>1985</releasedate>
<originalreleasedate>1985-07-27</originalreleasedate>
<label>Columbia</label>
<duration>3948</duration>
<thumb spoof="" cache="" aspect="thumb" preview="https://assets.fanart.tv/preview/music/64b94289-9474-4d43-8c93-918ccc1920d1/albumcover/greatest-hits-volume-i--volume-ii-4e80240798fa9.jpg">https://assets.fanart.tv/fanart/music/64b94289-9474-4d43-8c93-918ccc1920d1/albumcover/greatest-hits-volume-i--volume-ii-4e80240798fa9.jpg</thumb>
<thumb spoof="" cache="" aspect="thumb" preview="http://coverartarchive.org/release/0a77a705-1bd5-4e54-80d1-eee6a8980ce9/7763963170-250.jpg">http://coverartarchive.org/release/0a77a705-1bd5-4e54-80d1-eee6a8980ce9/7763963170.jpg</thumb>
<thumb spoof="" cache="" aspect="thumb" preview="https://www.theaudiodb.com/images/media/album/thumb/greatest-hits-volume-i--volume-ii-4e80240798fa9.jpg/preview">https://www.theaudiodb.com/images/media/album/thumb/greatest-hits-volume-i--volume-ii-4e80240798fa9.jpg</thumb>
<thumb spoof="" cache="" aspect="thumb" preview="https://cdn-s3.allmusic.com/release-covers/500/0003/348/0003348267.jpg">https://cdn-s3.allmusic.com/release-covers/500/0003/348/0003348267.jpg</thumb>
<thumb spoof="" cache="" aspect="thumb" preview="https://img.discogs.com/THNtJtov2SR6mruul2yDUpWGzsU=/fit-in/150x150/filters:strip_icc():format(jpeg):mode_rgb():quality(40)/discogs-images/R-1326435-1352488890-1806.jpeg.jpg">https://img.discogs.com/JXeaiKEB7I8iMnO71HN2fTEVXXw=/fit-in/600x149/filters:strip_icc():format(jpeg):mode_rgb():quality(90)/discogs-images/R-1326435-1352488890-1806.jpeg.jpg</thumb>
<thumb spoof="" cache="" aspect="back" preview="https://www.theaudiodb.com/images/media/album/thumbback/syytpt1541038474.jpg/preview">https://www.theaudiodb.com/images/media/album/thumbback/syytpt1541038474.jpg</thumb>
<thumb spoof="" cache="" aspect="spine" preview="https://www.theaudiodb.com/images/media/album/spine/wyrprx1541038408.jpg/preview">https://www.theaudiodb.com/images/media/album/spine/wyrprx1541038408.jpg</thumb>
<thumb spoof="" cache="" aspect="discart" preview="https://www.theaudiodb.com/images/media/album/cdart/greatest-hits-volume-i--volume-ii-4f7a6021d770c.png/preview">https://www.theaudiodb.com/images/media/album/cdart/greatest-hits-volume-i--volume-ii-4f7a6021d770c.png</thumb>
<thumb spoof="" cache="" aspect="discart" preview="http://coverartarchive.org/release/0a77a705-1bd5-4e54-80d1-eee6a8980ce9/9466580411-250.jpg">http://coverartarchive.org/release/0a77a705-1bd5-4e54-80d1-eee6a8980ce9/9466580411.jpg</thumb>
<thumb spoof="" cache="" aspect="discart" preview="https://assets.fanart.tv/preview/music/64b94289-9474-4d43-8c93-918ccc1920d1/cdart/greatest-hits-volume-i--volume-ii-5ed1a7b2be7ce.png">https://assets.fanart.tv/fanart/music/64b94289-9474-4d43-8c93-918ccc1920d1/cdart/greatest-hits-volume-i--volume-ii-5ed1a7b2be7ce.png</thumb>
<thumb spoof="" cache="" aspect="discart1" preview="https://assets.fanart.tv/preview/music/64b94289-9474-4d43-8c93-918ccc1920d1/cdart/greatest-hits-volume-i--volume-ii-5ed1a7b2be7ce.png">https://assets.fanart.tv/fanart/music/64b94289-9474-4d43-8c93-918ccc1920d1/cdart/greatest-hits-volume-i--volume-ii-5ed1a7b2be7ce.png</thumb>
<thumb spoof="" cache="" aspect="discart2" preview="https://assets.fanart.tv/preview/music/64b94289-9474-4d43-8c93-918ccc1920d1/cdart/greatest-hits-volume-i--volume-ii-4f7a6049cb238.png">https://assets.fanart.tv/fanart/music/64b94289-9474-4d43-8c93-918ccc1920d1/cdart/greatest-hits-volume-i--volume-ii-4f7a6049cb238.png</thumb>
<path>F:\Music\FLAC\Artist Albums\Billy Joel\Greatest Hits Vol I & II\</path>
<rating max="10">7.000000</rating>
<userrating max="10">0</userrating>
<votes>4</votes>
<albumArtistCredits>
<artist>Billy Joel</artist>
<musicBrainzArtistID>64b94289-9474-4d43-8c93-918ccc1920d1</musicBrainzArtistID>
</albumArtistCredits>
<releasetype>album</releasetype>
</album>

</syntaxhighlight>
{{collapse bottom}}

= artist.nfo Template =
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<artist>
<name></name>
<sortname></sortname>
<type></type>
<gender></gender>
<disambiguation></disambiguation>
<genre></genre>
<style></style>
<mood></mood>
<yearsactive></yearsactive>
<born></born>
<formed></formed>
<biography></biography>
<died></died>
<disbanded></disbanded>
</artist>
</syntaxhighlight>

{{collapse top| SAMPLE - artist.nfo file }}
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<artist>
<name>Billy Joel</name>
<musicBrainzArtistID>64b94289-9474-4d43-8c93-918ccc1920d1</musicBrainzArtistID>
<sortname>Joel, Billy</sortname>
<type>Person</type>
<gender>Male</gender>
<disambiguation></disambiguation>
<genre>Pop/Rock</genre>
<style>Album Rock</style>
<style>Contemporary Pop/Rock</style>
<style>Singer/Songwriter</style>
<style>Soft Rock</style>
<style>Keyboard</style>
<mood>Amiable/Good-Natured</mood>
<mood>Autumnal</mood>
<mood>Nostalgic</mood>
<mood>Refined</mood>
<mood>Acerbic</mood>
<mood>Bittersweet</mood>
<mood>Brash</mood>
<mood>Cynical/Sarcastic</mood>
<mood>Earnest</mood>
<yearsactive>1960s - 2010s</yearsactive>
<born>1949-05-09</born>
<formed>1964</formed>
<biography>William Martin "Billy" Joel (born May 9, 1949, New York, USA) is an American pianist, singer-songwriter, and composer. Since releasing his first hit song, "Piano Man", in 1973, Joel has become the sixth-best-selling recording artist and the third-best-selling solo artist in the United States, according to the RIAA. His compilation album Greatest Hits Vol. 1 & 2 is the third-best-selling album in the United States by discs shipped.
Joel had Top 40 hits in the 1970s, 1980s, and 1990s, achieving 33 Top 40 hits in the United States, all of which he wrote himself. He is also a six-time Grammy Award winner, a 23-time Grammy nominee and one of the world's best-selling artists of all time, having sold over 150 million records worldwide. He was inducted into the Songwriter's Hall of Fame (1992), the Rock and Roll Hall of Fame (1999), and the Long Island Music Hall of Fame (2006). In 2008, Billboard magazine released a list of the Hot 100 All-Time Top Artists to celebrate the US singles chart's 50th anniversary, with Billy Joel positioned at No. 23. With the exception of the 2007 songs "All My Life" and "Christmas in Fallujah", Joel stopped writing and recording popular music after 1993's River of Dreams, but he continued to tour extensively until 2010. Joel was born in the Bronx, May 9, 1949 and raised in Hicksville, New York in a Levitt home. His father, Howard (born Helmuth), was born in Germany, the son of German merchant and manufacturer Karl Amson Joel, who, after the advent of the Nazi regime, emigrated to Switzerland and later to the United States. Billy Joel's mother, Rosalind Nyman, was born in England to Philip and Rebecca Nyman. Both of Joel's parents were Jewish. They divorced in 1960, and his father moved to Vienna, Austria. Billy has a sister, Judith Joel, and a half-brother, Alexander Joel, who is an acclaimed classical conductor in Europe and currently chief musical director of the Staatstheater Braunschweig.
Joel's father was an accomplished classical pianist. Billy reluctantly began piano lessons at an early age, at his mother's insistence; his teachers included the noted American pianist Morton Estrin and musician/songwriter Timothy Ford. His interest in music, rather than sports, was a source of teasing and bullying in his early years. (He has said in interviews that his piano instructor also taught ballet. Her name was Frances Neiman, and she was a Juilliard trained musician. She gave both classical piano and ballet lessons in the studio attached to the rear of her house, leading neighborhood bullies to mistakenly assume that he was learning to dance.) As a teenager, Joel took up boxing so that he would be able to defend himself. He boxed successfully on the amateur Golden Gloves circuit for a short time, winning twenty-two bouts, but abandoned the sport shortly after breaking his nose in his twenty-fourth boxing match.
Joel attended Hicksville High School in 1967, but he did not graduate with his class. He had been helping his single mother make ends meet by playing at a piano bar, which interfered with his school attendance. At the end of his senior year, Joel did not have enough credits to graduate. Rather than attend summer school to earn his diploma, however, Joel decided to immediately begin a career in music. Joel recounted, "I told them, 'To hell with it. If I'm not going to Columbia University, I'm going to Columbia Records, and you don't need a high school diploma over there'." Columbia did, in fact, become the label that eventually signed him. In 1992, he submitted essays to the school board and was awarded his diploma at Hicksville High's annual graduation ceremony, 25 years after he had left.</biography>
<died></died>
<disbanded></disbanded>
<thumb spoof="" cache="" aspect="thumb" preview="https://assets.fanart.tv/preview/music/64b94289-9474-4d43-8c93-918ccc1920d1/artistthumb/joel-billy-541603848114c.jpg">https://assets.fanart.tv/fanart/music/64b94289-9474-4d43-8c93-918ccc1920d1/artistthumb/joel-billy-541603848114c.jpg</thumb>
<thumb spoof="" cache="" aspect="thumb" preview="https://www.theaudiodb.com/images/media/artist/thumb/ttsxwr1425765041.jpg/preview">https://www.theaudiodb.com/images/media/artist/thumb/ttsxwr1425765041.jpg</thumb>
<thumb spoof="" cache="" aspect="thumb" preview="https://rovimusic.rovicorp.com/image.jpg?c=73pC-Gp0OovlmiQL7Wp5Yd_M69_UI9rrJSVvWL2-yAg=&f=2">https://rovimusic.rovicorp.com/image.jpg?c=73pC-Gp0OovlmiQL7Wp5Yd_M69_UI9rrJSVvWL2-yAg=&f=0</thumb>
<thumb spoof="" cache="" aspect="thumb" preview="https://img.discogs.com/J3bqAiLmdr2gXsetNgSQF2W-f6M=/150x150/smart/filters:strip_icc():format(jpeg):mode_rgb():quality(40)/discogs-images/A-137418-1143052539.jpeg.jpg">https://img.discogs.com/u7cfC3lZo9JGRdukSttJTZKr9Go=/350x255/smart/filters:strip_icc():format(jpeg):mode_rgb():quality(90)/discogs-images/A-137418-1143052539.jpeg.jpg</thumb>
<thumb spoof="" cache="" aspect="clearlogo" preview="https://www.theaudiodb.com/images/media/artist/logo/tvqpys1367246337.png/preview">https://www.theaudiodb.com/images/media/artist/logo/tvqpys1367246337.png</thumb>
<thumb spoof="" cache="" aspect="clearart" preview="https://www.theaudiodb.com/images/media/artist/clearart/yqpsuq1523892204.png/preview">https://www.theaudiodb.com/images/media/artist/clearart/yqpsuq1523892204.png</thumb>
<thumb spoof="" cache="" aspect="landscape" preview="https://www.theaudiodb.com/images/media/artist/widethumb/tywpqx1530815867.jpg/preview">https://www.theaudiodb.com/images/media/artist/widethumb/tywpqx1530815867.jpg</thumb>
<thumb spoof="" cache="" aspect="banner" preview="https://assets.fanart.tv/preview/music/64b94289-9474-4d43-8c93-918ccc1920d1/musicbanner/joel-billy-5914e7759bfcd.jpg">https://assets.fanart.tv/fanart/music/64b94289-9474-4d43-8c93-918ccc1920d1/musicbanner/joel-billy-5914e7759bfcd.jpg</thumb>
<thumb spoof="" cache="" aspect="clearlogo" preview="https://assets.fanart.tv/preview/music/64b94289-9474-4d43-8c93-918ccc1920d1/hdmusiclogo/joel-billy-550b259604412.png">https://assets.fanart.tv/fanart/music/64b94289-9474-4d43-8c93-918ccc1920d1/hdmusiclogo/joel-billy-550b259604412.png</thumb>
<thumb spoof="" cache="" aspect="fanart" preview="https://assets.fanart.tv/preview/music/64b94289-9474-4d43-8c93-918ccc1920d1/artistbackground/joel-billy-4fc0c2dad9ab7.jpg">https://assets.fanart.tv/fanart/music/64b94289-9474-4d43-8c93-918ccc1920d1/artistbackground/joel-billy-4fc0c2dad9ab7.jpg</thumb>
<thumb spoof="" cache="" aspect="fanart" preview="https://www.theaudiodb.com/images/media/artist/fanart/uwqtup1521206367.jpg/preview">https://www.theaudiodb.com/images/media/artist/fanart/uwqtup1521206367.jpg</thumb>
<path>F:\Music\ArtistInfoKodi\Billy Joel</path>
</artist>

</syntaxhighlight>
{{collapse bottom}}

= Movie Template =
<syntaxhighlight lang="xml" line='line'>
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<movie>
<title></title>
<originaltitle></originaltitle>
<userrating>0</userrating>
<plot></plot>
<mpaa></mpaa>
<uniqueid type="" default="true"></uniqueid> 
<genre></genre>
<tag></tag>
<country></country>
<set>
<name></name>
<overview></overview>
</set>
<credits></credits>
<director></director>
<premiered></premiered> 
<studio></studio>
<actor>
<name></name>
<role></role>
<order></order>
</actor>
</movie>
</syntaxhighlight>

{{collapse top| SAMPLE - Movie nfo file }}
<syntaxhighlight lang="xml">

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<movie>
<title>The King's Man</title>
<originaltitle>The King's Man</originaltitle>
<sorttitle>Kingsman 01</sorttitle>
<ratings>
<rating name="imdb" max="10" default="true">
<value>6.300000</value>
<votes>140619</votes>
</rating>
<rating name="themoviedb" max="10">
<value>6.869000</value>
<votes>3122</votes>
</rating>
<rating name="trakt" max="10">
<value>6.688550</value>
<votes>8059</votes>
</rating>
</ratings>
<userrating>8</userrating>
<top250>0</top250>
<outline></outline>
<plot>As a collection of history's worst tyrants and criminal masterminds gather to plot a war to wipe out millions, one man must race against time to stop them.</plot>
<tagline>Witness the bloody origin.</tagline>
<runtime>130</runtime>
<thumb spoof="" cache="" aspect="poster" preview="">https://image.tmdb.org/t/p/original/nEVjOpekbcdBqAexiWu7zXuFlYU.jpg</thumb>
<thumb spoof="" cache="" aspect="landscape" preview="">https://image.tmdb.org/t/p/original/iBXBqas9DMzesltQEBNM6BH3akt.jpg</thumb>
<thumb spoof="" cache="" aspect="set.poster" preview="">https://image.tmdb.org/t/p/original/xMsRZIkUGUuHsNHCQBDyZH7l53M.jpg</thumb>
<thumb spoof="" cache="" aspect="set.landscape" preview="">https://image.tmdb.org/t/p/original/mkusMBRJyXJCcJ5RKlrKK2SC0Qv.jpg</thumb>
<thumb spoof="" cache="" aspect="set.fanart" preview="">https://image.tmdb.org/t/p/original/3Odw3MJymLLbFuOnmQjmvndKhOr.jpg</thumb>
<thumb spoof="" cache="" aspect="clearlogo" preview="">https://assets.fanart.tv/fanart/movies/476669/hdmovielogo/the-kings-man-601651c77c528.png</thumb>
<thumb spoof="" cache="" aspect="discart" preview="">https://assets.fanart.tv/fanart/movies/476669/moviedisc/the-kings-man-617786bba9b7f.png</thumb>
<thumb spoof="" cache="" aspect="clearart" preview="">https://assets.fanart.tv/fanart/movies/476669/hdmovieclearart/the-kings-man-61c1bf1b46f3b.png</thumb>
<thumb spoof="" cache="" aspect="keyart" preview="">https://assets.fanart.tv/fanart/movies/476669/movieposter/the-kings-man-5f468bd247c3b.jpg</thumb>
<thumb spoof="" cache="" aspect="banner" preview="">https://assets.fanart.tv/fanart/movies/476669/moviebanner/the-kings-man-5e86bd6f81322.jpg</thumb>
<thumb spoof="" cache="" aspect="set.clearlogo" preview="">https://assets.fanart.tv/fanart/movies/391860/hdmovielogo/kingsman-collection-5a69d2e6eaa21.png</thumb>
<thumb spoof="" cache="" aspect="set.keyart" preview="">https://assets.fanart.tv/fanart/movies/391860/movieposter/kingsman-collection-5add0aa47e577.jpg</thumb>
<thumb spoof="" cache="" aspect="set.banner" preview="">https://assets.fanart.tv/fanart/movies/391860/moviebanner/kingsman-collection-5a691aee3c1e1.jpg</thumb>
<fanart>
<thumb colors="" preview="https://image.tmdb.org/t/p/w780/A49NScAT4ZcgeC6HeSvkUPVNJaF.jpg">https://image.tmdb.org/t/p/original/A49NScAT4ZcgeC6HeSvkUPVNJaF.jpg</thumb>
</fanart>
<mpaa>Australia:MA</mpaa>
<playcount>2</playcount>
<lastplayed>2023-06-03</lastplayed>
<id>476669</id>
<uniqueid type="imdb">tt6856242</uniqueid>
<uniqueid type="tmdb" default="true">476669</uniqueid>
<genre>Action</genre>
<country>United Kingdom</country>
<country>USA</country>
<set>
<name>Kingsman Collection</name>
<overview>The story of a super-secret spy organization that recruits an unrefined but promising street kid into the agency's ultra-competitive training program.</overview>
</set>
<tag>BluRay</tag>
<tag>duringcreditsstinger</tag>
<videoassettitle>Standard Edition</videoassettitle>
<videoassetid>40400</videoassetid>
<videoassettype>0</videoassettype>
<hasvideoversions>false</hasvideoversions>
<hasvideoextras>false</hasvideoextras>
<isdefaultvideoversion>true</isdefaultvideoversion>
<credits>Matthew Vaughn</credits>
<credits>Karl Gajdusek</credits>
<director>Matthew Vaughn</director>
<premiered>2021-12-22</premiered>
<year>2021</year>
<status></status>
<code></code>
<aired></aired>
<studio>Marv Films</studio>
<trailer>King's Man (2021)-trailer.mkv</trailer>
<fileinfo>
<streamdetails>
<video>
<codec>h264</codec>
<aspect>1.777778</aspect>
<width>1920</width>
<height>1080</height>
<durationinseconds>7838</durationinseconds>
<stereomode></stereomode>
<hdrtype></hdrtype>
</video>
<audio>
<codec>dtshd_ma</codec>
<language>eng</language>
<channels>8</channels>
</audio>
<subtitle>
<language>eng</language>
</subtitle>
</streamdetails>
</fileinfo>
<actor>
<name>Ralph Fiennes</name>
<role>Orlando Oxford</role>
<order>0</order>
<thumb>https://image.tmdb.org/t/p/original/tJr9GcmGNHhLVVEH3i7QYbj6hBi.jpg</thumb>
</actor>
<actor>
<name>Harris Dickinson</name>
<role>Conrad Oxford</role>
<order>1</order>
<thumb>https://image.tmdb.org/t/p/original/grbjZDzxBHqHYc0V0ic0Y1M38s.jpg</thumb>
</actor>
<actor>
<name>Gemma Arterton</name>
<role>Polly</role>
<order>2</order>
<thumb>https://image.tmdb.org/t/p/original/Alfm28oyHNiYweNCUaMmrVjVMAT.jpg</thumb>
</actor>
<actor>
<name>Rhys Ifans</name>
<role>Grigori Rasputin</role>
<order>3</order>
<thumb>https://image.tmdb.org/t/p/original/AfXRP33ncRunR83JPehZ06Kgh8e.jpg</thumb>
</actor>
<actor>
<name>Djimon Hounsou</name>
<role>Shola</role>
<order>4</order>
<thumb>https://image.tmdb.org/t/p/original/mVJmaJyo6oDGUI9rS7gUJN203Vw.jpg</thumb>
</actor>
<resume>
<position>0.000000</position>
<total>0.000000</total>
</resume>
<dateadded>2022-02-24 17:59:36</dateadded>
</movie>

</syntaxhighlight>
{{collapse bottom}}

; Naming the movie NFO file
:{{#lst:NFO_files/Movies|MovieNFONaming}}

= Music Video Template =
<syntaxhighlight lang="xml" line='line'>
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<musicvideo>
<title></title>
<userrating></userrating>
<track></track>
<album></album>
<plot></plot>
<genre></genre>
<director></director>
<premiered></premiered>
<studio></studio>
<artist></artist>
</musicvideo>
</syntaxhighlight>

{{collapse top| SAMPLE - Music Video nfo file }}
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<musicvideo>
<title>Dancing Queen</title>
<userrating>0</userrating>
<top250>0</top250>
<track>-1</track>
<album>Arrival</album>
<outline></outline>
<plot>Dancing Queen est un des tubes emblématiques de l'ère disco produits par le groupe suédois ABBA en 1976. Ce tube connaît un regain de popularité en 1994 lors de la sortie de Priscilla, folle du désert, et fait « presque » partie de la distribution du film Muriel.
Le groupe a également enregistré une version espagnole de ce titre, La reina del baile, pour le marché d'Amérique latine. On peut retrouver ces versions en espagnol des succès de ABBA sur l'abum Oro. Le 18 juin 1976, ABBA a interprété cette chanson lors d'un spectacle télévisé organisé en l'honneur du roi Charles XVI Gustave de Suède, qui venait de se marier. Le titre sera repris en 2011 par Glee dans la saison 2, épisode 20.</plot>
<tagline></tagline>
<runtime>2</runtime>
<thumb preview="https://www.theaudiodb.com/images/media/album/thumb/arrival-4ee244732bbde.jpg/preview">https://www.theaudiodb.com/images/media/album/thumb/arrival-4ee244732bbde.jpg</thumb>
<thumb preview="https://assets.fanart.tv/preview/music/d87e52c5-bb8d-4da8-b941-9f4928627dc8/albumcover/arrival-548ab7a698b49.jpg">https://assets.fanart.tv/fanart/music/d87e52c5-bb8d-4da8-b941-9f4928627dc8/albumcover/arrival-548ab7a698b49.jpg</thumb>
<mpaa></mpaa>
<playcount>0</playcount>
<lastplayed></lastplayed>
<id></id>
<genre>Pop</genre>
<year>1976</year>
<status></status>
<director>Director 1</director>
<director>Director 2</director>
<director>Director 3</director>
<director>Director 4</director>
<code></code>
<aired></aired>
<trailer></trailer>
<fileinfo>
<streamdetails>
<video>
<codec>hevc</codec>
<aspect>1.792230</aspect>
<width>716</width>
<height>568</height>
<durationinseconds>143</durationinseconds>
<stereomode></stereomode>
</video>
<audio>
<codec>ac3</codec>
<language>eng</language>
<channels>2</channels>
</audio>
</streamdetails>
</fileinfo>
<artist>ABBA</artist>
<resume>
<position>0.000000</position>
<total>0.000000</total>
</resume>
<dateadded>2018-09-10 09:46:06</dateadded>
</musicvideo>

</syntaxhighlight>
{{collapse bottom}}

= tvshow.nfo Template =
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<tvshow>
<title></title>
<plot></plot>
<userrating></userrating>
<mpaa></mpaa>
<uniqueid type="" default="true"></uniqueid> 
<genre></genre>
<premiered></premiered> 
<status></status>
<studio></studio>
<actor>
<name></name>
<role></role>
<order></order>
</actor>
<namedseason number="1"></namedseason>
</tvshow>
</syntaxhighlight>

{{collapse top| SAMPLE - tvshow.nfo file }}
<syntaxhighlight lang="xml">

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<tvshow>
<title>Star Trek: Discovery</title>
<originaltitle>Star Trek: Discovery</originaltitle>
<showtitle>Star Trek: Discovery</showtitle>
<ratings>
<rating name="imdb" max="10" default="true">
<value>7.100000</value>
<votes>111025</votes>
</rating>
<rating name="tmdb" max="10">
<value>7.200000</value>
<votes>1201</votes>
</rating>
<rating name="trakt" max="10">
<value>7.727961</value>
<votes>6830</votes>
</rating>
</ratings>
<userrating>6</userrating>
<top250>0</top250>
<season>4</season>
<episode>55</episode>
<displayseason>-1</displayseason>
<displayepisode>-1</displayepisode>
<outline></outline>
<plot>Follow the voyages of Starfleet on their missions to discover new worlds and new life forms, and one Starfleet officer who must learn that to truly understand all things alien, you must first understand yourself.</plot>
<tagline></tagline>
<runtime>0</runtime>
<thumb spoof="" cache="" aspect="landscape" preview="https://image.tmdb.org/t/p/w780/4TNklRSMAUTCf7g9XGMHxGSeRqR.jpg">https://image.tmdb.org/t/p/original/4TNklRSMAUTCf7g9XGMHxGSeRqR.jpg</thumb>
<thumb spoof="" cache="" aspect="logos" preview="https://image.tmdb.org/t/p/w780/nYlsrSp5c2d7NbEtMgsc3lJUrGx.png">https://image.tmdb.org/t/p/original/nYlsrSp5c2d7NbEtMgsc3lJUrGx.png</thumb>
<thumb spoof="" cache="" aspect="poster" preview="https://image.tmdb.org/t/p/w780/zh7GLsorxecv0D8d7QAVkQUe1ju.jpg">https://image.tmdb.org/t/p/original/zh7GLsorxecv0D8d7QAVkQUe1ju.jpg</thumb>
<thumb spoof="" cache="" aspect="banner" preview="https://assets.fanart.tv/... deleted">https://assets.fanart.tv/fanart/tv/328711/tvbanner/star-trek-discovery-5b0db4d349720.jpg</thumb>
<thumb spoof="" cache="" aspect="clearlogo" preview="https://assets.fanart.tv/... deleted">https://assets.fanart.tv/fanart/tv/328711/hdtvlogo/star-trek-discovery-59cb169256e4e.png</thumb>
<thumb spoof="" cache="" aspect="clearart" preview="https://assets.fanart.tv/... deleted">https://assets.fanart.tv/fanart/tv/328711/hdclearart/star-trek-discovery-5bcd2af85c610.png</thumb>
<thumb spoof="" cache="" aspect="landscape" preview="https://assets.fanart.tv/... deleted">https://assets.fanart.tv/fanart/tv/328711/tvthumb/star-trek-discovery-59541dab33126.jpg</thumb>
<thumb spoof="" cache="" aspect="characterart" preview="https://assets.fanart.tv/... deleted">https://assets.fanart.tv/fanart/tv/328711/characterart/star-trek-discovery-59cc59092af97.png</thumb>
<thumb spoof="" cache="" season="0" type="season" aspect="poster" preview="https://image.tmdb.org/t/p... deleted">https://image.tmdb.org/t/p/original/pZxMTBheuGwNBQxF5JzLp2hHdDs.jpg</thumb>
<thumb spoof="" cache="" season="1" type="season" aspect="poster" preview="https://image.tmdb.org/t/p... deleted">https://image.tmdb.org/t/p/original/eD0gvrU9pyicetxBJ1YLf557XeW.jpg</thumb>
<thumb spoof="" cache="" season="2" type="season" aspect="poster" preview="https://image.tmdb.org/t/p... deleted">https://image.tmdb.org/t/p/original/yLG5DFbf4nv6Cm8GRwwWREET2VA.jpg</thumb>
<thumb spoof="" cache="" season="3" type="season" aspect="poster" preview="https://image.tmdb.org/t/p... deleted">https://image.tmdb.org/t/p/original/izoaRR70PCvF1c1amaRpgkEfWXp.jpg</thumb>
<thumb spoof="" cache="" season="4" type="season" aspect="poster" preview="https://image.tmdb.org/t/p... deleted">https://image.tmdb.org/t/p/original/zh7GLsorxecv0D8d7QAVkQUe1ju.jpg</thumb>
<fanart>
<thumb colors="" preview="">https://image.tmdb.org/t/p/original/kHwMIXsYNAg8eoJvj97F0LSlyDP.jpg</thumb>
<thumb colors="" preview="">https://image.tmdb.org/t/p/original/p3McpsDNTNmpbkNBKdNxOFZJeKX.jpg</thumb>
</fanart>
<mpaa>Australia:M</mpaa>
<playcount>0</playcount>
<lastplayed>2021-08-27</lastplayed>
<id>67198</id>
<uniqueid type="imdb">tt5171438</uniqueid>
<uniqueid type="tmdb" default="true">67198</uniqueid>
<uniqueid type="tvdb">328711</uniqueid>
<genre>Science Fiction</genre>
<premiered>2017-09-24</premiered>
<year>2017</year>
<status>Continuing</status>
<code></code>
<aired></aired>
<studio>CBS All Access</studio>
<trailer>J:\TV Complete LZ\Star Trek Discovery (2017)\Star Trek Discovery (2017)-trailer.m2ts</trailer> 
<actor>
<name>Sonequa Martin-Green</name>
<role>Michael Burnham</role>
<order>0</order>
<thumb>https://image.tmdb.org/t/p/original/anz0LIPc0KarbDwLOyGt21eolvK.jpg</thumb>
</actor>
<actor>
<name>Doug Jones</name>
<role>Saru</role>
<order>1</order>
<thumb>https://image.tmdb.org/t/p/original/rpvvWATYWHGjedJea0G97XufOwU.jpg</thumb>
</actor>
<actor>
<name>Jason Isaacs</name>
<role>Gabriel Lorca</role>
<order>3</order>
<thumb>https://image.tmdb.org/t/p/original/nlim5RpNgpNcN0BWhhOCWmaMEHI.jpg</thumb>
</actor>
<namedseason number="1">Season 1</namedseason>
<namedseason number="2">Season 2</namedseason>
<namedseason number="3">Season 3</namedseason>
<namedseason number="4">Season 4</namedseason>
<resume>
<position>0.000000</position>
<total>0.000000</total>
</resume>
<dateadded>2022-03-18 14:14:36</dateadded>
</tvshow>

</syntaxhighlight>
{{collapse bottom}}

= Episode Template =
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<episodedetails>
<title></title>
<season>1</season> 
<episode>2</episode> 
<userrating></userrating>
<plot></plot>
<uniqueid type="" default="true"></uniqueid> 
<credits></credits>
<director></director>
<aired></aired> 
<actor>
<name></name>
<role></role>
<order></order>
</actor>
</episodedetails>
</syntaxhighlight>

{{collapse top| SAMPLE - episode.nfo file }}
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<episodedetails>
<title>Filmed Before a Live Studio Audience</title>
<showtitle>WandaVision</showtitle>
<ratings>
<rating name="imdb" max="10" default="true">
<value>7.500000</value>
<votes>18766</votes>
</rating>
<rating name="tmdb" max="10">
<value>7.500000</value>
<votes>42</votes>
</rating>
<rating name="trakt" max="10">
<value>6.952780</value>
<votes>3621</votes>
</rating>
</ratings>
<userrating>0</userrating>
<top250>0</top250>
<season>1</season>
<episode>1</episode>
<displayseason>-1</displayseason>
<displayepisode>-1</displayepisode>
<outline></outline>
<plot>Wanda and Vision struggle to conceal their powers during dinner with Vision’s boss and his wife.</plot>
<tagline></tagline>
<runtime>26</runtime>
<thumb spoof="" cache="" aspect="thumb" preview="https://image.tmdb.org/t/p/w780/cbe8l0Hnbvu07ePgoOopyWYrcdL.jpg">https://image.tmdb.org/t/p/original/cbe8l0Hnbvu07ePgoOopyWYrcdL.jpg</thumb>
<thumb spoof="" cache="" aspect="thumb" preview="https://image.tmdb.org/t/p/w780/oNCzeCXFanVEWNpzRzyffhLLfZs.jpg">https://image.tmdb.org/t/p/original/oNCzeCXFanVEWNpzRzyffhLLfZs.jpg</thumb>
<mpaa>Australia:TV-14</mpaa>
<playcount>1</playcount>
<lastplayed>2021-03-27</lastplayed>
<id>1830976</id>
<uniqueid type="imdb">tt9601584</uniqueid>
<uniqueid type="tmdb" default="true">1830976</uniqueid>
<uniqueid type="tvdb">8042515</uniqueid>
<genre>Sci-Fi & Fantasy</genre>
<genre>Mystery</genre>
<genre>Drama</genre>
<credits>Jac Schaeffer</credits>
<director>Matt Shakman</director>
<premiered>2021-01-15</premiered>
<year>2021</year>
<status></status>
<code></code>
<aired>2021-01-15</aired>
<studio>Disney+ (US)</studio>
<trailer></trailer>
<fileinfo>
<streamdetails>
<video>
<codec>h264</codec>
<aspect>1.777778</aspect>
<width>1280</width>
<height>720</height>
<durationinseconds>1593</durationinseconds>
<stereomode></stereomode>
</video>
<audio>
<codec>aac</codec>
<language>eng</language>
<channels>2</channels>
</audio>
</streamdetails>
</fileinfo>
<actor>
<name>Randall Park</name>
<role>Jimmy Woo</role>
<order>4</order>
<thumb>https://image.tmdb.org/t/p/original/1QJ4cBQZoOaLR8Hc3V2NgBLvB0f.jpg</thumb>
</actor>
<actor>
<name>Kat Dennings</name>
<role>Darcy Lewis / The Escape Artist</role>
<order>5</order>
<thumb>https://image.tmdb.org/t/p/original/rrfyo9z1wW5nY9ZsFlj1Ozfj9g2.jpg</thumb>
</actor>
<resume>
<position>0.000000</position>
<total>0.000000</total>
</resume>
<dateadded>2021-02-02 11:57:44</dateadded>
</episodedetails>

</syntaxhighlight>
{{collapse bottom}}

{{collapse top| SAMPLE - multi-episode.nfo file }}

<syntaxhighlight lang="xml">

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<episodedetails> 
<title>Grieve No More</title>
<showtitle>Carnival Row</showtitle>
<ratings>
<rating name="imdb" max="10" default="true">
<value>7.800000</value>
<votes>1746</votes>
</rating>
<rating name="tmdb" max="10">
<value>7.700000</value>
<votes>15</votes>
</rating>
</ratings>
<userrating>0</userrating>
<top250>0</top250>
<season>1</season>
<episode>5</episode>
<displayseason>-1</displayseason>
<displayepisode>-1</displayepisode>
<outline></outline>
<plot>Philo consults a Haruspex in an effort to find clues about the killer. Vignette grows closer with her newfound family. Upon Jonah’s return home, his parents cast a more watchful eye over him as a new player makes a splash in Parliament. Imogen brings Agreus into her circle.</plot>
<tagline></tagline>
<runtime>0</runtime>
<thumb spoof="" cache="" aspect="thumb" preview="https://image.tmdb.org/t/p/w780/mcVI7yQjXmreUQcyxRJ3dFTFszI.jpg">https://image.tmdb.org/t/p/original/mcVI7yQjXmreUQcyxRJ3dFTFszI.jpg</thumb>
<thumb spoof="" cache="" aspect="thumb" preview="https://image.tmdb.org/t/p/w780/6Mf23JoPQsj2deyvrKMCZEvgyB4.jpg">https://image.tmdb.org/t/p/original/6Mf23JoPQsj2deyvrKMCZEvgyB4.jpg</thumb>
<mpaa>Australia:TV-MA</mpaa>
<playcount>0</playcount>
<lastplayed></lastplayed>
<id>1906721</id>
<uniqueid type="imdb">tt6599052</uniqueid>
<uniqueid type="tmdb" default="true">1906721</uniqueid>
<uniqueid type="tvdb">7221242</uniqueid>
<genre>Sci-Fi & Fantasy</genre>
<credits>Ian Deitchman</credits>
<credits>Kristin Rusk Robinson</credits>
<director>Andy Goddard</director>
<premiered>2019-08-29</premiered>
<year>2019</year>
<status></status>
<code></code>
<aired>2019-08-29</aired>
<studio>Amazon</studio>
<trailer></trailer>
<actor>
<name>Orlando Bloom</name>
<role>Rycroft "Philo" Philostrate</role>
<order>0</order>
<thumb>https://image.tmdb.org/t/p/original/pulwUR0lZ8IWwXUCRXCnyWfYvNL.jpg</thumb>
</actor>
<actor>
<name>Cara Delevingne</name>
<role>Vignette Stonemoss</role>
<order>1</order>
<thumb>https://image.tmdb.org/t/p/original/izZ8IbsIjNpjZ5S0HIYreVwVRzn.jpg</thumb>
</actor>
<resume>
<position>0.000000</position>
<total>0.000000</total>
</resume>
<dateadded>2021-12-30 15:41:30</dateadded>
</episodedetails>
<episodedetails> 
<title>Unaccompanied Fae</title>
<showtitle>Carnival Row</showtitle>
<ratings>
<rating name="imdb" max="10" default="true">
<value>7.900000</value>
<votes>1627</votes>
</rating>
<rating name="tmdb" max="10">
<value>7.500000</value>
<votes>15</votes>
</rating>
</ratings>
<userrating>0</userrating>
<top250>0</top250>
<season>1</season>
<episode>6</episode>
<displayseason>-1</displayseason>
<displayepisode>-1</displayepisode>
<outline></outline>
<plot>The pieces of the puzzle start to come together for Philo. Vignette finds home in a place she never expected. Jonah sneaks off to see someone he shouldn’t. Imogen and Agreus step out together in public.</plot>
<tagline></tagline>
<runtime>0</runtime>
<thumb spoof="" cache="" aspect="thumb" preview="https://image.tmdb.org/t/p/w780/y6A3ZXbSBoc3HwBj1J3KWWvrrzW.jpg">https://image.tmdb.org/t/p/original/y6A3ZXbSBoc3HwBj1J3KWWvrrzW.jpg</thumb>
<thumb spoof="" cache="" aspect="thumb" preview="https://image.tmdb.org/t/p/w780/7gZBOfmfAxkUpd4jL9WS6p78EoH.jpg">https://image.tmdb.org/t/p/original/7gZBOfmfAxkUpd4jL9WS6p78EoH.jpg</thumb>
<mpaa>Australia:TV-MA</mpaa>
<playcount>0</playcount>
<lastplayed></lastplayed>
<id>1906722</id>
<uniqueid type="imdb">tt6599058</uniqueid>
<uniqueid type="tmdb" default="true">1906722</uniqueid>
<uniqueid type="tvdb">7221243</uniqueid>
<genre>Sci-Fi & Fantasy</genre>
<credits>Stephanie K. Smith</credits>
<director>Andy Goddard</director>
<premiered>2019-08-29</premiered>
<year>2019</year>
<status></status>
<code></code>
<aired>2019-08-29</aired>
<studio>Amazon</studio>
<trailer></trailer>
<actor>
<name>Leanne Best</name>
<role>Madame Moira</role>
<order>4</order>
<thumb>https://image.tmdb.org/t/p/original/3GJSWDGuINZjQEgz06wlBELoJCK.jpg</thumb>
</actor>
<actor>
<name>Issy Stewart</name>
<role>Louisa Pembroke</role>
<order>6</order>
<thumb>https://image.tmdb.org/t/p/original/2Ektp4uatPA6gZj32xjjPWKZBKm.jpg</thumb>
</actor>
<resume>
<position>0.000000</position>
<total>0.000000</total>
</resume>
<dateadded>2021-12-30 15:41:30</dateadded>
</episodedetails>
<episodedetails> 
<title>The World to Come</title>
<showtitle>Carnival Row</showtitle>
<ratings>
<rating name="imdb" max="10" default="true">
<value>8.000000</value>
<votes>1659</votes>
</rating>
<rating name="tmdb" max="10">
<value>7.700000</value>
<votes>15</votes>
</rating>
</ratings>
<userrating>0</userrating>
<top250>0</top250>
<season>1</season>
<episode>7</episode>
<displayseason>-1</displayseason>
<displayepisode>-1</displayepisode>
<outline></outline>
<plot>Because he withheld evidence from his fellow detectives, Philo is accused of being the man behind the string of murders and is thrown in jail. There, he finds some unexpected help from Vignette. Elsewhere, Ezra takes exception to Imogen’s relationship with Agreus. Sophie offers Jonah a deal.</plot>
<tagline></tagline>
<runtime>0</runtime>
<thumb spoof="" cache="" aspect="thumb" preview="https://image.tmdb.org/t/p/w780/ov05qVU8JVZ66BQK457MLMg7Wfu.jpg">https://image.tmdb.org/t/p/original/ov05qVU8JVZ66BQK457MLMg7Wfu.jpg</thumb>
<mpaa>Australia:TV-MA</mpaa>
<playcount>0</playcount>
<lastplayed></lastplayed>
<id>1906725</id>
<uniqueid type="imdb">tt7435152</uniqueid>
<uniqueid type="tmdb" default="true">1906725</uniqueid>
<uniqueid type="tvdb">7221244</uniqueid>
<genre>Sci-Fi & Fantasy</genre>
<credits>Peter Cameron</credits>
<credits>René Echevarria</credits>
<director>Jon Amiel</director>
<premiered>2019-08-29</premiered>
<year>2019</year>
<status></status>
<code></code>
<aired>2019-08-29</aired>
<studio>Amazon</studio>
<trailer></trailer>
<actor>
<name>Jonathan Daniel Brown</name>
<role>Ticket Clerk</role>
<order>48</order>
<thumb>https://image.tmdb.org/t/p/original/xDsPJNDnrn3N0jelVrxdOchzhoo.jpg</thumb>
</actor>
<actor>
<name>John Poston</name>
<role>Cell Block Guard</role>
<order>49</order>
<thumb></thumb>
</actor>
<resume>
<position>0.000000</position>
<total>0.000000</total>
</resume>
<dateadded>2021-12-30 15:41:30</dateadded>
</episodedetails>

</syntaxhighlight>
{{collapse bottom}}

{{top}}
{{updated|20}}

[[Category:Karellen]]
[[Category:Music library]]
[[Category:Video library]]

Advancedsettings.xml

2025-12-14T09:47:20Z

Karellen: /* Library artwork */

{{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|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>}}
# On some platforms it will be easier to copy, move or delete this file by using the built-in '''[[File_manager|File Manager]]''' tool accessible in the '''[[Settings]]''' screen.

== Layout ==

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

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

where "setting" gives the name of the setting, and "value" gives its value.

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

= List of available settings =
List of available settings that are recognised in the advancedsettings.xml file <ref>https://github.com/xbmc/xbmc/blob/master/xbmc/settings/AdvancedSettings.cpp</ref>

Recommended: Use the table of contents or the search function in your browser to locate items.

== Troubleshooting settings ==

=== loglevel ===
{{Anchor|.3Cloglevel.3E}}

<section begin="loglevel" />
Sets the logging level used to log errors and information. The "hide" attribute is optional.

<syntaxhighlight lang=xml>
<loglevel hide="attribute">options</loglevel>
</syntaxhighlight>

{| class="mw-collapsible mw-collapsed wikitable"
|-
! style="width:100px;" | Attribute
! style="width:500px;" | Action
|-
! '''true'''
| Hides the "enable debugging" setting in the Settings page. (default)
|-
! '''false'''
| Allows "enable debugging" setting to switch between '''0''' and '''2'''.
|}

{| class="mw-collapsible mw-collapsed wikitable"
|-
! style="width:100px;" | Option
! style="width:500px;" | Action
|-
! '''-1'''
| No logging, suppresses all log output
|-
! '''0'''
| Normal logging, only logging errors (default)
|-
! '''1'''
| Debug logging with freemem, fps and cpu usage (no on screen)
|-
! '''2'''
| Same as 1 (with on screen display)
|-
! '''3'''
| Same as 1 + full smb logging
|}

{| class="wikitable"
|-
! style="width:100px;" | Example
! style="width:500px;" |
|-
! Example 1:
|<syntaxhighlight lang=xml enclose="div">
<advancedsettings version="1.0">
<loglevel>2</loglevel>
</advancedsettings>
</syntaxhighlight>
|-
! Example 2:
|<syntaxhighlight lang=xml enclose="div">
<advancedsettings version="1.0">
<loglevel hide="true">2</loglevel>
</advancedsettings>
</syntaxhighlight>
|}

'''Note:''' The setting is persistent through shutdown and restarts.<br>
'''Note:''' If debugging is enabled in the GUI, loglevel will be set to '''2'''. This will over-ride the <code>advancedsettings.xml</code> setting. You must disable the GUI Setting before adding the entry to <code>advancedsettings.xml</code>.<br />
<section end="loglevel" />
:''{{see also|Log_file|label 1=Debug Log}}''

=== jsonrpc ===
{{Anchor|.3Cjsonrpc.3E}}
To make it easier for developers using the [[JSON-RPC_API]] 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>

== Audio/video playback settings ==

=== skiploopfilter ===
{{anchor|.3Cskiploopfilter.3E}}
The amount of the loop filter to skip on h.264 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
* 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}}

The <video> section also includes the following child-tags, which have their own sections:
*[[#cleandatetime]]
*[[#cleanstrings]]
*[[#excludefromscan]]
*[[#excludefromlisting]]
*[[#excludetvshowsfromscan]]

{{note|Some tags that have a "third-level" and are grouped together are highlighted in color.}}

{| class="prettytable"
! Tag !! Description
|-
|
<syntaxhighlight lang=xml>
<video>
</syntaxhighlight>
| Parent tag that all other child tags need to be placed inside of. Do not use more than one '''<code><video></code>''' tag, but instead place all other child-tags within a single '''<code><video></video></code>''' set.
|-
|
<syntaxhighlight lang=xml>
<subsdelayrange>10</subsdelayrange>
</syntaxhighlight>
| Delay range for subtitles, in seconds.
|-
|
<syntaxhighlight lang=xml>
<maxtempo>2.1</maxtempo>
</syntaxhighlight>
| Allow further increase of playback speed over the default of 1.5<br>
maxtempo must be in the range of 1.5 to 2.1 <br>
Be aware of the limitations of your platform / hardware as not all are capable of the increased maxtempo <ref>https://forum.kodi.tv/showthread.php?tid=10023&pid=2795069#pid2795069</ref>
|-
|
<syntaxhighlight lang=xml>
<audiodelayrange>10</audiodelayrange>
</syntaxhighlight>
| Delay range for audio/video sync, in seconds.
|-
|
<syntaxhighlight lang=xml>
<usetimeseeking>true</usetimeseeking>
</syntaxhighlight>
| Whether to use time based or percentage based seeking. {{small see also|Skip steps}}
|-
|
<syntaxhighlight lang=xml>
<timeseekforwardbig>600</timeseekforwardbig>
<timeseekbackwardbig>-600</timeseekbackwardbig>
</syntaxhighlight>
| Time to seek forward in seconds when doing a long seek. Defaults to 600 (10 minutes) and -600 (-10 minutes) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<percentseekforward>2</percentseekforward>
<percentseekbackward>-2</percentseekbackward>
</syntaxhighlight>
| Amount to seek forward as a percentage, when doing a short seek. Defaults to 2 (2%) and -2 (2%) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<percentseekforwardbig>10</percentseekforwardbig>
<percentseekbackwardbig>-10</percentseekbackwardbig>
</syntaxhighlight>
| Amount to seek forward as a percentage, when doing a long seek. Defaults to 10 (10%) and -10 (10%) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<fullscreenonmoviestart>true</fullscreenonmoviestart>
</syntaxhighlight>
| Whether to go to fullscreen or not when starting a movie. Defaults to true.
|-
|
<syntaxhighlight lang=xml>
<defaultplayer>VideoPlayer</defaultplayer>
</syntaxhighlight>
| Set the default video player: VideoPlayer or an external player. See '''[[External players]]''' for more info.
|-
|
<syntaxhighlight lang=xml>
<excludefromscan>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromscan>
</syntaxhighlight>
| Regular expressions that if evaluated to true won't be added to library. It is possible to add multiple <code><regexp></code> tags to match multiple patterns
|-
|
<syntaxhighlight lang=xml>
<excludefromlisting>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromlisting>
</syntaxhighlight>
| Regular expressions that if evaluated to true won't be displayed in files view.
|-
|
<syntaxhighlight lang=xml>
<playcountminimumpercent>90</playcountminimumpercent>
</syntaxhighlight>
| Minimum percentage that has to be played before it is marked as watched. Set to 101 to never auto-mark items as watched. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<ignoresecondsatstart>180</ignoresecondsatstart>
</syntaxhighlight>
| Number of seconds to ignore at video start after which a resume point is created. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<ignorepercentatend>8</ignorepercentatend>
</syntaxhighlight>
| Percentage of video to ignore at the end. If you stop watching the video here no resume point is created. Set to 101 to never save a resume point. The video is already marked as watched at 90%, see above. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<vdpauscaling>true</vdpauscaling>
</syntaxhighlight>
| Scales with vdpau instead of opengl and turns on its HQ scaler when available, enabling this might slow down rendering and cause framedrops especially on ION systems, this setting requires a vdpau feature set C GPU.
|-
|
<syntaxhighlight lang=xml>
<ppffmpegdeinterlacing>linblenddeint</ppffmpegdeinterlacing>
</syntaxhighlight>
| Override the deinterlacing options passed to libpostproc.
|-
|
<syntaxhighlight lang=xml>
<ppffmpegpostprocessing>ha:128:7,va,dr</ppffmpegpostprocessing>
</syntaxhighlight>
| Override the post processing options passed to libpostproc when 'Video post-processing' is activated in GUI Videos-Settings-Playback.
|-
|
<syntaxhighlight lang=xml>
<autoscalemaxfps>30</autoscalemaxfps>
</syntaxhighlight>
| When scaling method is set to auto, bilinear is chosen when the fps is higher than this limit, the default is 30.
|-
|
<syntaxhighlight lang=xml>
<adjustrefreshrate>
</syntaxhighlight>
| style="background:#CADCFB;" | Settings for when "Adjust refreshrate to match video fps" is enabled in the video playback GUI settings.
|-
|
<syntaxhighlight lang=xml>
<override>
<fps>23.976</fps>
<refresh>60.0</refresh>
</override>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' "Adjust refreshrate to match video fps" will try to select the best refreshrate for the video fps but it doesn't always get it right, for example it might switch to an unsupported refreshrate. You can add overrides here to switch to a certain refreshrate based on video fps. It's possible to add as many overrides as you need. Overrides are processed in order, if the first one doesn't match the fps or no refreshrates match that override, it will try the next one until no overrides are left.

* '''fps''' - if the fps is between 23.966 and 23.986
* '''refresh''' - switch to the first found refreshrate that is between 59.99 and 60.01
|-
|
<syntaxhighlight lang=xml>
<override>
<fpsmin>29.96</fpsmin>
<fpsmax>30.01</fpsmax>
<refreshmin>59.0</refreshmin>
<refreshmax>61.0</refreshmax>
</override>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -'''
* '''fpsmin''' / '''fpsmin''' - You can also specify the fps range yourself.
* '''refreshmin''' / '''refreshmax''' - Same for the refreshrate
|-
|
<syntaxhighlight lang=xml>
<fallback>
<refresh>50.0</refresh>
</fallback>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' If none of the overrides match, or none of the refreshrates match any of the fps matching overrides, it will choose a fallback refreshrate. Fallbacks are process in order, if the first fallback doesn't match any refreshrate, it will try the next one until no fallbacks are left.

* '''refresh''' - Switch to the first found refreshrate that is between 49.99 and 50.01.
|-
|
<syntaxhighlight lang=xml>
<fallback>
<refreshmin>49.0</refreshmin>
<refreshmax>51.0</refreshmax>
</fallback>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' You can also specify the range for the fallback yourself.

If none of the overrides match the video fps, or no refreshrates match any of the fps matching overrides, and no fallbacks are specified or no refreshrates match any fallbacks, it will automatically choose the best refreshrate (same as having no overrides and fallbacks).
|-
|
<syntaxhighlight lang=xml>
</adjustrefreshrate>
</syntaxhighlight>
| style="background:#CADCFB;" |
|-
|
<syntaxhighlight lang=xml>
<checkdxvacompatibility>value</checkdxvacompatibility>
</syntaxhighlight>
| Advanced setting not present: let Kodi autodetect cards that support H.264 profile > L4.1. Set value to false to enable DXVA no matter what. Set value to true if Kodi doesn't autodetect that the graphics card doesn't support > L4.1.
|-
|
<syntaxhighlight lang=xml>
<useocclusionquery>-1</useocclusionquery>
</syntaxhighlight>
| Use an occlusion query when capturing videoframes, -1 means auto detect, 0 means disabled, 1 means enabled, the default is -1.
|-
|
<syntaxhighlight lang=xml>
<fpsdetect>1</fpsdetect>
</syntaxhighlight>
| FPS detection for video playback
* 0 = trust codec fps
* 1 = recalculate from video timestamps with uniform spacing
* 2 = recalculate from video timestamps always
|-
|
<syntaxhighlight lang=xml>
<latency>
<delay>0</delay>
<hdrextradelay>0</hdrextradelay>
<refresh>
<min></min>
<max></max>
<rate></rate>
<delay></delay>
<hdrextradelay></hdrextradelay>
</refresh>
</latency>
</syntaxhighlight>
| '''Latency''' helps correct audio/video synchronization (lip-sync) when the display's internal processing introduces noticeable delays in the display of the pictures. The optional overrides and hdr extra delay offer further fine-tuning when the delay is not the same for all refresh rates or the HDR vs SDR modes. Latency is given in milliseconds. For one-off adjustments use the OSD during playback to adjust audio synchronisation.<br/><br/>
'''<delay>''' - Global default display latency.<br>
'''<hdrextradelay>''' - Global default latency added to the global default display latency when the display is in any HDR mode. Note: the display HDR mode is not detected on all platforms (Windows-only at time of writing).<br>
'''<refresh>''' - Override latency for given display (not video) refresh rates. When Kodi is in windowed mode, override is ignored. Multiple overrides are allowed.<br>
'''<min>''', '''<max>''' - refresh rate range, OR<br>
'''<rate>''' - exact refresh rate<br>
'''<delay>''' - display latency for the given refresh rate<br>
'''<hdrextradelay>''' - additional latency when the display is in any HDR mode for the given refresh rate<br>
<br/>
'''Example:''' The following example sets display latency of 125 msec at 23-24 Hz
<syntaxhighlight lang=xml>
<refresh>
<min>23</min>
<max>24</max>
<delay>125</delay>
</refresh>
</syntaxhighlight>
<br/>
'''Example:''' The following example sets display latency of 50 msec at 50 (+/-0.01) Hz
<syntaxhighlight lang=xml>
<refresh>
<rate>50</rate>
<delay>50</delay>
</refresh>
</syntaxhighlight>

|-
|
<syntaxhighlight lang=xml>
<stereoscopicregex3d>[-. _]3d[-. _]</stereoscopicregex3d>
<stereoscopicregexsbs>[-. _]h?sbs[-. _]</stereoscopicregexsbs>
<stereoscopicregextab>[-. _]h?tab[-. _]</stereoscopicregextab>
</syntaxhighlight>
| Filename triggers for 3D (stereoscopic) mode.
|-
|
<syntaxhighlight lang=xml>
<assfixedworks>false</assfixedworks>
</syntaxhighlight>
| Position behavior of ass subtitiles when setting "subtitle position on screen" set to "fixed". True to show at the fixed position set in video calibration. False to show at the bottom of video (default). {{note|Removed in Kodi v20.}}
|-
|
<syntaxhighlight lang=xml>
<subtitleverticalmargin>120</subtitleverticalmargin>
</syntaxhighlight>
| Allows to customise the vertical margin of text based subtitles, which will be applied to each type of subtitle position in subtitle settings. {{note|Available in Kodi v20 and above.}}
|-
|
<syntaxhighlight lang=xml>
</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>

<usetimeseeking>true</usetimeseeking>

<timeseekforwardbig>600</timeseekfowardbig>

<timeseekbackwardbig>-600</timeseekbackward>

<playcountminimumpercent>99</playcountminimumpercent>

<applydrc>-1.0</applydrc>

<limiterhold>0.025</limiterhold>

<limiterrelease>0.1</limiterrelease>

<maxpassthroughoffsyncduration>10</maxpassthroughoffsyncduration>

<allowmultichannelfloat>false</allowmultichannelfloat>

<superviseaudiodelay>false</superviseaudiodelay>
</audio>
</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

=== edl ===
{{anchor|.3Cedl.3E}}
{{main|Edit_decision_list}}
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>


<displaycommbreaknotifications>false</displaycommbreaknotifications>
</edl>
</syntaxhighlight>
'''Notes:'''
* displaycommbreaknotifications<ref>https://github.com/xbmc/xbmc/pull/20711</ref>

== PVR & Live TV ==
{{anchor|.3Cpvr.3E}}
Settings available for PVR, EPG and Live TV. Edit Decision List settings are located in the previous section.

=== pvr ===
<syntaxhighlight lang="xml" line='line'>
<pvr>
<timecorrection>0</timecorrection> 
<infotoggleinterval>3000</infotoggleinterval> 
<channeliconsautoscan>true</channeliconsautoscan> 
<autoscaniconsuserset>false</autoscaniconsuserset> 
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> 
</pvr>
</syntaxhighlight>

==== pvrrecordings ====
In v19 and later, allows users to modify sort type and order of pvr recordings. <ref>https://github.com/xbmc/xbmc/pull/18605</ref>

;Note- These settings are child tags to the ''<pvr>'' tag in the previous section.

<syntaxhighlight lang="xml" line='line'>
<pvr>
<pvrrecordings>
<sortmethod>2</sortmethod> 
<sortorder>2</sortorder> 
</pvrrecordings>
</pvr>
</syntaxhighlight>

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

== 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>
.001 .3g2 .3gp .asf .asx .avc .avi .avs .bdm .bdmv .bin .bivx .dat .divx .dv .dvr-ms .evo .fli .flv .f4v
.h264 .ifo .img .iso .m2t .m2ts .m2v .m3u .m3u8 .m4v .mkv .mk3d .mov .mp4 .mpd .mpeg .mpg .mpl .mpls .mts
.nrg .nsv .nuv .ogm .ogv .pls .pva .pxml .qt .rcv .rec .rm .rmvb .rss .sdp .strm .svq3 .tp .trp .ts .ty
.url .udf .vc1 .vdr .viv .vob .vp3 .webm .wmv .wpl .wtv .xsp .xspf .xvid .zip
</pre>
Examples:
<pre>
<videoextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</videoextensions>
</pre>
<section end="videoextensions" />

=== discstubextensions ===
{{main|Media stubs}}

<section begin="discstubextensions" />
The default filename extension for Disc Stubs is:
<syntaxhighlight lang=xml enclose="div">
.disc
</syntaxhighlight>
Using the following tags, it is possible to <tt><add></tt> additional or <tt><remove></tt> existing disc stub extensions to better suit your requirements.
<syntaxhighlight lang=xml enclose="div">
<discstubextensions>
<add>.disk|.stub</add>
<remove>.disc</remove>
</discstubextensions>
</syntaxhighlight>
<section end="discstubextensions" />

=== languagecodes ===
{{anchor|.3Clanguagecodes.3E}}
User-defined translation table for language codes used in subtitles and audio.
It can be used to add, extend or override Kodi's language codes.

'''How to add a new language code:'''

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

'''How to add a new language code with subtag (e.g. pt-BR):'''
{{note|This support is available from Kodi v20}}

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>pt-BR</short>
<long>Portuguese - Brazil</long>
</code>
</languagecodes>
</syntaxhighlight>

''NOTE FOR MKV FILES:''<br/>
MKV files that contain audio/subtitle tracks with language codes with subtags are not yet supported, but from <code>Kodi v21</code> a workaround was introduced that allows Kodi to recognize language codes with subtags.
To use the workaround, you must open the MKV file with an editor and in the metadata of the desired audio/subtitle track, edit the track Name (or Title field) by adding the language code wrapped in curly brackets, as in following example:
<br/><code>Original track name: Audio portuguese/brazil</code>
<br/><code>Modified track name: Audio portuguese/brazil {pt-BR}</code>

'''How to extend an existing language code:'''

Set the same "long" description of the existing language, for example we reuse the Portughese language for another language code:

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>pt-BR</short>
<long>Portuguese</long>
</code>
</languagecodes>
</syntaxhighlight>

In this case when in Kodi settings you set the "Portuguese" language, when in playing according to availability the track "pt" or "pt-BR" will be chosen.

'''How to override an existing language code:'''

This allow you to rename an existing language. Set to an existing language code your preferred "long" name description.

''WARNING: This can cause problems with add-ons, so do not override languages if you are not aware of the side effects.''

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>en</short>
<long>English example</long>
</code>
<code>
<short>en-GB</short>
<long>English example</long>
</code>
</languagecodes>
</syntaxhighlight>

=== moviestacking ===
{{anchor|.3Cmoviestacking.3E}}<section begin="moviestacking" />
{{main|Naming_video_files/Movies}}
This is used by the [[Naming_video_files/Movies#Split_Video_Files|file stacking]] algorithm to combine multi-part files and contains a list of 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|Naming_video_files/Movies}}
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

Default expression:
<syntaxhighlight lang=xml enclose="div">
<video>
<cleandatetime>(.*[^ _\,\.\[\]\-])[ _\.\[\]\-]+(19[0-9][0-9]|20[0-9][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 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.

{{Github_link|[https://github.com/xbmc/xbmc/blob/Nexus/xbmc/settings/AdvancedSettings.cpp#L201-L211 Code in Github]}}

Default expressions:
<syntaxhighlight lang=xml enclose="div">
<video>
<cleanstrings>
<regexp>([ _\\,\\.\$\$\\[\\]\\-](10bit|480p|480i|576p|576i|720p|720i|1080p|1080i|2160p|3d|aac|ac3|aka|atmos|avi|bd5|bdrip|bluray|brrip|cam|cd[1-9]|custom|dc|ddp|divx|divx5|dolbydigital|dolbyvision|dsr|dsrip|dts|dts-hdma|dts-hra|dts-x|dv|dvd|dvd5|dvd9|dvdivx|dvdrip|dvdscr|dvdscreener|extended|fragment|fs|h264|h265|hdr|hdr10|hevc|hddvd|hdrip|hdtv|hdtvrip|hrhd|hrhdtv|internal|limited|multisubs|nfofix|ntsc|ogg|ogm|pal|pdtv|proper|r3|r5|read.nfo|remastered|remux|repack|rerip|retail|screener|se|svcd|tc|telecine|telesync|truehd|ts|uhd|unrated|ws|x264|x265|xvid|xvidvd|xxx|web-dl|webrip|www.www|\\[.*\\])([ _\\,\\.\$\$\\[\\]\\-]|$)");</regexp>
<regexp>(\[.*\])</regexp>
</cleanstrings>
</video>
</syntaxhighlight>
Updated in v20<ref>https://github.com/xbmc/xbmc/pull/20549</ref>

:* 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 Expressions

{{Github_link|[https://github.com/xbmc/xbmc/blob/Matrix/xbmc/settings/AdvancedSettings.cpp#L232 Code in Github]}}

Defaults:
<syntaxhighlight lang=xml enclose="div">
<tvshowmatching>
<regexp>s([0-9]+)[ ._x-]*e([0-9]+(?:(?:[a-i]|\\.[1-9])(?![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.
:* 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 [https://forum.kodi.tv/showthread.php?tid=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 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 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 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 syntax to match the locally stored trailers to movies in the library. Only files with recognized video file extensions will be considered, and the extensions are removed for the Regular Expression evaluation.

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

<regexp>(.*?)(_Trailer)$</regexp>
</trailermatching>
</syntaxhighlight>

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

{{Note|Kodi v20 users don't need set "importwatched" or "importresumepoint" to true anymore as that's the default then <ref>https://github.com/xbmc/xbmc/pull/20842</ref>}}

<syntaxhighlight lang="xml" line='line'>
<videolibrary>
<allitemsonbottom>false</allitemsonbottom> 
<cleanonupdate>false</cleanonupdate> 
<usefasthash>true</usefasthash> 
<recentlyaddeditems>35</recentlyaddeditems> 
<itemseparator> / </itemseparator> 
<exportautothumbs>true</exportautothumbs> 
<importwatchedstate>true</importwatchedstate> 
<importresumepoint>true</importresumepoint> 
<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>

== Library artwork ==
To prevent the resizing of artwork add the following two tags and values to your advancedsettings.xml file. More details on each tag follows in the next sections.
<syntaxhighlight lang=xml enclose="div">
<imageres>9999</imageres>
<fanartres>9999</fanartres>
</syntaxhighlight>

=== imageres ===
{{anchor|.3Cimageres.3E}}

<section begin="imageres description" />Specify the maximum resolution that [[Artwork/Cache#Texture optimization| cached artwork]] (other than fanart / 16:9 images) 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}}

<section begin="fanartres description" />Specify the maximum resolution that [[Artwork/Cache#Texture optimization| 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>

=== imagescalingalgorithm ===
Specify the image scaling algorithm for image resizing when [[Artwork/Cache#Texture optimization| caching artwork]] to the local texture cache.
<br />
<syntaxhighlight lang=xml enclose="div">
<imagescalingalgorithm>bicubic</imagescalingalgorithm>
</syntaxhighlight>

[https://github.com/xbmc/xbmc/blob/master/xbmc/pictures/PictureScalingAlgorithm.cpp#L20-L32 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>

=== imagequalityjpeg ===
This specifies the quality of the images when stored in jpeg format. By default kodi uses a quality of 4 which is a good compromise between size and quality. If you want to reduce the thumbnail sizes (decreasing quality) choose a higher value up to 21. If high quality (large thumbnail size) is needed, chose a smaller value, e.g. 0,1,2 or 3. (Added in v20 <ref>https://github.com/xbmc/xbmc/pull/21418</ref>)
<br />
<syntaxhighlight lang=xml enclose="div">
<imagequalityjpeg>4</imagequalityjpeg>
</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>

=== sorttokens ===
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>

In the above example "the ", "the." and "the_" will be ignored at the start of titles or names when sorting items, in both video and music libraries. A separator can also be specified, for example
<syntaxhighlight lang=xml enclose="div">
<sorttokens>
<token separators="'">L</token>
</sorttokens>
</syntaxhighlight>
In that case the value L', as in French movie name ''L'argent'', will be ignored and the item listed under "A".

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

:{{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.'''}}

'''Parent tags:'''

* '''<videodatabase>'''
* '''<musicdatabase>'''
* '''<tvdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''
* '''<epgdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''
{{MySQL warning}}

'''Child tags: '''

;<type>
: ''Required'' - Can be either "sqlite3" or "mysql" (default: sqlite3)

;<host>
:''Required'' -
* 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>
: ''Optional'' -
* sqlite3: silently ignored
* mysql: defines the port of the mysql socket (default: 3306)

;<name>
: ''Optional'' -
: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>
: ''Required for MySQL'' -
* sqlite3: silently ignored
* mysql: defines the user with privileged access to the database

;<pass>
: ''Required for MySQL'' -
* sqlite3: silently ignored
* mysql: defines the password for the user with privileged access to the database

;<connecttimeout> [https://github.com/xbmc/xbmc/pull/26657]
: ''Optional'' -
* sqlite3: silently ignored
* mysql: defines a connect timeout, in seconds. Default value is 5 seconds.

;<compression>
: ''Optional'' - 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}}

;<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]

'''Examples:'''

1) Configure a database for MySQL.
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', and '''<epgdatabase>''' 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>
<connecttimeout>3</connecttimeout>
</videodatabase>
</syntaxhighlight>

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

<section end="videodatabase" />

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

== Music settings ==

=== musicextensions ===
{{anchor|.3Cmusicextensions.3E}}
<section begin="musicextensions" />
Default extensions for MUSIC:
<pre>
.aac .ac3 .aif .aiff .ape .cmc .cmr .cue .dmc .dff .dsf .dsp .dts .dtshd .flac .gcm .gdm .idsp .imf
.m15 .m3u .m4a .m4b .mac .mka .mp+ .mp2 .mp3 .mpa .mpc .mpd .mpdsp .mpp .mpt .mss .nsv .oga .ogg .opus
.pls .pxml .rm .rma .rmt .rsd .rss .sap .sfx .shn .spt .strm .tak .tm2 .tm8 .tmc .tta .uni .url
.waa .wam .wav .wma .wpl .wtv .wv .wvs .xsp .xspf .xwav .zip
</pre>

It is possible to add or remove extensions for Music, using the following XML tags. Useful if you keep, say, FLAC and mp3 versions of music in the same folder. The <remove> tag can be used to remove mp3 from being listed in the library, leaving only the higher quality FLAC being displayed.

<musicextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</musicextensions>

<section end="musicextensions" />

=== 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 ===
Options specific to the Music Library
<section begin="MusicLibrary" />
<syntaxhighlight lang="xml" line='line'>
<musiclibrary>
<recentlyaddeditems>35</recentlyaddeditems> 

<prioritiseapetags>true</prioritiseapetags> 

<allitemsonbottom>true</allitemsonbottom> 

<cleanonupdate>false</cleanonupdate> 

<artistsortonupdate>false</artistsortonupdate> 

<albumformat>%B - %Y</albumformat> 

<itemseparator> / </itemseparator> 

<dateadded>1</dateadded> 

<artistseparators> 
<separator>;</separator>
<separator>:</separator>
<separator>|</separator>
<separator> feat. </separator>
<separator> ft. </separator>
</artistseparators>


<useisodates>false</useisodates> 


<artistnavigatestosongs>true</artistnavigatestosongs> 
</musiclibrary>
</syntaxhighlight>
{{Note|Changing the <itemseparator> or <artistseparators> will only affect newly added items. A rescan won't change the existing ones. Remove the Source(s) or delete the Music DB and rebuild. This process should be made easier from v18 and up using <promptfulltagscan>. <artistseparators> are cAsE sensitive and only used if you are not using MBID's. Separators will be used alongside MBID's from v22 onwards.}}<section end="MusicLibrary" />

== 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 .rss .webp .jp2 .apng
</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 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 ==

=== ftp ===
{{anchor|.3Cftp.3DE}}
Specific settings if a ftp server is in use as a source

<syntaxhighlight lang=xml enclose="div">
<ftp>
<remotethumbs>true</remotethumbs> 
</ftp>
</syntaxhighlight>

=== 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}}

<syntaxhighlight lang=xml line='line'>
<network>
<curlclienttimeout>10</curlclienttimeout> 
<curllowspeedtime>20</curllowspeedtime> 
<curlretries>2</curlretries> 
<httpproxyusername></httpproxyusername> 
<httpproxypassword></httpproxypassword> 
<disableipv6>false</disableipv6> 
<disablehttp2>false</disablehttp2> 
<nfstimeout>30</nfstimeout> 
<catrustfile>filepath</catrustfile> 
<curlkeepaliveinterval>30</curlkeepaliveinterval> 
<nfsretries>0</nfsretries> 
</network>
</syntaxhighlight>

'''More information:'''<br>
* <curlkeepaliveinterval><ref>https://github.com/xbmc/xbmc/pull/19319</ref><br>
* <nfsretries><ref>https://github.com/xbmc/xbmc/pull/19513</ref>

=== 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-ons|add-on]] rollback feature. Increasing the size should increase the amount of past versions saved. Defaults to 200 MB.
| example = Example: <syntaxhighlight lang=xml enclose="div"><packagefoldersize>200</packagefoldersize> </syntaxhighlight>
}}
<section end="packagefoldersize" />

=== detectasudf ===
{{anchor|.3Cdetectasudf.3E}}
{{xml setting
| tag name = detectasudf
| option type = binary
| option values = true, false
| default values = false
| platform = all
| XBMC version =
| description = Set to true if you wish to detect joint ISO9660/UDF disks as UDF.
| example = Example: <syntaxhighlight lang=xml enclose="div"><detectasudf>false</detectasudf></syntaxhighlight>
}}

=== handlemounting ===
{{anchor|.3Chandlemounting.3E}}
{{xml setting
| tag name = handlemounting
| option type = binary
| option values = true, false
| default values = false
| platform = Linux
| XBMC version =
| description = Only used in Linux, it defines if Kodi should attempt to mount media drives (via udisks or udisks2).<br/>Default: False. If kodi is executed with the --standalone option (e.g. as done by kodi-standalone.sh) it by default will be True.
| example = Example: <syntaxhighlight lang=xml enclose="div"><handlemounting>false</handlemounting></syntaxhighlight>
}}

=== automountopticalmedia ===
{{xml setting
| tag name = automountopticalmedia
| option type = binary
| option values = true, false
| default values = false
| platform = Linux
| XBMC version =
| description = Only used in linux for the udisks and udisks2 providers<br/>defines if kodi should automount optical discs<ref>https://github.com/xbmc/xbmc/pull/20840</ref>
| example = Example: <syntaxhighlight lang=xml enclose="div"><automountopticalmedia>true</automountopticalmedia></syntaxhighlight>
}}

=== pathsubstitution ===
{{anchor|.3Cpathsubstitution.3E}}
{{main|Path substitution}}

{{divbox|red||'''Note:''' Path substition for "sources" and profiles is broken, and will '''NOT''' be fixed.}}

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>

=== controllerdeadzone ===
{{anchor|.3Ccontrollerdeadzone.3E}}
This advanced settings has been removed.
Since v17, the [[Advancedsettings.xml#controllerdeadzone|<controllerdeadzone>]] advanced setting has been removed. Deadzones can now be configured by plugging in the controller and selecting it in Settings -> System settings -> Input -> Peripherals.

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

=== touchscreen ===
{{anchor|.3Ctouchscreen.3E}}
This setting allows you to move/align the origin of the touch screen with the origin of the display used. If touch input does not result in a correct movement of the mouse pointer, the behaviour can be corrected with an offset and a stretch/compress factor.

Example:
<syntaxhighlight lang=xml enclose="div">
<touchscreen>
<x_offset>0</x_offset> 
<y_offset>0</y_offset> 
<x_stretch_factor>1.0</x_stretch_factor> 
<y_stretch_factor>1.0</y_stretch_factor> 
</touchscreen>
</syntaxhighlight>

=== scanirserver ===
Introduced in v18 and used in MS Windows setups only.<ref>https://github.com/xbmc/xbmc/pull/13896</ref>
Used to disable the regular connection attempts to the IR Server Suite when there is no remote to connect to.

The default setting is to allow connection attempts. To disable connection attempts change value to '''false'''.
<syntaxhighlight lang=xml enclose="div">
<scanirserver>true</scanirserver>
</syntaxhighlight>

== GUI rendering settings ==

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

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

=== smartredraw ===

{{note|This is an experimental feature and you might face issues using it. So please be aware of that.}}

This new feature was introduced in Kodi 18 and if enabled, the GUI process call (and therefore the render call) is only done if anything has changed. The result will be a faster GUI and less load if Kodi plays a video

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

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

=== anisotropicfiltering ===

This new feature was introduced for the GL/GLES rendering backends in Kodi 22. It allows for better (hardware specific) filtering of textures at glancing angles. Depending on the hardware it might have no effect, or there might be a performance degradation. Typical values are "2" or "3", but might go as high as "16", depending on the hardware. The default is "1" (disabled).

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<anisotropicfiltering>2</anisotropicfiltering>
</gui>
</syntaxhighlight>

=== fronttobackrendering ===

This experimental feature was introduced for the GL/GLES rendering backends in Kodi 22. It enables a form of occlusion culling, by rendering opaque object from front to back. Most GPUs should benefit from this setting (especially on ARM based systems), often resulting in higher frame rates or less memory bandwidth usage.

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

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

=== geometryclear ===

This experimental setting was introduced for the GL/GLES rendering backends in Kodi 22. It disables geometry based screen clearing in favor of fixed function clearing. Depending on the GPU (most ARM systems, Intel >gen 12), disabling the setting might be preferable for increased performance.

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

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<geometryclear>false</geometryclear>
</gui>
</syntaxhighlight>

== Other interface settings ==

=== window ===
{{anchor|.3Cwindow.3E}}
{{note|This is a "hidden" guisettings.xml setting (defined by the mouse moving the window size), but it is mentioned here because it is a particularly useful override when used in advancedsettings.xml}}
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>

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

=== showexitbutton ===
{{anchor|.3Cshowexitbutton.3E}}
Setting to hide the exit button, useful for people running appliance based setups 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>

There is also a fake fullscreen GUI option in Kodi's settings.

=== minimizetotray ===
{{anchor|.3Cminimizetotray.3E}}
{{note|Available in Kodi v20 and above.}}

Windows only. Minimizes Kodi to the system tray. Defaults to false.
<syntaxhighlight lang=xml enclose="div">
<minimizetotray>true</minimizetotray>
</syntaxhighlight>

= Removed tags =
{{anchor|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_IDs]] 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.
* {{anchor|.3Ckaraoke.3E}}'''<karaoke>''' - In v16 all of the karaoke features in Kodi were removed.
* '''<useddsfanart>''' - removed in v17 Krypton.
* '''<cachemembuffersize>''' and '''<readbufferfactor>''' - In v17 '''<cachemembuffersize>''' is renamed to '''<memorysize>''' and <code><readbufferfactor></code> is renamed to <code><readfactor></code>. In addition, all three buffer related settings in <network> are moved out of <network> and into a new <cache> parent tag.
* '''<minvideocachelevel>''', '''<minaudiocachelevel>''', and '''<cacheindvdplayer>''' have been removed in v17.
* '''<useffmpegvda>''' - Tag was only used for development testing. Removed in v17.
* '''<nofliptimeout>''' - Removed in v17
* '''<blackbarcolour>''' - Removed in v17 (maybe?)
* '''<disableswmultithreading>''' - Removed in v17 (maybe?)
* '''<controllerdeadzone>''' - Removed in v17
* {{anchor|.3Cmeasurerefreshrate.3E}}'''<measurerefreshrate>''' - Removed in v17 or v18?
* {{anchor|.3Cmyth.3E}}'''<myth>''' - Removed sometime between v16 to v18
* {{anchor|.3Ctuxbox.3E}}'''<tuxbox>''' - Removed
* '''<backgroundupdate>''' - Removed
* '''<hideemptyseries>''' - Replaced by a GUI option.
* '''<mymovies>''' and child tag '''<categoriestogenres>''' - Removed
* '''<albumssortbyartistthenyear'''> - Removed
* '''<albumformatright>''' - Removed
* {{anchor|.3Cremoterepeat.3E}}'''<remoterepeat>''' - Removed
* {{anchor|.3Callowd3d9ex.3E}}'''<allowd3d9ex>''' and {{anchor|.3Cforced3d9ex.3E}}'''<forced3d9ex>''' - Removed sometime between v16 to v18
* '''<lingertime>''' - Replaced by a GUI setting in v18
* '''<forcevaapienabled>''' - Removed in v18
* '''<dxvaallowhqscaling>''' - Removed in v18 <ref>https://github.com/xbmc/xbmc/pull/15466</ref>
* '''<promptfulltagscan>false</promptfulltagscan>''' Removed in v18. Now automatically asked each time a scan is conducted.
* '''<omxdecodestartwithvalidframe>''' - This tag is only in some Raspberry Pi specific distributions, such as OpenELEC. As of March 2015, this tag has not been merged into "vanilla" Kodi builds
* '''<musicthumbs>''' Replaced in v19 by the GUI setting '''Thumbnail image files''' found in Media -> Music
* '''<artistextraart>''' Replaced in v19 by the GUI setting '''Artist art types whitelist''' found in Media -> Music <ref>https://github.com/xbmc/xbmc/pull/22748</ref>
* '''<albumextraart>''' Replaced in v19 by the GUI setting '''Album art types whitelist''' found in Media -> Music
* '''<episodeextraart>''' Replaced in v19 by the GUI setting '''Episode art types whitelist''' found in Media -> Videos
* '''<tvshowextraart>''' Replaced in v19 by the GUI setting '''TV show art types whitelist''' found in Media -> Videos
* '''<tvseasonextraart>''' Replaced in v19 by the GUI setting '''TV show art types whitelist''' found in Media -> Videos
* '''<movieextraart>''' Replaced in v19 by the GUI setting '''Movie art types whitelist''' found in Media -> Videos
* '''<moviesetextraart>''' Replaced in v19 by the GUI setting '''Movie art types whitelist''' found in Media -> Videos
* '''<musicvideoextraart>''' Replaced in v19 by the GUI setting '''Music video art types whitelist''' found in Media -> Videos
* '''<fanart>''' Removed in v19
* '''<assfixedworks>''' Removed in v20
* '''<try10bitoutput>''' Removed in v20 and replaced with [[Settings/System/Display#Use_10_bit_for_SDR|Use 10 bit for SDR]] setting <ref>https://github.com/xbmc/xbmc/pull/20014</ref>
* '''<enablehighqualityhwscalers>''' Removed in v20 <ref>https://github.com/xbmc/xbmc/pull/21537</ref>
* '''<cache> / <memorysize> / <buffermode> / <readfactor> / <chunksize>''' - Removed in v21 and added to GUI settings page

= guisettings.xml Setting Conversion =
It is possible to convert settings found in the '''[[Settings]]''' ''(guisettings.xml)'' pages of {{kodi}} into entries for the advancedsettings.xml file.

When a setting from the guisettings.xml is added to the advancedsettings.xml file, it will override the existing guisettings.xml values and the setting will be removed from the settings pages.

Why would I need to do this?
* You set up multiple devices and then need to individually change settings and preferences on each device. Using this conversion method, you save those settings in the advancedsettings.xml file and simply add the file to each device
* You need to hide settings to prevent those settings from being modified

To convert a guisetting to advancedsettings.xml follow these steps:
# In the {{kodi}} settings pages, adjust the setting(s) to your preference.
# Back out of the settings pages to the main menu, which forces {{kodi}} to save the adjusted settings to the guisettings.xml file
# Locate the guisettings.xml file in the [[Userdata]] folder and open it
# Locate the setting(s) to be converted. The list can be overwhelming so make use of the Search feature of whichever editor you are using
# Using the following setting as an example:
<syntaxhighlight lang="xml">
<setting id="videolibrary.showemptytvshows">true</setting>
</syntaxhighlight>
: Breaking down the string:
::'''videolibrary'''- parent tag
::'''showemptytvshows'''- child tag
::'''true'''- value
: The conversion is as follows and place this in the advancedsettings.xml file
<syntaxhighlight lang="xml">
<advancedsettings version="1.0">
<videolibrary>
<showemptytvshows>true</showemptytvshows>
</videolibrary>
</advancedsettings>
</syntaxhighlight>

'''Note:''' Some parent tags may already be in use in your advancedsettings.xml file. Do not duplicate them, but add the child tag beneath the existing parent tag.

= References =
<references />

{{Updated|18}}
{{DISPLAYTITLE:advancedsettings.xml}}

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

Releases

2025-12-14T05:23:28Z

Karellen:

{{mininav| [[Kodi]] {{l2| [[Development]] }} }}

== Release history ==

This is a summary of the Kodi release history with links to relevant changelog pages.

[[File:Github Logo.png|40px|link=]] [https://github.com/xbmc/xbmc/milestones?state=closed Version Milestones can be found here]

{| class="prettytable"
|-
! colspan="2"| Legend
|-
| style="background:skyBlue;"| Blue
| Future release
|-
| style="background:#a0e75a;"| Green
| Current release
|-
| style="background:salmon;"| Red
| Old releases
|}

{| class="prettytable"
|-
! [[Codename history]]
! Version
! scope="col" style="width: 10%" | Release date
! Significant changes
! XBMC Live<br /><span style="font-size: 95%;">development base</span>
|-
! style="background: skyblue; border-bottom:solid 3px black;" | Piers
| style="background: skyblue; border-bottom:solid 3px black; text-align: right;" | 22.0
| style="background: skyblue; border-bottom:solid 3px black;" | In Development
| style="border-bottom:solid 3px black;" |
| style="text-align: center; border-bottom:solid 3px black;" | N/A

|-
! rowspan="4" style="background: #a0e75a; border-bottom:solid 3px black;" | Omega
| style="background: #a0e75a; text-align: right;" | 21.3
| style="background: #a0e75a;" | [https://kodi.tv/article/kodi-21-3-omega-release/ 13 Dec 2025]
| rowspan="4" style="border-bottom:solid 3px black;" | '''[https://github.com/xbmc/xbmc/pulls?q=is%3Apr+is%3Aclosed+label%3A%22v21+Omega%22 Kodi v21 (Omega) changelog]'''
| rowspan="4" style="text-align: center; border-bottom:solid 3px black;" | N/A
|-
| style="text-align: right;" | 21.2
| [https://kodi.tv/article/kodi-21-2-omega-release/ 19 Jan 2025]
|-
| style="text-align: right;" | 21.1
| [https://kodi.tv/article/kodi-21-1-omega-release/ 18 Aug 2024]
|-
| style="border-bottom:solid 3px black; text-align: right;" | 21.0
| style="border-bottom:solid 3px black;" | [https://kodi.tv/article/kodi-21-0-omega-release/ 6 Apr 2024]
|-

! rowspan="6" style="background: salmon; border-bottom:solid 3px black;" | Nexus
| style="background: salmon; text-align: right;" | 20.5
| style="background: salmon;" | [https://kodi.tv/article/kodi-20-5-nexus-release/ 3 Mar 2024]
| rowspan="6" style="border-bottom:solid 3px black;" | '''[https://github.com/xbmc/xbmc/pulls?q=is%3Apr+is%3Aclosed+label%3A%22v20+Nexus%22 Kodi v20 (Nexus) changelog]'''
| rowspan="6" style="text-align: center; border-bottom:solid 3px black;" | N/A
|-
| style="text-align: right;" | 20.4
| [https://kodi.tv/article/kodi-20-4-nexus-release/ 11 Feb 2024]
|-
| style="text-align: right;" | 20.3
| [https://kodi.tv/article/kodi-20-3-nexus-release/ 10 Jan 2024]
|-
| style="text-align: right;" | 20.2
| [https://kodi.tv/article/kodi-20-2-nexus-release/ 29 June 2023]
|-
| style="text-align: right;" | 20.1
| [https://kodi.tv/article/kodi-20-1-nexus-release/ 12 March 2023]
|-
| style="border-bottom:solid 3px black; text-align: right;" | 20.0
| style="border-bottom:solid 3px black;" | [https://kodi.tv/article/kodi-20-0-nexus-release/ 16 January 2023]
|-

! rowspan="6" style="background: salmon; border-bottom:solid 3px black;" | Matrix
| style="background: salmon; text-align: right;" | 19.5
| style="background: salmon;" | [https://kodi.tv/article/kodi-matrix-19-5-release/ 25 December 2022]
| rowspan="6" style="border-bottom:solid 3px black; | <span id="Matrix">{{main|Kodi v19 (Matrix) changelog|Matrix API changes}}</span>
| rowspan="6" style="text-align: center; border-bottom:solid 3px black;" | N/A
|-
| style="text-align: right;" | 19.4
| [https://kodi.tv/article/kodi-matrix-19-4-release/ 4 March 2022]
|-
| style="text-align: right;" | 19.3
| [https://kodi.tv/article/kodi-matrix-19-3-release/ 28 October 2021]
|-
| style="text-align: right;" | 19.2
| [https://kodi.tv/article/kodi-matrix-19-2-release/ 09 October 2021]
|-
| style="text-align: right;" | 19.1
| [https://kodi.tv/article/kodi-matrix-19-1-release/ 10 May 2021]
|-
| style="border-bottom:solid 3px black; text-align: right;" | 19.0
| style="border-bottom:solid 3px black;" | [https://kodi.tv/article/kodi-19-0-matrix-release/ 20 February 2021]
|-

! rowspan="12" style="background: salmon; border-bottom:solid 3px black;" | Leia
| style="background: salmon; text-align: right;" | 18.9
| style="background: salmon;" | [https://kodi.tv/article/kodi-leia-189-release 24 October 2020]
| rowspan="12" style="border-bottom:solid 3px black; | <span id="Leia">{{main|Kodi v18 (Leia) changelog|Leia API changes}}</span>
<br />29 December 2017 - XBox One v18 Alpha released to Windows Store
* ^v18.7.1- Special Android Release
* ^v18.7.2- Special Android Release
* ^v18.9- Special release due to [https://community.cloudflare.com/t/http-h2c-upgrade-requests-result-in-connection-reset-by-peer/214761 Cloudflare http2 issue].
| rowspan="12" style="text-align: center; border-bottom:solid 3px black;" | N/A
|-
| style="text-align: right;" | ^18.8
| [https://kodi.tv/article/kodi-leia-188-release 29 July 2020]
|-
| style="text-align: right;" | ^18.7.2
| [https://kodi.tv/article/kodi-leia-187-android 14 June 2020]
|-
| style="text-align: right;" | ^18.7.1
| [https://kodi.tv/article/kodi-leia-187-android 1 June 2020]
|-
| style="text-align: right;" | 18.7
| [https://kodi.tv/article/kodi-leia-187-release 21 May 2020]
|-
| style="text-align: right;" | 18.6
| [https://kodi.tv/article/kodi-leia-186-release 02 Mar 2020]
|-
| style="text-align: right;" | 18.5
| [https://kodi.tv/article/kodi-leia-185-release 17 Nov 2019]
|-
| style="text-align: right;" | 18.4
| [https://kodi.tv/article/kodi-leia-184-release 1 Sept 2019]
|-
| style="text-align: right;" | 18.3
| [https://kodi.tv/article/kodi-leia-183-release 27 June 2019]
|-
| style="text-align: right;" | 18.2
| [https://kodi.tv/article/kodi-leia-182-release 22 April 2019]
|-
| style="text-align: right;" | 18.1
| [https://kodi.tv/article/kodi-v181-leia-rc1 17 February 2019]
|-
| style="text-align: right; border-bottom:solid 3px black;" | 18.0
| style="border-bottom:solid 3px black;" | [https://kodi.tv/article/kodi-180 29 January 2019]
|-
! rowspan="7" style="background: salmon; border-bottom:solid 3px black;" | Krypton
| style="background: salmon; text-align: right;" | 17.6
| style="background: salmon;" | [https://kodi.tv/article/kodi-v176-final-very-last 15 November 2017]
| rowspan="7" style="vertical-align: top; border-bottom:solid 3px black;" | <span id="Krypton">{{main|Archive:Kodi v17 (Krypton) changelog}}</span>
| rowspan="7" style="text-align: center; border-bottom:solid 3px black;" | N/A
|-
| style="text-align: right;" | 17.5
| [https://kodi.tv/article/kodi-v175-final-another-bunch-fixes 24 October 2017]
|-
| style="text-align: right;" | 17.4
| [https://kodi.tv/article/kodi-v174-final-just-bunch-fixes 22 August 2017]
|-
| style="text-align: right;" | 17.3
| [https://kodi.tv/article/kodi-v173-minor-bug-fix-and-security-release 25 May 2017]
|-
| style="text-align: right;" | 17.2
| [https://kodi.tv/article/kodi-v172-minor-bug-fix-and-security-release 21 May 2017]
|-
| style="text-align: right;" | 17.1
| [https://kodi.tv/kodi-v17-1-krypton 23 March 2017]
|-
| style="text-align: right; border-bottom:solid 3px black; " | 17.0
| style="border-bottom:solid 3px black;" | [https://kodi.tv/kodi17 5 February 2017]
|-
! rowspan="2" style="background: salmon; border-bottom:solid 3px black;" | Jarvis
| style="text-align: right;" | 16.1
| [https://kodi.tv/article/kodi-161-%E2%80%93-jarvis-%E2%80%93-mark-xvi 24 April 2016]
| rowspan="2" style="border-bottom:solid 3px black;" | <span id="Jarvis">{{main|Archive:Kodi v16 (Jarvis) changelog|Archive:Jarvis API changes}}</span>
| rowspan="2" style="text-align: center; border-bottom:solid 3px black;" | N/A
|-
| style="text-align: right; border-bottom:solid 3px black;" | 16.0
| style="border-bottom:solid 3px black;" | [https://kodi.tv/article/kodi-160-jarvis-mark-xvi 21 February 2016]
|-
! rowspan="3" style="white-space: nowrap; background: salmon; border-bottom:solid 3px black;" | Isengard
| style="text-align: right;" | 15.2
| [https://kodi.tv/article/kodi-152-isengard-final-chapter 19 October 2015]
| rowspan="3" style="border-bottom:solid 3px black;" | <span id="Isengard">{{main|Archive:Kodi v15 (Isengard) changelog}}</span>
| rowspan="3" style="text-align: center; border-bottom:solid 3px black;" | N/A
|-
| style="text-align: right;" | 15.1
| [https://kodi.tv/article/kodi-151-isengard-maintenance-release 16 August 2015]
|-
| style="text-align: right; border-bottom:solid 3px black;" | 15.0
| style="border-bottom:solid 3px black;" | [https://kodi.tv/article/kodi-150-isengard-one-release-rule-them-all 21 July 2015]
|-
! rowspan="3" style="background: salmon; border-bottom:solid 3px black;" | Helix
| style="text-align: right;" | 14.2
| [https://kodi.tv/article/kodi-142-helix-final-translation 28 March 2015]
| rowspan="3" style="border-bottom:solid 3px black;" | <span id="Helix">{{main| Archive:Kodi v14 (Helix) changelog |Archive:Helix API changes}}</span>
| rowspan="3" style="text-align: center; border-bottom:solid 3px black;" | N/A
|-
| style="text-align: right;" | 14.1
| [https://kodi.tv/article/kodi-141-helix-bugfix-release 2 February 2015]
|-
| style="text-align: right; border-bottom:solid 3px black;" | 14.0
| style="border-bottom:solid 3px black;" | [https://kodi.tv/article/kodi-140-helix-unwinds 23 December 2014]
|-
! rowspan="3" style="background: salmon; border-bottom:solid 3px black;" | Gotham
| style="text-align: right;" | 13.2
| [https://kodi.tv/article/xbmc-132-gotham-final-release 18 August 2014]
| rowspan="3" style="border-bottom:solid 3px black;" | <span id="Gotham">{{main|Archive:XBMC v13 (Gotham) changelog}}</span>
| rowspan="3" style="text-align: center; border-bottom:solid 3px black;" | Lubuntu 14.04<br />"Trusty Tahr"
|-
| style="text-align: right;" | 13.1
| [https://kodi.tv/article/xbmc-131-gotham-returns 5 June 2014]
|-
| style="text-align: right; border-bottom:solid 3px black;" | 13.0
| style="border-bottom:solid 3px black;" | [https://kodi.tv/article/xbmc-130-gotham-rises 4 May 2014]
|-
! rowspan="4" style="background: salmon; border-bottom:solid 3px black;" | Frodo
| style="text-align: right;" | 12.3
| [https://kodi.tv/article/xbmc-123-frodo-fixes 24 December 2013]
| rowspan="4" style="border-bottom:solid 3px black;" | <span id="Frodo">{{main|Archive:XBMC v12 (Frodo) changelog|Archive:XBMC v12 (Frodo) API changes}}</span>
| rowspan="4" style="text-align: center; border-bottom:solid 3px black;" | Lubuntu 12.10<br />"Quantal Quetzal"
|-
| style="text-align: right;" | 12.2
| [https://kodi.tv/article/xbmc-122-even-more-frodo 3 May 2013]
|-
| style="text-align: right;" | 12.1
| [https://kodi.tv/article/xbmc-121-now-even-better 18 March 2013]
|-
| style="text-align: right; border-bottom:solid 3px black;" | 12.0
| style="border-bottom:solid 3px black;" | [https://kodi.tv/article/xbmc-120-frodo 29 January 2013]
|-
! style="background: salmon; border-bottom:solid 3px black;" | Eden
| style="text-align: right; border-bottom:solid 3px black;" | 11.0
| style="border-bottom:solid 3px black;" | [https://kodi.tv/article/xbmc-110-eden 24 March 2012]
| style="border-bottom:solid 3px black;" | <span id="Eden">{{main|Archive:XBMC v11 (Eden) changelog|Archive:Eden API changes}}</span>
| style="text-align: center; border-bottom:solid 3px black;v" | Lubuntu 11.10<br />"Oneiric Ocelot"
|-
! rowspan="2" style="background: salmon; border-bottom:solid 3px black;" | Dharma
| style="text-align: right;" | 10.1
| [https://kodi.tv/article/bug-fix-release-101 10 March 2011]
| rowspan="2" style="border-bottom:solid 3px black;" |
* <span id="Dharma">Unified Addon framework</span>
* Addon Browser GUI for installation and management of third-party addons, skin, and scripts
* Team XBMC's official Addons Repository with Addon FanArt support
* Update Notifications
* Movie Sets (option to group movie collections)
* WebM/VP8 codec
* Gesture support to XBMC's GUI Engine
* Unencrypted Blu-ray Disc support
* Broadcom Crystal HD video acceleration support (All Platforms)
* Windows Touch API support (Windows 7 touch features and functions)
* DXVA 2.0 (DirectX Video Acceleration) (Windows Vista/7 exclusive)
* WASAPI (Windows Audio Session API) for raw bitstream output (Windows Vista/7 exclusive)
* High-Quality Bicubic and Lanczos Upscalers (Video Resamplers) as Direct3D HLSL (Windows Vista/7 exclusive) and OpenGL GLSL Shaders
* Direct3D port of the OpenGL Spectrum 3D Audio Visualization for DirectX (Windows Vista/7 exclusive)
* AVisual Studio 2010 Express edition and Visual Studio 2010 non-Express edition support (Windows Vista/7 exclusive)
* ARM processor architecture (Linux exclusive)
* VAAPI (Video Acceleration API) support (Linux exclusive)
* OpenMAX Video Acceleration support (Linux exclusive)
* NEON (ARM) Video Acceleration support (Linux exclusive)
* Apple VDADecoder Video Acceleration support (OS X exclusive requires Snow Leopard and NVIDIA 9400 or later)
* OpenGL ES 2.0 compliance
* JSON-RPC, JSON API
* RTMPE and RTMPTE
* Microhttpd Web Server replaces old GoAhead and Spyce code
* SSH file transfer protocol (sftp) via libssh
* MySQL database backend
| rowspan="2" style="text-align: center; border-bottom:solid 3px black;" | Ubuntu 10.04<br />"Lucid Lynx"
|-
| style="text-align: right; border-bottom:solid 3px black;" | 10.0
| style="border-bottom:solid 3px black;" | [https://kodi.tv/article/xbmc-100 18 December 2010]
|-
! style="background: salmon; border-bottom:solid 3px black;" | Camelot
| style="text-align: right; border-bottom:solid 3px black;" | 9.11
| style="border-bottom:solid 3px black;" | [https://kodi.tv/article/xbmc-911-camelot 24 December 2009]
| style="border-bottom:solid 3px black;" |
* <span id="Camelot">Revamped user interface via the new default skin “Confluence“</span>
* DirectX support by default for the Windows platform
* A complete reorganization of the settings menus uniformed across skins
* Automatic video information extraction
* Out of the box support for new remotes
* Smoother video playback performance
* All scrapers updated
* Increased subtitle and Karaoke lyric support
* Support for CoreAudio API (OS X exclusive)
* AC3 and DTS digital audio pass-through to SP/DIF on Apple TV (thanks to CoreAudio)
| style="text-align: center; border-bottom:solid 3px black;" | Ubuntu 9.10<br />"Karmic Koala"
|-
! rowspan="2" style="background: salmon; right; border-bottom:solid 3px black;" | Babylon
| style="text-align: right;" | 9.04.1
| [https://kodi.tv/article/xbmc-9041-released 27 May 2009]
| rowspan="2" style="right; border-bottom:solid 3px black;" |
* <span id="Babylon">PPC (PowerPC) support for Mac OS X (PowerPC G4 or later)</span>
* VDPAU (Nvidia's Video Decode and Presentation API for Unix)
* New Karaoke features
* Officially dropped support for Xbox
* Updated codecs and major bug-fixes for DVD-Video playback core
* More Media Info Scrapers
* Improved FanArt support
* Revamped skinning engine
| rowspan="2" style="text-align: center; border-bottom:solid 3px black;" | Ubuntu 9.04<br />"Jaunty Jackalope"
|-
| style="text-align: right; border-bottom:solid 3px black;" | 9.04
| style="border-bottom:solid 3px black;" | 6 May 2009
|-
! style="background: salmon; right; border-bottom:solid 3px black;" | N/A
| style="text-align: right; right; border-bottom:solid 3px black;" | 2.0.0
| style="right; border-bottom:solid 3px black;" | 29 September 2006
| style="right; border-bottom:solid 3px black;" |
* Reworked skinning engine.
* DVD-Video menu/navigation support (with ISO/IMG image parsing) through internally developed core
* RAR/ZIP archive parsing
* New audio/music-player (PAPlayer) with crossfade, gapless playback and ReplayGain support
* Karaoke CDG-file display
* Xored Trainer Engine (gaming-cheats) (not ported from Xbox)
* XLink Kai (online-gaming) front-end (depreciated)
* Added iTunes 6.x DAAP and UPnP-client
* Read-only support for FAT12/16/32 formatted USB Mass Storage Devices up to 4GB in size
* Brand new "skinnable" 3D visualizer.
| style="text-align: center; right; border-bottom:solid 3px black;" | N/A
|-
! style="background: salmon; border-bottom:solid 3px black;" | N/A
| style="text-align: right; border-bottom:solid 3px black;" | 1.1.0
| style="border-bottom:solid 3px black;" | 18 October 2004
| style="border-bottom:solid 3px black;" |
* ITU H.261, creative labs yuv (cyuv), supermac cinepak (cvid), quicktime, on2 vp4, 3ivx d4 / 3vi1 mpeg-4 video support
* Container support for nsa, raw audio in .mov, .ac3, .dts and dts-wav
* Zoom/stretch options: zoom, stretch 4x3 or 14x9 or 16x9, original size, custom
* Volume control
* Tags parsing and display for wma, m4a, mp4 and aac (mpeg-4 audio) audio-files
* International-language fonts for subtitles via ttf-fonts
* Audio CD Ripper, backup cdda's to hdd in wav, ogg or mp3 (lame) format
* Karaoke cdg-file and audio cue sheets (.cue) support
* iIunes music shares via DAAP (network stream from Apple iTunes)
* XBMC's xbmsp-client code updated to support "auto-discovery of xbmsp servers"
* Auto-temperature and fan-speed control options
* Network-configuration and setup via GUI
* Emergency recovery console (enables the ftp-server during fatal errors)
* Profiles for settings
* Mouse support and virtual-keyboard
* LCD-display output extended to also support xaddons lcd-mods and xecuter3 lcd
| style="text-align: center; border-bottom:solid 3px black;" | N/A
|-
! style="background: salmon; border-bottom:solid 3px black;" | N/A
| style="text-align: right; border-bottom:solid 3px black;" | 1.0.0
| style="border-bottom:solid 3px black;" | 29 June 2004
| style="border-bottom:solid 3px black;" |
* Total rewrite of the source code
| style="text-align: center; border-bottom:solid 3px black;" | N/A
|-
|}

== Codename history ==
{{see|Codename history}}

== References ==
<references />

[[Category:Releases|*]]

Template:Download link

2025-12-14T05:18:23Z

Karellen:

{{#switch:{{{1|}}}
| Android ARMV7A (32Bit) = https://mirrors.kodi.tv/releases/android/arm/kodi-21.3-Omega-armeabi-v7a.apk?https=1
| Android ARMV8A (64Bit) = https://mirrors.kodi.tv/releases/android/arm64-v8a/kodi-21.3-Omega-arm64-v8a.apk?https=1
| Google Play = https://play.google.com/store/apps/details?id=org.xbmc.kodi
| Huawei App Gallery = https://appgallery.huawei.com/#/app/C101763539
| iOS (64Bit) = https://mirrors.kodi.tv/releases/darwin/ios-arm64/org.xbmc.kodi-ios_21.3_iphoneos-arm64.deb?https=1
| Mac Apple Silicon (ARM64) = https://mirrors.kodi.tv/releases/osx/arm64/kodi-21.3-Omega-arm64.dmg?https=1
| Mac Intel (x86_64) = https://mirrors.kodi.tv/releases/osx/x86_64/kodi-21.3-Omega-x86_64.dmg?https=1
| tvOS = https://mirrors.kodi.tv/releases/darwin/tvos/org.xbmc.kodi-tvos_21.3-tvos.deb?https=1
| webOS = https://mirrors.kodi.tv/releases/webos/org.xbmc.kodi-webos_21.0.ipk?https=1
| Windows = https://mirrors.kodi.tv/releases/windows/win32/kodi-21.3-Omega-x86.exe?https=1
| Windows (64Bit) = https://mirrors.kodi.tv/releases/windows/win64/kodi-21.3-Omega-x64.exe?https=1
| Windows Store = https://apps.microsoft.com/detail/9nblggh4t892?cid=koditvlinkbadge
}}<noinclude>{{doc}}</noinclude>

Template:Previous version

2025-12-14T05:16:52Z

Karellen:

{{kodi}} v21.2 Omega<noinclude>{{doc}}</noinclude>

Template:Current version

2025-12-14T05:16:32Z

Karellen:

{{kodi}} v21.3 Omega<noinclude>{{doc}}</noinclude>

Add-on:TMDb TV Shows

2025-10-27T22:08:47Z

Karellen:

{{Addon
|Name=TMDb TV Shows
|provider-name=Team Kodi
|ID=metadata.tvshows.themoviedb.org.python
|latest-version=1.7.4
|extension point=xbmc.metadata.scraper.tvshows
|provides=
|Summary=Fetch TV Show metadata from themoviedb.org
|Description=The Movie Database (TMDb) is a community built movie and TV database. Every piece of data has been added by our amazing community dating back to 2008. TMDb's strong international focus and breadth of data is largely unmatched and something we're incredibly proud of. Put simply, we live and breathe community and that's precisely what makes us different.
|Platform=all
|Language=
|License=GPL-3.0-or-later
|Forum=https://forum.kodi.tv/showthread.php?tid=357232
|Website=https://www.themoviedb.org
|Source=https://github.com/xbmc/metadata.tvshows.themoviedb.org.python
|Email=
|broken=
|icon url=http://mirrors.kodi.tv/addons/omega/metadata.tvshows.themoviedb.org.python/resources/icon.png}}

= Introduction =
The Movie Database Python scraper is developed and maintained by Team Kodi. It is written in Python and has proven to be more stable and reliable than the Regex based scrapers.

TMDb TV Shows scraper accesses the following sites to scrape your TV Shows, seasons and episodes to populate your library:
* [https://www.themoviedb.org/ TheMovieDB] - for metadata and some artwork
* [https://fanart.tv/ fanart.tv] - for artwork
* [https://www.imdb.com/ IMDB] - for ratings
* [https://trakt.tv/ Trakt.tv] - for ratings

= Search =
This scraper uses the folder name as the search string to lookup the title at TheMovieDB site.

If you are experiencing problems scraping the correct title, there are 3 methods available to force the scraper to the correct title.

== Scraper Search ==
If the scraper is unable to find the correct TV Show, you can perform a search using either the IMDB, TMDB or TVDB ID's. This may be a more convenient method than using a [[NFO_files#Parsing_nfo|Parsing NFO file]].
* To search by TMDB enter the prefix '''tmdb/''' followed by the ID. eg '''tmdb/90027'''
* To search by TVDB enter the prefix '''tvdb/''' followed by the ID. eg '''tvdb/365026'''
* To search by IMDB ID enter the ttxxxxxx ID directly without any prefix. eg '''tt0489974'''

'''Note:''' This method can only be used for the TV Show. It cannot be used to find episodes.

<gallery mode="packed" widths="500px" heights="293px">
File:TMDb-TV-Shows-01.jpg|Image 1- If the correct TV show is not in the list, select '''Manual'''
File:TMDb-TV-Shows-02.jpg|Image 2- If using the '''TMDB ID''', enter it as shown using the '''tmdb/''' prefix, then press OK
File:TMDb-TV-Shows-03.jpg|Image 3- If using the '''TVDB ID''', enter it as shown using the '''tvdb/''' prefix, then press OK
File:TMDb-TV-Shows-04.jpg|Image 4- If using the '''IMDB ID''', enter it as shown, then press OK
File:TMDb-TV-Shows-05.jpg|Image 5- Select the correct TV Show from the list.
</gallery>

== Filename identifiers ==
{{#lst:Naming_video_files/Movies|FilenameID}}

== Parsing NFO File ==
: '''See:''' [[NFO_files/Parsing|Parsing NFO Files]]

= Settings =
{{#lst:Add-on:The_Movie_Database_Python|ScraperSettings}}

== General ==
[[File:TMDb-TV-Shows-06.jpg|700px|Image 6- General Settings]]

; Preferred language
: Set which language of metadata to scrape

; Preferred certification country
: Select which country Content Certification system (MPAA) to use.

; Include certification prefix
: To display the appropriate Content Advisory Rating flags in your skin, the rating must be prefixed. Enable this setting and add the prefix in the next setting.

; Prefix
: Insert the required certification prefix here. If unsure, check with the skin author what the required prefix is for your chosen country.

; Keep Original Title
: Use the original (untranslated) title when downloading metadata for a foreign film.
: For example the TV show ''[https://www.themoviedb.org/tv/71446-la-casa-de-papel Money Heist]'' is the English translated title. The original title of the TV show is '''La casa de papel'''. If you prefer the English translated title (or whichever language you have set in the scraper settings), then '''disable''' the setting. If you prefer the original languge title then '''enable''' the setting.

; Add keywords as tags
: Scrape [https://www.themoviedb.org/bible/movie/59f3b16d9251414f20000007 Keywords] from TMDB and add them as Tags in Kodi
: Be aware that larger libraries may be flooded with thousands of tags in {{kodi}}

; Categorize fanart with text as landscape
: Fanart is 16x9 images with no text
: Landscape are fanart images with text
: With this setting enabled, 16:9 images with text are scraped as a Landscape image type.

; Include country code with studio
: When disabled the studio will be saved as ''HBO''
: When enabled, the studio will be saved as ''HBO (US)'' with the country of origin appended to the studio name.
: If the skin uses '''[[Add-on:Studio_Icons_-_Coloured|Studio Icons]]''', enabling this setting may break the display of icons for many studios.

; Enable Trailer
: When enabled, will scrape links to online trailers. Only a link is scraped to the trailer. The trailer itself is not downloaded.

; Addon Player
: Choose which addon to use to play the trailer.

== Ratings ==
[[File:TMDb-TV-Shows-07.jpg|700px|Image 7- Ratings]]

; Default rating from
: Choose which rating to download and display as the default rating. Most skins displays only a single rating. Choices are TMDB, IMDB and Trakt.

; Also add IMDB ratings
: Download IMDB ratings in addition to the default rating. If IMDB is selected as default above, this setting will be greyed out.

; Also add Trakt.tv ratings
: Download Trakt.tv ratings in addition to the default rating. If Trakt.tv is selected as default above, this setting will be greyed out.

; Also add TMDB ratings
: Download TMDB ratings in addition to the default rating. If TMDB is selected as default above, this setting will be greyed out.

== Fanart.tv ==
This section controls artwork scraping from '''[https://fanart.tv/ fanart.tv]'''

All artwork related settings are set in {{highlight|bordered=yes|[[Settings/Media/Videos#Artwork|Settings ▶ Media ▶ Videos]]}} in the '''Artwork''' section of the {{Kodi}} settings. Use these settings to modify which artwork types are downloaded. The default is to download all artwork types.

[[File:TMDb-TV-Shows-10.jpg|700px|Image 9- Fanart.tv]]

; Include art from fanart.tv
: This setting is enabled by default which allows scraping of artwork from fanart.tv.
: For those that prefer no extended artwork, disable this setting. Artwork will then be limited to ''Poster, fanart, landscape'' and ''clearlogo'' as provided by TheMovieDB, unless you have further adjusted the artwork settings in {{Kodi}}.

; Client key (optional)
: Enter your personal API key here if you have one.
: A personal API key is not required to use these features.
: For more information on API keys, see '''[https://fanart.tv/personal-api-keys/ fanart.tv Personal API Key benefits]'''

== Advanced ==
[[File:TMDb-TV-Shows-09.jpg|700px|Image 10- Advanced]]

; Verbose debug logging
: Used to add additional logging to help fault find scraping issues.
: The additional logging is detailed and not required for general scraping issues. Please do not enable this unless specifically requested.

= Episode Orders =
Some TV Shows are originally broadcast in one order (default order) but the order may be different when broadcasting in a different country (La Casa De Papel), or the DVD/Bluray release may have a different screening order (Firefly).

TheMovieDB uses Episode Groups for additional episode orders.

To use one of the orders for scraping, follow the images below. Paste the address into a '''''[[NFO_files/Parsing|Parsing NFO file]]''''' then scrape. The Parsing NFO File will point the scraper to the listing. <ref>https://forum.kodi.tv/showthread.php?tid=338467&pid=2801494#pid2801494</ref>

'''Note:''' When using episode groups, the numbering of your episode files (SxxEyy) must match the numbering of the order you have chosen to use.

<gallery mode="traditional" widths="500px" heights="283px">
File:EpisodeGroups01.jpg|Image 1- Accessing Episode Groups
File:EpisodeGroups02.jpg|Image 2- Available Episode Groups
File:EpisodeGroups03.jpg|Image 3- Select a Group, then copy the address for use in a '''''[[NFO_files/Parsing|Parsing NFO file]]'''''.
File:LocalTVShowArtwork01.jpg|Image 4- Location of the tvshow.nfo
</gallery>

= References =
<references />

{{top}}
{{updated|21}}

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Karellen]]
[[Category:Nexus]]
[[Category:Omega]]
[[Category:TV scraper add-ons]]
[[Category:Leia add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Nexus add-on repository]]
[[Category:Omega add-on repository]]

Bluray

2025-08-24T05:41:45Z

Karellen: First creation

{{mininav|[[Video library]]|[[Video management|Management]] }}

= Introduction =
{{kodi}} v22 "Piers" has improved handling of Bluray folders and ISO files. For further information, see the following pages:

[[Bluray/Episodes|Information for Episodes]]

[[Bluray/Movies|Information for Movies]]

{{top}}
{{updated|22}}

[[Category:Karellen]]
[[Category:Video library]]

Video extras

2025-08-19T03:45:23Z

Karellen:

Video versions

2025-08-19T03:45:12Z

Karellen:

{{mininav|[[Video library]]|[[Video management|Management]] }}

{|class="infobox" style="width:230px"
! Versions Contents
|-
|
'''[[Video_versions|Video Versions]]'''<br>
'''[[Video_extras|Video Extras]]'''
|}

= Introduction =
<section begin="intro" />Video Version is a new {{kodi}} feature introduced in v21. It allows users to keep multiple versions of the same video title in the library.

Do you have the DVD, Bluray, 3D and 4K version of a title?
Do you have the Theatrical Release, Director's Cut, Extended version or any other type of version for the same title?
Do you dislike the same title being repeatedly listed in the library?

All these different formats and versions can be attached to a parent title in the library. Think of it as Movie Sets for the same movie.<section end="intro" />

This feature works on the movie library and may be expanded to TV shows and episodes in a later release of {{kodi}}.

= Understanding Versions =
{{kodi}} uses a parent/child method for video versions. i.e. one version is selected as the parent version, which is the default version, and other versions are added to this parent version. <small>Using the Update Library method, which version becomes the parent/default version cannot be controlled, but the default version can be changed later as required.</small>

Using Blade Runner (1982) as an example, to make the original US Theatrical Release as the default version of the movie, using the Versions Manager method it would be selected as the movie to which all other versions are added to.
<syntaxhighlight lang="xml"> -Blade Runner (1982) - US Theatrical Cut [dvd] (parent movie; default movie)
|- Blade Runner (1982) - Directors Cut [dvd] (child version)
|- Blade Runner (1982) - Intl Theatrical Cut [dvd] (child version)
|- Blade Runner (1982) - The Final Cut [bluray] (child version)
|- Blade Runner (1982) - The Final Cut [dvd] (child version)</syntaxhighlight>

For those familiar with the {{kodi}} video database, scanned movies are saved in the ''movie'' table of the MyVideos database. When a movie is added as a child to a Video Version, that child movie is deleted from the ''movie'' table and moved into the ''videoversion'' table which contains no movie metadata and contains links to the file, video version type and parent movie via the use of primary and foreign keys. The parent movie remains in the ''movie'' table and the child versions use the metadata of the parent movie. When the default parent movie is changed, it is only the ''idFile'' in the ''movie'' table that changes.

As this is a '''Library''' feature, how the files are stored on your hard drives does not affect Video Versions. Your video files can continue to be in their own folder, on different drives or in a single folder.

Versions are matched as follows:
# The scanner first checks for duplicate TMDB or IMDB UniqueID
# If no ID is matched, then the scanner checks for a duplicate Title+Year.
To increase the accuracy of the scan, especially when using nfo files, ensure:
# TMDB and IMDB ID's are included, correct and they are the same for all the versions
# The value in the <title> tag is clean and that all the versions use the same title. i.e. Use <code><title>Blade Runner</title></code> instead of naming the version like <code><title>Blade Runner - US Theatrical Release</title></code>

= Settings =
There are three settings that control the behaviour of Video Versions.
{{#lst:Settings/Media/Library|IgnoreVideoVersionsScan}}

{{#lst:Settings/Media/Videos|SelectDefaultVideoVersion}}

{{#lst:Settings/Media/Videos|ShowVideosWithMultipleVersionsAsFolder}}

= Creating a Version =
There are two methods to creating a Video Version as detailed below. The methods can be used singly or in combination with each other.

For example, you may initially manually scan a single title, then run an Update Library to scan additional titles and using the pop-up notifications to create the Video Version, or vice versa.

'''Note:''' During initial creation of a Video Version collection, the parent/default version needs to be scanned/scraped into the library (but changing via ''Set as default'' does not need scraping again). Child titles do not need to be scanned into the library as any metadata that is scanned/scraped is discarded once the title is added as a child version. Using the ''Browse files'' option in the Versions Manager method, a video file can be directly linked to a Version collection without scanning. Child versions always use the metadata of the parent title. The only downside to this method is if you have unique artwork for each version, this will not be scanned and artwork from the parent version will be used.

== Library Update Method ==
When using the this method, ensure the setting '''Ignore different video versions on scan''' is '''Disabled'''

{{kodi}} will scan titles into the library until it encounters a duplicate at which time the scanning pauses and requires a user response.

To create a Video Version, follow these steps.

# Run the Update Library function, or navigate to your Source and from the context menu select ''Scan for new content''
# When a title is scanned that is a duplicate of a title already in your library the ''Different movie version found'' dialogue will notify you
# Select '''Yes''' to add as a version or '''No''' to ignore and continue scanning
# When '''Yes''' is selected, the ''Add as a version to...'' pop-up will offer the matching parent title
# After selecting the parent title, from the ''Choose version'' pop-up, select what type of version this title is. If a pre-defined name is not listed, add a new name using the ''New version...'' button
# The Update Library scanner will continue with the scan until it finds another duplicate movie.

== Versions Manager Method ==
If you prefer to use the Versions Manager method rather than interrupting the Library Update runs, ensure the setting '''Ignore different video versions on scan''' is '''Enabled'''.

See the '''Add Version''' section below for details.

= Versions Manager =
Versions are managed through the Versions Manager. There are two methods to access the version manager shown in the following images...

<gallery mode="packed" widths="500px" heights="283px">
File:VideoVersionsManager.jpg| '''Image 1'''- In the library highlight the title that either currently is, or will become, the default version of the title and call up the Information Page<br/>Select the '''Versions''' button along the bottom row
File:VideoVersionsContext.jpg| '''Image 2'''- In the library highlight the title that either currently is, or will become, the default version of the title and call up the Context Menu<br/>Select '''Manage ► Manage versions'''
File:VideoVersionsManager01.jpg| '''Image 3'''- The Versions Manager
</gallery>

== Play ==
Play the selected title.

== Add Version ==
To add a new Version using the Version Manager follow these steps...

# Access the Versions Manager
# The pop-up box will display details of the parent movie. It defaults to "Standard Edition" but this can be changed using the '''Choose Type''' button
# To add another version, select '''Add version'''
#* If the message ''No similar movies were found in the library'' choose one of the following options:
#** '''Browse files'''- Browse your source folders to find another version of the movie. It will be scanned once selected
#** '''Browse library'''- Browse titles currently in the library and select the title from the library list.
#** '''Cancel'''- Cancel the operation
# From the pop-up box, scroll to select the next version to be added and press ''Enter'' or equivelant keypress
# From the next pop-up, select the version format. If a pre-defined name is not listed, add a new name using the ''New version...'' button
# The new version will be added
# To add additional versions, repeat these steps.

== Choose Art ==
Allows the changing of artwork for the highlighted version.

== Choose Type ==
Used to nominate the version type- i.e. ''Directors Cut, Extended Edition'' etc.

# Call up the Versions Manager
# Scroll to the version to be renamed
# Select ''Choose Type''
# From the ''Choose version'' dialogue,
#* Select the required version
#* If the required version is not listed, select the ''New version...'' button and add the name of the version type

== Remove ==
The only method that allows removal of individual child versions is the ''Remove Child Version'' method described in this section. Any other method you may use will remove the entire Version collection.

''Remove'' will remove a version from the library only and will not delete files from the file system. The setting '''[[Settings/Media/General#Allow_file_renaming_and_deletion| Allow file renaming and deletion]]''' has no effect. Be aware that running an Update Library will rescan the removed title back into the library.

=== Remove Version Collection ===
To remove the entire version collection from the library, use one of the following methods...

* Highlight the Video Version to be deleted from the library
** Press {{keypress|del}} on the keyboard, or
** Use ''[[Basic_controls#Context_Menu|Context Menu]]'' ► Manage ► Remove from library

=== Remove Child Version ===
To remove a single child version, use the following method...

# Call up the Versions Manager
# Scroll to the child version to be deleted
# Select ''Remove''
# If the button is greyed out this indicates you have selected the parent version. To delete the parent version see the next section.

=== Remove Parent Version ===
To remove the parent version without removing the entire collection, use the following method...

# Call up the Versions Manager
# The version manager lists all movies in the version. The parent version is the one with the ''Remove'' and ''Set as default'' buttons greyed out
# Select another version to become the parent version and press ''Set as default''
# Scroll back to the version to be deleted and select ''Remove''

== Set As Default ==
The default title allows immediate playback, instead of browsing for a version, when the setting '''Select default video version''' is enabled.

To change which version becomes default, use the following method...

# Call up the Versions Manager
# Highlight the version to be made as the new default version
# Select ''Set as default''

= NFO Files =
{{note| NFO file support is an incomplete feature in v21. Plans are to complete the feature in v22.}}

Exporting the library to ''Separate Files'' now exports the following Video Versions related xml tags:

<syntaxhighlight lang="xml">
<videoassettitle>Intl Theatrical Cut</videoassettitle>
<videoassetid>40801</videoassetid>
<videoassettype>0</videoassettype>
<hasvideoversions>true</hasvideoversions>
<hasvideoextras>false</hasvideoextras>
<isdefaultvideoversion>true</isdefaultvideoversion>
</syntaxhighlight>

The process to import these tags during scanning is not complete. As a result, you will still be asked if you would like to add movies as a version of an existing during scanning.

Once the nfo file module is complete, rebuilding from nfo files will automatically allocate movies to versions.

{{top}}

{{updated|21}}

[[Category:Karellen]]
[[Category:Video library]]

Add-on:The TVDB v4

2025-08-08T21:31:49Z

Karellen:

{{Addon
|Name=The TVDB v4
|provider-name=TVDB Team
|ID=metadata.tvshows.thetvdb.com.v4.python
|latest-version=1.1.6
|extension point=xbmc.metadata.scraper.tvshows
|provides=
|Summary=Fetch TV show metadata from TheTVDB.com
|Description=TheTVDB.com is a TV Scraper. The site is a massive open database that can be modified by anybody and contains full meta data for many shows in different languages. All content and images on the site have been contributed by their users for users and have a high standard or quality. The database schema and website are open source under the GPL.
|Platform=all
|Language=
|License=GPL-3.0-or-later
|Forum=
|Website=
|Source=
|Email=
|broken=
|icon url=http://mirrors.kodi.tv/addons/omega/metadata.tvshows.thetvdb.com.v4.python/media/icon.png}}

= Introduction =
TheTVDB v4 is the latest scraper developed by TheTVDB Team. It is written in Python and accesses the new v4 of the TheTVDB API.

This scraper is intended to replace all other scrapers that currently utilise TheTVDB site. It is expected that v1, v2 and v3 of TheTVDB API will be shutdown by then end of 2022, rendering the existing TheTVDB scrapers as broken.

TheTVDB v4 scraper accesses the following site to scrape your TV Shows, seasons and episodes:
* [https://thetvdb.com/ TheTVDB] - for metadata and artwork

= Settings =
{{#lst:Add-on:The_Movie_Database_Python|ScraperSettings}}

== General ==
[[File:TVDBv4-Settings01.jpg|700px]]

; Language
: Set which language of metadata to scrape. If the selected language is not available for a TV show, it will fall back to English.

; Season Type
: See next section ''Flexible Orders''

; Gender
: Please provide the gender of the primary user of this information. TheTVDB collects basic demographic information that we anonymize and combine to track worldwide TV and movie popularity. We provide this summarized information to partners in the entertainment space to help influence the production and licensing of content.

; Birth Year
: Please provide the birth year of the primary user of this information. TheTVDB collects basic demographic information that we anonymize and combine to track worldwide TV and movie popularity. We provide this summarized information to partners in the entertainment space to help influence the production and licensing of content.

; PIN
: Enter an optional TheTVDB subscriber PIN. Future extended functionality within this plugin may benefit from being a TheTVDB subscriber, which grants you a unique PIN to use within all of your TheTVDB-connected systems. This is not required for the functionality most users would expect, but it does help support TheTVDB as a free resource.

; Maximum Number of Images per Season <ref>https://github.com/thetvdb/metadata.tvshows.thetvdb.com.v4.python/pull/46</ref>
: Limits the number of artwork links for season posters to the specified number.
: When Kodi is connected to a shared database like MariaDB or MySQL, scraping shows with a large number of seasons, or highly popular shows with a large number of season posters per season, may cause the scraping process to fail. This is due to the length of the aggregated artwork links that the TVDB API returns which contains more characters than the database "Text" field can accommodate.<ref>https://github.com/xbmc/xbmc/issues/15768</ref> Game of Thrones and The Simpsons are two examples. This setting will help reduce the length of the artwork links bundle.

= Flexible Orders =
<gallery mode="packed" widths="500px" heights="293px">
File:TVDBv4-Settings03.jpg|Image 1- Check Season Order Type at TheTVDB
File:TVDBv4-Settings01.jpg|Image 2- General Settings
File:TVDBv4-Settings02.jpg|Image 3- Season Order Type
</gallery>

Some TV Shows are originally broadcast in one order (default order) but the order may be different when broadcasting in a different country (La Casa De Papel), or the DVD/Bluray release may have a different screening order (Firefly).

TheTVDB allows for up to 6 different Orders as follows:

: Standard Orders
:: * Default (Aired Order) - the primary order for the episodes of the TV show
:: * Absolute - Absolute ordering places all episodes in a single ordered season. This is generally used for anime.
:: * DVD - Used if the DVD/Bluray release uses a different order to the default order

: Flexible Orders
:: * Alternate - The first available flexible order
:: * Regional - The second available flexible order
:: * Alternate DVD - The third available flexible order

To use one of the Flexible Orders:
# Locate the TV show at TheTVDB and confirm that Flexible Orders are available (image 1, items 1 & 2.)
# Select the preferred order (image 1, item 2.). The SxxEyy type numbering of your episode files must match the episode numbering of your chosen order.
# Note the order name used by the API (image 1, item 3.)
# In the scraper settings select the ''Season Type'' setting, and select the correct API order (images 2 & 3). Change scraper settings using '''method 3''' detailed above in ''Settings''.
# Scrape as per normal.

:'''Note:''' Not all order types are available for each TV Show. Check the available orders for your show at TheTVDB

= Troubleshooting =
Having problems? Check these common problems and solutions

; No seasons or episodes are scraped, or are partially scraped
: Normally caused by setting an episode order in the scraper that is not available at TheTVDB. Check the Season Type setting, and select an order that is available at TheTVDB.

; I mess up my scrape because I forget to change the Season Type from the previous scrape
: Leave the Source settings with the default settings, which you would use for most scrapes. For the shows requiring a different order, drill down to the TV show folder, and change the scraper setting for the individual TV show by selecting ''Change content'' from the context menu.

= References =
<references />

{{top}}
{{updated|20}}

[[Category:Add-ons with license tag]]
[[Category:All add-ons]]
[[Category:Karellen]]
[[Category:Nexus]]
[[Category:TV scraper add-ons]]
[[Category:Video library]]
[[Category:Matrix add-on repository]]
[[Category:Nexus add-on repository]]
[[Category:Omega add-on repository]]

Add-on:The TVDB v4

2025-08-08T21:29:47Z

Karellen: v1.1.8 update

{{Addon
|Name=The TVDB v4
|provider-name=TVDB Team
|ID=metadata.tvshows.thetvdb.com.v4.python
|latest-version=1.1.6
|extension point=xbmc.metadata.scraper.tvshows
|provides=
|Summary=Fetch TV show metadata from TheTVDB.com
|Description=TheTVDB.com is a TV Scraper. The site is a massive open database that can be modified by anybody and contains full meta data for many shows in different languages. All content and images on the site have been contributed by their users for users and have a high standard or quality. The database schema and website are open source under the GPL.
|Platform=all
|Language=
|License=GPL-3.0-or-later
|Forum=
|Website=
|Source=
|Email=
|broken=
|icon url=http://mirrors.kodi.tv/addons/omega/metadata.tvshows.thetvdb.com.v4.python/media/icon.png}}

= Introduction =
TheTVDB v4 is the latest scraper developed by TheTVDB Team. It is written in Python and accesses the new v4 of the TheTVDB API.

This scraper is intended to replace all other scrapers that currently utilise TheTVDB site. It is expected that v1, v2 and v3 of TheTVDB API will be shutdown by then end of 2022, rendering the existing TheTVDB scrapers as broken.

TheTVDB v4 scraper accesses the following site to scrape your TV Shows, seasons and episodes:
* [https://thetvdb.com/ TheTVDB] - for metadata and artwork

= Settings =
{{#lst:Add-on:The_Movie_Database_Python|ScraperSettings}}

== General ==
[[File:TVDBv4-Settings01.jpg|700px]]

; Language
: Set which language of metadata to scrape. If the selected language is not available for a TV show, it will fall back to English.

; Season Type
: See next section ''Flexible Orders''

; Gender
: Please provide the gender of the primary user of this information. TheTVDB collects basic demographic information that we anonymize and combine to track worldwide TV and movie popularity. We provide this summarized information to partners in the entertainment space to help influence the production and licensing of content.

; Birth Year
: Please provide the birth year of the primary user of this information. TheTVDB collects basic demographic information that we anonymize and combine to track worldwide TV and movie popularity. We provide this summarized information to partners in the entertainment space to help influence the production and licensing of content.

; PIN
: Enter an optional TheTVDB subscriber PIN. Future extended functionality within this plugin may benefit from being a TheTVDB subscriber, which grants you a unique PIN to use within all of your TheTVDB-connected systems. This is not required for the functionality most users would expect, but it does help support TheTVDB as a free resource.

; Maximum Number of Images per Season <ref>https://github.com/thetvdb/metadata.tvshows.thetvdb.com.v4.python/pull/46</ref>
: Limits the number of artwork links for season posters to the specified number.
: When Kodi is connected to a shared database like MariaDB or MySQL, scraping shows with a large number of seasons, or highly popular shows with a large number of season posters per season, may cause the scraping process to fail. This is due to the length of the aggregated artwork links that the TVDB API returns which contains more characters than the database "Text" field can accommodate. Game of Thrones and The Simpsons are two examples. This setting will help reduce the length of the artwork links bundle.

= Flexible Orders =
<gallery mode="packed" widths="500px" heights="293px">
File:TVDBv4-Settings03.jpg|Image 1- Check Season Order Type at TheTVDB
File:TVDBv4-Settings01.jpg|Image 2- General Settings
File:TVDBv4-Settings02.jpg|Image 3- Season Order Type
</gallery>

Some TV Shows are originally broadcast in one order (default order) but the order may be different when broadcasting in a different country (La Casa De Papel), or the DVD/Bluray release may have a different screening order (Firefly).

TheTVDB allows for up to 6 different Orders as follows:

: Standard Orders
:: * Default (Aired Order) - the primary order for the episodes of the TV show
:: * Absolute - Absolute ordering places all episodes in a single ordered season. This is generally used for anime.
:: * DVD - Used if the DVD/Bluray release uses a different order to the default order

: Flexible Orders
:: * Alternate - The first available flexible order
:: * Regional - The second available flexible order
:: * Alternate DVD - The third available flexible order

To use one of the Flexible Orders:
# Locate the TV show at TheTVDB and confirm that Flexible Orders are available (image 1, items 1 & 2.)
# Select the preferred order (image 1, item 2.). The SxxEyy type numbering of your episode files must match the episode numbering of your chosen order.
# Note the order name used by the API (image 1, item 3.)
# In the scraper settings select the ''Season Type'' setting, and select the correct API order (images 2 & 3). Change scraper settings using '''method 3''' detailed above in ''Settings''.
# Scrape as per normal.

:'''Note:''' Not all order types are available for each TV Show. Check the available orders for your show at TheTVDB

= Troubleshooting =
Having problems? Check these common problems and solutions

; No seasons or episodes are scraped, or are partially scraped
: Normally caused by setting an episode order in the scraper that is not available at TheTVDB. Check the Season Type setting, and select an order that is available at TheTVDB.

; I mess up my scrape because I forget to change the Season Type from the previous scrape
: Leave the Source settings with the default settings, which you would use for most scrapes. For the shows requiring a different order, drill down to the TV show folder, and change the scraper setting for the individual TV show by selecting ''Change content'' from the context menu.

{{top}}
{{updated|20}}

[[Category:Add-ons with license tag]]
[[Category:All add-ons]]
[[Category:Karellen]]
[[Category:Nexus]]
[[Category:TV scraper add-ons]]
[[Category:Video library]]
[[Category:Matrix add-on repository]]
[[Category:Nexus add-on repository]]
[[Category:Omega add-on repository]]

File:TVDBv4-Settings01.jpg

2025-08-08T21:17:31Z

Karellen: Karellen uploaded a new version of File:TVDBv4-Settings01.jpg

File uploaded with MsUpload

Basic playlists

2025-08-05T03:39:14Z

Karellen: v21 updates

{{mininav|[[Playlists]] }}

= Introduction =
<section begin="intro" />The Basic Playlist is a user created list of music or video that does not require a correctly scraped library as it uses the folder paths to the media files. As the playlist is based on paths, different classes of media can be mixed, like movies and episodes. The list can be created within {{kodi}} or transferred from another media player.<section end="intro" />

If your list of music or video has a common theme like genre, year, artist, studio, actor, etc, then you should consider using '''[[Smart playlists]]''' which will automatically generate the playlist based on rules. If the titles are random and there is no similarity between the items you want to group, then a manually created Basic Playlist is the best option.

'''Note:''' Depending on your setup, the m3u file may use relative paths to local content. If you then transfer a playlist file to another media player on different hardware, even though it has access to the same content, the paths may be different and {{kodi}} will be unable to find the media. Use Absolute paths where possible.

= Playlist Files =
The {{kodi}} generated basic playlist file is in the '''m3u''' format.

== Supported Formats ==
{{kodi}} supports the following playlist files:
* b4s - Playlist supported by Winamp Media Player<ref>https://github.com/xbmc/xbmc/pull/23450</ref>
* [http://en.wikipedia.org/wiki/Cue_sheet Cue Sheets for music]
* [http://en.wikipedia.org/wiki/M3U m3u] (default)
* m3u8 <small>(added in v21 Omega)</small><ref>https://github.com/xbmc/xbmc/pull/21992</ref>
* [http://en.wikipedia.org/wiki/PLS_%28file_format%29 PLS]
* [[Smart playlists|Smart playlist .xsp files]]
* [[Internet_video_and_audio_streams|Stream files (.strm)]]
* [https://en.wikipedia.org/wiki/Windows_Media_Player_Playlist| Windows Media Player .wpl files]

== Location of Playlist Files ==
Playlist files are are located in the '''[[userdata]]/playlists''' folder. The location of this folder for each platform is shown in the table below.

{{#lst:Userdata|location all}}

== Editing m3u Files ==
If you choose to manually create your m3u playlists, then any text editor will suffice, but we recommend using an editor that can parse XML such as [https://code.visualstudio.com/Download Visual Studio Code] or [https://notepad-plus-plus.org/ Notepad++].

= Use External Playlists =
If you have a playlist that you manually created, or one that was created by another media player that:
# Is in a format supported by {{kodi}} as detailed above, and
# The file paths are valid as described in the Introduction note, and
# Is saved in the correct playlist subfolder

Then you can use {{kodi}} to play it.

= Playlist Editor =
{{kodi}} has a built in Playlist Editor where playlists can be created and edited.

== Playlist Editor Location ==
The Playlist Managers are located as follows:

; Music library
: From the '''[[Basic_controls#Introduction|Main Menu]]''' navigate to {{highlight|Music > Playlists}}
:* Select ''New Playlist...'' to create a new playlist
:* Highlight an existing Playlist and from the '''[[Basic_controls#Context_Menu|Context menu]]''' select ''Edit playlist'' to edit an existing playlist

; Video library
: There is no playlist editor for the Video library. Use the Queue Method (next section) or create the playlist externally.

== Using Playlist Editor ==
<gallery mode="packed" widths="600px" heights="337px">
File:Music-Playlist02.jpg|Image 1- Starting a new playlist in Music
File:Music-Playlist03.jpg|Image 2- Adding music items to the playlist
</gallery>

; Editor Layout
:* '''Left panel''' contains the Action buttons
:* '''Middle panel''' used to navigate to your music
:* '''Right panel''' contains the songs in the playlist

; Create New Playlist
: Decide how to locate your music files to add to the playlist-
:* '''Files'''- Navigate the folder structure of your files
:* '''Library'''- Navigate the library nodes
:* '''Music Videos'''- Also add music videos to the playlist
: Whichever method you choose, the file paths are stored in the playlist.

; What can be added to the Playlist
:* '''Artist'''- Selecting an Artist will add all songs attributed to the Artist
:* '''Album'''- Adding an Album will add all songs in the album
:* '''Song'''- Add an individual song

; Adding Items
: Highlight the item to be added then using one of the following two methods
:* Press {{keypress|Q}} on your keyboard, or
:* From the ''[[Basic_controls#Context_Menu|Context Menu]]'' select '''Add'''
: The items will appear in the right panel in the order they are added.

; Reorganise Items
: To reorganise the order of the playlist items, move across to the right panel and on a [[Keyboard_controls|keyboard]] select
:* {{keypress|U}} - Move selected up
:* {{keypress|D}} - Move selected down
:* {{keypress|DEL}} - Remove from playlist.
: Alternatively, use the ''[[Basic_controls#Context_Menu|Context Menu]]'' which contains the same action options.
: A remote control with the proper [[keymap]] additions can also use those actions.

; Save the Playlist
: Select '''Save''' from the left panel and enter a playlist name when prompted. The playlist will be accessible from {{highlight|Music > Playlists}}
: A music m3u playlist is always saved in \playlists\music\ even if it contains music videos.

; Edit Existing Playlist
: To open and edit an existing playlist, use one of the following methods
:* From the left panel, select '''Open''' and navigate to your playlist
:* In your list of Playlists, highlight the playlist and select '''Edit playlist''' from the ''[[Basic_controls#Context_Menu|Context Menu]]''

; Delete Playlist
: From your list of Playlists, highlight the playlist and select '''Delete''' from the ''[[Basic_controls#Context_Menu|Context Menu]]''

= Queue Method =
While browsing your library, you have the ability to queue items for playback. These items are added to a temporary playlist.

This temporary playlist can be accessed from the ''[[Basic_controls#Sideblade_Menu|Sideblade menu]]'' and can be further edited and saved as a Basic playlist.

Using this method, Basic Playlists can be created for Music and Videos from either the files or library structure.

<gallery mode="packed" widths="400px" heights="225px">
File:Music-Playlist04.jpg|Image 3- Browse your library or browse your folder structure
File:Music-Playlist05.jpg|Image 4- Select '''Go to playlist''' from the left sideblade menu
File:Music-Playlist06.jpg|Image 5- The playlist view. Note the combined Movies and Episodes.
</gallery>

; Adding Items
: Highlight the item to be added then using one of the following two methods
:* Press {{keypress|Q}} on your keyboard, or
:* From the ''[[Basic_controls#Context_Menu|Context Menu]]'' select '''Queue item'''
: Repeat as necessary and all items will be added to the temporary playlist.

; Accessing the Playlist
: From the ''[[Basic_controls#Sideblade_Menu|Sideblade menu]]'' select '''Go to playlist'''
: Once you enter the playlist, the options for editing and saving are similar to the Playlist Editor detailed above.

= References =
<references />

{{top}}

{{updated|21}}
[[Category:Karellen]]
[[Category:Video library]]
[[Category:Music library]]

Player process info

2025-08-05T03:32:21Z

Karellen:

{{mininav|[[Video library]]|[[Video playback|Playback]]}}

= Introduction =
<section begin="intro" />{{Kodi}} can display information about the system and the media that is currently being played. This information is available through a number of on-screen overlays.<section end="intro" />

= Player Process Info =
The Player Process Information OSD details the static information (metadata) of the Audio and Video streams in use.

The OSD can be activated using one of the following methods...
*Pressing {{keypress|o}} on a keyboard
*Pressing the equivalent key on your remote control. This is not a standard button press and will need to be mapped to your remote control. '''''See: [[Add-on:Keymap_Editor|Keymap Editor]]'''''
*Using one of the remote control Apps, special functions are available to activate and deactivate this OSD

<gallery mode="packed" widths="500px" heights="283px">
Video-Playback-OSD-12.jpg|Image 1 - The Media Process Information overlay
Video Playback OSD 08.jpg|Image 2 - The Player Process Information overlay
Video-Playback-OSD-13.jpg|Image 3 - The System Process Information overlay
</gallery>

The following is a brief description of the information being displayed:

=== Media ===
This screen provides details of the Audio and Video streams of the media file currently playing

=== Player ===
; Video decoder
: Describes the video decoder currently in use. The decoder will vary depending on operating system. See... [https://trac.ffmpeg.org/wiki/HWAccelIntro Intro to FFmpeg Decoders]
: The item in brackets indicates whether decoding is currently being performed by Hardware (HW) or Software (SW). See... [[Settings/Player/Videos#Platform_Specific_Hardware_Acceleration_settings|Platform Specific Hardware Acceleration settings]]

; Pixel format
: The pixel format in use.<ref>https://www.amd.com/en/support/kb/faq/dh2-007</ref> <ref>https://ffmpeg.org/doxygen/3.2/pixfmt_8h.html#a9a8e335cf3be472042bc9f0cf80cd4c5</ref>

; Deinterlace method
: The method used to [[w:Deinterlacing|deinterlace]] the currently playing video stream, if required.

; Video stream
: A number of items detailing the properties of the video stream. The values shown in the image are an example and will vary with the media being played.
:: ''1,920x1,080p'' - Resolution of the image in pixels based on the Storage Aspect Ratio (SAR), and scan type identifier - '''p''' for progressive scan or '''i''' for interlaced scan
:: ''1.78 AR'' - The aspect ratio of the image. Based on the Display Aspect Ratio (DAR)
:: ''25.000 FPS'' - The frame rate of the video stream

; Player cache
: The status of the cache. 100% = fully utilised

; Audio decoder
: ''ac3'' - The audio coding format

; Audio channels
: ''FL,FR'' - The audio channels in the audio stream. When using Audio Passthrough settings, the channels will be displayed as ''raw''

; Audio stream
:: ''32 bits'' - The bit depth of the audio stream
:: ''48,000 Hz'' - The sample rate

=== System ===
; Screen resolution
: The resolution and refresh rate of the display

; System rendering speed
: Frame rate

; System memory usage
: The memory currently being used on the system. This is a total usage by all processes, not just {{kodi}}

; System CPU usage
: The CPU currently being used on the system. This is a total usage by all processes, not just {{kodi}}

; CPU temperature
: Where available, will display the core temperatures.

= Player Debug Info =
The Player Debug Info screen displays real-time dynamic data of the current audio/video streams.

'''Note''' - What is displayed will depend on your settings for '''[[Settings/Player/Videos#Sync_playback_to_display | Sync playback to display]]''' and '''[[Settings/Player/Videos#Adjust_display_refresh_rate | Adjust display refresh rate]]'''

The OSD can be activated using one of the following methods...
*Pressing {{keypress|ctrl|shift|o}} on a keyboard
*Pressing the equivalent key on your remote control. This is not a standard button press and will need to be mapped to your remote control. '''''See: [[Add-on:Keymap_Editor|Keymap Editor]]'''''
*Using one of the remote control Apps, special functions are available to activate and deactivate this OSD

<gallery mode="packed" widths="700px" heights="394px">
Video Playback OSD 09.jpg|Image 4 - The Player Debug Information overlay
</gallery>

The following is a brief description of the information being displayed:

; Line 1
: ''aq:95%'' - The audio queue saturation
: ''Kb/s:379.70'' - Current audio bitrate reported by the player
: ''a/v corrections'' - The corrections required to sync the audio and video streams. <ref>https://github.com/xbmc/xbmc/pull/22770</ref>
:: The (50ms) is the out-of-sync delay to align the streams. It is calculated at the start of playback.
:: The count, 0 in the image, indicates the number of times corrections have been made during playback.<ref>https://forum.kodi.tv/showthread.php?tid=371292</ref>

; Line 2
: ''vq:95%'' - Video queue saturation
: ''Mb/s:0.26'' - Current video bitrate reported by the player
: ''fr:25.000'' - Frame rate
: ''drop:23'' - Number of dropped frames
: ''skip:11'' - Number of skipped frames
: ''pc:1'' - Pullup correction pattern length

; Player
: ''a/v:-0.022'' - Audio/video sync difference in real time
: ''forward: 22.06 MB / 92% / 38.433s / 1.329%'' - Cached forward MB / % of cache filled / estimated playback time of current cached bytes / percentage of stream cached <ref>https://github.com/xbmc/xbmc/pull/22881</ref><ref>https://github.com/xbmc/xbmc/pull/24117</ref>
: ''100%'' - Percentage of cache in use

; VSync
: ''VSyncOff: -11.2'' - Indicates the offset between the vertical sync signal of the display and the timestamps of the video frames. This offset is used for audio visual synchronisation. <ref>https://forum.kodi.tv/showthread.php?tid=332156&pid=2737399#pid2737399</ref>
:: If ''VSyncOff'' is greater than zero and constant, then synchronisation is all good.
:: If the value shows 0.0, the framerate (fps) of the video does not match the refresh rate (Hz) of the display which may cause micro-stuttering of the video, especially during panning shots.
: ''Latency: 0.080'' - Adjustment in seconds required to sync audio and video

= Video Debug Info =
{{red|'''This display is available on MS Windows systems only.'''}}

The Video Debug Info screen displays additional video stream and HDR metadata, shader and swapchain information (flip, discard / sequential), Windows HDR state, all of which are not available elsewhere in {{kodi}}<ref>https://github.com/xbmc/xbmc/pull/19126</ref>

The OSD can be activated using one of the following methods...
*Pressing {{keypress|alt|o}} on a keyboard
*Pressing the equivalent key on your remote control. This is not a standard button press and will need to be mapped to your remote control. '''''See: [[Add-on:Keymap_Editor|Keymap Editor]]'''''
*Using one of the remote control Apps, special functions may be available to activate and deactivate this OSD

<gallery mode="packed" widths="700px" heights="394px">
Video-playback-OSD-14.jpg|Image 5 - The Video Debug Information overlay
</gallery>

= Display Info =
The Display Information screen displays the View Mode, Aspect Ratio and other display related data.

The OSD can be activated using one of the following methods...
*Pressing {{keypress|z}} on a keyboard
*Pressing the equivalent key on your remote control. This is not a standard button press and will need to be mapped to your remote control. '''''See: [[Add-on:Keymap_Editor|Keymap Editor]]'''''
*Using one of the remote control Apps, special functions are available to activate and deactivate this OSD

<gallery mode="packed" widths="700px" heights="394px">
Video Playback OSD 10.jpg|Image 6 - The Display Information overlay
</gallery>

The following data is displayed

;View Mode
:The zoom/crop/stretch mode currently in use. For available options see: '''''[[Video_playback#Video_Settings|Video Settings]]'''''.

;Sizing
:Information about the output display of the video stream
::('''720,576''')->('''1920,1080''') '''=''' (Resolution of video)->(Output resolution) Reveals any upscaling or downscaling. The example shows upscaling by {{kodi}} and your TV may further upscale. eg in this example a 4K TV will upscale from 1920x1080 to 3840x2160.
::('''Zoom x1.00''') Reveals if any zoom has been applied
::'''AR:1.78:1''' Aspect Ratio of video
::('''Pixels: 1.00:1''') Pixel ratio in use
::('''VShift: 0.00''') Amount of Vertical Shift applied
:''See:''' [[Video_playback#Video_Settings|Video Settings]]''''' for more information.

;Screen resolution:
:Reported resolution to {{kodi}}. Usually the resolution set on the graphics card, and the TV may then further upscale. Also displays the type of Full Screen in use.
{{-}}

= Debug Mode =
Although normally used to enable debug logging in the {{kodi}} log files, the overlay provides additional useful information.

The Debug Mode can be activated using one of the following methods...

{{#lst:Log_file/Easy|EnableDebugMode}}

<gallery mode="packed" widths="700px" heights="394px">
DebugMode01.jpg|Image 7 - The Debug Mode Information overlay
</gallery>

; LOG
: Reveals the location of the debug log

; MEM
: System memory available / Total system memory in Kilobytes

; FPS
: The refresh rate of the display

; CPU
: #The CPU thread : The work load on the thread as a percentage of maximum rated

= References =
<References />

{{top}}

{{updated|22}}
[[Category:Karellen]]
[[Category:Video library]]

Settings/Services/Caching

2025-08-05T03:25:41Z

Karellen:

{{mininav| [[Settings]] | [[Settings/Services|Services]] }}

__TOC__

<gallery mode="packed" widths="700px" heights="394px">
File:Settings-Services-Caching-01.jpg
</gallery>

= General =
These cache settings were previously added and modified via the [[Advancedsettings.xml]] file. In v21 Omega these settings were moved to the {{kodi}} GUI settings pages.<ref>https://github.com/xbmc/xbmc/pull/24049</ref>

There are no changes to these settings and they work as they did when they were added to the advancedsettings.xml file.

'''Note:''' The advancedsettings.xml method of adding these settings is deprecated. Any tags you still may have in the file will be ignored.

== Buffer Mode ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Choose what to buffer:
* No buffer
* Only buffer true internet streams: HTTP, HTTPS, etc
* Buffer all internet filesystems, including: FTP, WebDAV, etc.
* Buffer all network filesystems, including: SMB, NFS, etc.
* Buffer all filesystems, including local files
|}

== Memory Size ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Select the number of megabytes used for buffering streams in memory. When set to 0 the cache will be written to disk instead of RAM
|}

== Read Factor ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| This factor determines the max readrate in terms of readfactor * avg bitrate of a video file. This can help on bad connections to keep the cache filled. It will also greatly speed up buffering. Default value is 4x.

Low read factors work better on less powerful Android devices as it prevents CPU spikes and minimises the chance of over-saturating the network connection when using high bitrate media content (Bluray / UHD Bluray). But there were some drawbacks which are solved by the ''Adaptive'' option. It uses a more aggressive read factor when the cache is empty or low, and throttles back the read rate as the cache fills eventually settling down to a 1.5x read factor when the cache is filled and stable.<ref>https://github.com/xbmc/xbmc/pull/24640</ref>
|}

= Chunk Size =

== Chunk Size ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Allows the selection of the chunk size which may improve data throughput. May aid in better playback of high bit-rate UHD files, especially on low-powered devices or slow networks. <ref>https://github.com/xbmc/xbmc/pull/24019</ref>

Select from:
* 16 KB
* 32 KB
* 64 KB
* 128 KB (default)
* 256 KB
* 512 KB
* 1 MB
|}

= References =
<references />

{{updated|21}}

[[Category:Settings]]
[[Category:File sharing]]

Player process info

2025-08-05T03:14:57Z

Karellen: Updates for v22

{{mininav|[[Video library]]|[[Video playback|Playback]]}}

= Introduction =
<section begin="intro" />{{Kodi}} can display information about the system and the media that is currently being played. This information is available through a number of on-screen overlays.<section end="intro" />

= Player Process Info =
The Player Process Information OSD details the static information (metadata) of the Audio and Video streams in use.

The OSD can be activated using one of the following methods...
*Pressing {{keypress|o}} on a keyboard
*Pressing the equivalent key on your remote control. This is not a standard button press and will need to be mapped to your remote control. '''''See: [[Add-on:Keymap_Editor|Keymap Editor]]'''''
*Using one of the remote control Apps, special functions are available to activate and deactivate this OSD

<gallery mode="packed" widths="500px" heights="283px">
Video-Playback-OSD-12.jpg|Image 1 - The Media Process Information overlay
Video Playback OSD 08.jpg|Image 2 - The Player Process Information overlay
Video-Playback-OSD-13.jpg|Image 3 - The System Process Information overlay
</gallery>

The following is a brief description of the information being displayed:

=== Media ===
This screen provides details of the Audio and Video streams of the media file currently playing

=== Player ===
; Video decoder
: Describes the video decoder currently in use. The decoder will vary depending on operating system. See... [https://trac.ffmpeg.org/wiki/HWAccelIntro Intro to FFmpeg Decoders]
: The item in brackets indicates whether decoding is currently being performed by Hardware (HW) or Software (SW). See... [[Settings/Player/Videos#Platform_Specific_Hardware_Acceleration_settings|Platform Specific Hardware Acceleration settings]]

; Pixel format
: The pixel format in use.<ref>https://www.amd.com/en/support/kb/faq/dh2-007</ref> <ref>https://ffmpeg.org/doxygen/3.2/pixfmt_8h.html#a9a8e335cf3be472042bc9f0cf80cd4c5</ref>

; Deinterlace method
: The method used to [[w:Deinterlacing|deinterlace]] the currently playing video stream, if required.

; Video stream
: A number of items detailing the properties of the video stream. The values shown in the image are an example and will vary with the media being played.
:: ''1,920x1,080p'' - Resolution of the image in pixels based on the Storage Aspect Ratio (SAR), and scan type identifier - '''p''' for progressive scan or '''i''' for interlaced scan
:: ''1.78 AR'' - The aspect ratio of the image. Based on the Display Aspect Ratio (DAR)
:: ''25.000 FPS'' - The frame rate of the video stream

; Player cache
: The status of the cache. 100% = fully utilised

; Audio decoder
: ''ac3'' - The audio coding format

; Audio channels
: ''FL,FR'' - The audio channels in the audio stream. When using Audio Passthrough settings, the channels will be displayed as ''raw''

; Audio stream
:: ''32 bits'' - The bit depth of the audio stream
:: ''48,000 Hz'' - The sample rate

=== System ===
; Screen resolution
: The resolution and refresh rate of the display

; System rendering speed
: Frame rate

; System memory usage
: The memory currently being used on the system. This is a total usage by all processes, not just {{kodi}}

; System CPU usage
: The CPU currently being used on the system. This is a total usage by all processes, not just {{kodi}}

; CPU temperature
: Where available, will display the core temperatures.

= Player Debug Info =
The Player Debug Info screen displays real-time dynamic data of the current audio/video streams.

'''Note''' - What is displayed will depend on your settings for '''[[Settings/Player/Videos#Sync_playback_to_display | Sync playback to display]]''' and '''[[Settings/Player/Videos#Adjust_display_refresh_rate | Adjust display refresh rate]]'''

The OSD can be activated using one of the following methods...
*Pressing {{keypress|ctrl|shift|o}} on a keyboard
*Pressing the equivalent key on your remote control. This is not a standard button press and will need to be mapped to your remote control. '''''See: [[Add-on:Keymap_Editor|Keymap Editor]]'''''
*Using one of the remote control Apps, special functions are available to activate and deactivate this OSD

<gallery mode="packed" widths="700px" heights="394px">
Video Playback OSD 09.jpg|Image 4 - The Player Debug Information overlay
</gallery>

The following is a brief description of the information being displayed:

; Line 1
: ''aq:95%'' - The audio queue saturation
: ''Kb/s:379.70'' - Current audio bitrate reported by the player
: ''a/v corrections'' - The corrections required to sync the audio and video streams. <ref>https://github.com/xbmc/xbmc/pull/22770</ref>
:: The (50ms) is the out-of-sync delay to align the streams. It is calculated at the start of playback.
:: The count, 0 in the image, indicates the number of times corrections have been made during playback.<ref>https://forum.kodi.tv/showthread.php?tid=371292</ref>

; Line 2
: ''vq:95%'' - Video queue saturation
: ''Mb/s:0.26'' - Current video bitrate reported by the player
: ''fr:25.000'' - Frame rate
: ''drop:23'' - Number of dropped frames
: ''skip:11'' - Number of skipped frames
: ''pc:1'' - Pullup correction pattern length

; Player
: ''a/v:-0.022'' - Audio/video sync difference in real time
: ''forward: 22.06 MB / 92% / 38.433s / 1.329%'' - Cache amount in MB / % of cache filled / estimated playback time of current cached bytes / percentage of movie cached <ref>https://github.com/xbmc/xbmc/pull/22881</ref>
: ''100%'' - Percentage of cache in use

; VSync
: ''VSyncOff: -11.2'' - Indicates the offset between the vertical sync signal of the display and the timestamps of the video frames. This offset is used for audio visual synchronisation. <ref>https://forum.kodi.tv/showthread.php?tid=332156&pid=2737399#pid2737399</ref>
:: If ''VSyncOff'' is greater than zero and constant, then synchronisation is all good.
:: If the value shows 0.0, the framerate (fps) of the video does not match the refresh rate (Hz) of the display which may cause micro-stuttering of the video, especially during panning shots.
: ''Latency: 0.080'' - Adjustment in seconds required to sync audio and video

= Video Debug Info =
{{red|'''This display is available on MS Windows systems only.'''}}

The Video Debug Info screen displays additional video stream and HDR metadata, shader and swapchain information (flip, discard / sequential), Windows HDR state, all of which are not available elsewhere in {{kodi}}<ref>https://github.com/xbmc/xbmc/pull/19126</ref>

The OSD can be activated using one of the following methods...
*Pressing {{keypress|alt|o}} on a keyboard
*Pressing the equivalent key on your remote control. This is not a standard button press and will need to be mapped to your remote control. '''''See: [[Add-on:Keymap_Editor|Keymap Editor]]'''''
*Using one of the remote control Apps, special functions may be available to activate and deactivate this OSD

<gallery mode="packed" widths="700px" heights="394px">
Video-playback-OSD-14.jpg|Image 5 - The Video Debug Information overlay
</gallery>

= Display Info =
The Display Information screen displays the View Mode, Aspect Ratio and other display related data.

The OSD can be activated using one of the following methods...
*Pressing {{keypress|z}} on a keyboard
*Pressing the equivalent key on your remote control. This is not a standard button press and will need to be mapped to your remote control. '''''See: [[Add-on:Keymap_Editor|Keymap Editor]]'''''
*Using one of the remote control Apps, special functions are available to activate and deactivate this OSD

<gallery mode="packed" widths="700px" heights="394px">
Video Playback OSD 10.jpg|Image 6 - The Display Information overlay
</gallery>

The following data is displayed

;View Mode
:The zoom/crop/stretch mode currently in use. For available options see: '''''[[Video_playback#Video_Settings|Video Settings]]'''''.

;Sizing
:Information about the output display of the video stream
::('''720,576''')->('''1920,1080''') '''=''' (Resolution of video)->(Output resolution) Reveals any upscaling or downscaling. The example shows upscaling by {{kodi}} and your TV may further upscale. eg in this example a 4K TV will upscale from 1920x1080 to 3840x2160.
::('''Zoom x1.00''') Reveals if any zoom has been applied
::'''AR:1.78:1''' Aspect Ratio of video
::('''Pixels: 1.00:1''') Pixel ratio in use
::('''VShift: 0.00''') Amount of Vertical Shift applied
:''See:''' [[Video_playback#Video_Settings|Video Settings]]''''' for more information.

;Screen resolution:
:Reported resolution to {{kodi}}. Usually the resolution set on the graphics card, and the TV may then further upscale. Also displays the type of Full Screen in use.
{{-}}

= Debug Mode =
Although normally used to enable debug logging in the {{kodi}} log files, the overlay provides additional useful information.

The Debug Mode can be activated using one of the following methods...

{{#lst:Log_file/Easy|EnableDebugMode}}

<gallery mode="packed" widths="700px" heights="394px">
DebugMode01.jpg|Image 7 - The Debug Mode Information overlay
</gallery>

; LOG
: Reveals the location of the debug log

; MEM
: System memory available / Total system memory in Kilobytes

; FPS
: The refresh rate of the display

; CPU
: #The CPU thread : The work load on the thread as a percentage of maximum rated

= References =
<References />

{{top}}

{{updated|22}}
[[Category:Karellen]]
[[Category:Video library]]

Player process info

2025-08-05T03:09:57Z

Karellen: Updates for v22

{{mininav|[[Video library]]|[[Video playback|Playback]]}}

= Introduction =
<section begin="intro" />{{Kodi}} can display information about the system and the media that is currently being played. This information is available through a number of on-screen overlays.<section end="intro" />

= Player Process Info =
The Player Process Information OSD details the static information (metadata) of the Audio and Video streams in use.

The OSD can be activated using one of the following methods...
*Pressing {{keypress|o}} on a keyboard
*Pressing the equivalent key on your remote control. This is not a standard button press and will need to be mapped to your remote control. '''''See: [[Add-on:Keymap_Editor|Keymap Editor]]'''''
*Using one of the remote control Apps, special functions are available to activate and deactivate this OSD

<gallery mode="packed" widths="500px" heights="283px">
Video-Playback-OSD-12.jpg|Image 1 - The Media Process Information overlay
Video Playback OSD 08.jpg|Image 2 - The Player Process Information overlay
Video-Playback-OSD-13.jpg|Image 3 - The System Process Information overlay
</gallery>

The following is a brief description of the information being displayed:

=== Media ===
This screen provides details of the Audio and Video streams of the media file currently playing

=== Player ===
; Video decoder
: Describes the video decoder currently in use. The decoder will vary depending on operating system. See... [https://trac.ffmpeg.org/wiki/HWAccelIntro Intro to FFmpeg Decoders]
: The item in brackets indicates whether decoding is currently being performed by Hardware (HW) or Software (SW). See... [[Settings/Player/Videos#Platform_Specific_Hardware_Acceleration_settings|Platform Specific Hardware Acceleration settings]]

; Pixel format
: The pixel format in use.<ref>https://www.amd.com/en/support/kb/faq/dh2-007</ref> <ref>https://ffmpeg.org/doxygen/3.2/pixfmt_8h.html#a9a8e335cf3be472042bc9f0cf80cd4c5</ref>

; Deinterlace method
: The method used to [[w:Deinterlacing|deinterlace]] the currently playing video stream, if required.

; Video stream
: A number of items detailing the properties of the video stream. The values shown in the image are an example and will vary with the media being played.
:: ''1,920x1,080p'' - Resolution of the image in pixels based on the Storage Aspect Ratio (SAR), and scan type identifier - '''p''' for progressive scan or '''i''' for interlaced scan
:: ''1.78 AR'' - The aspect ratio of the image. Based on the Display Aspect Ratio (DAR)
:: ''25.000 FPS'' - The frame rate of the video stream

; Player cache
: The status of the cache. 100% = fully utilised

; Audio decoder
: ''ac3'' - The audio coding format

; Audio channels
: ''FL,FR'' - The audio channels in the audio stream. When using Audio Passthrough settings, the channels will be displayed as ''raw''

; Audio stream
:: ''32 bits'' - The bit depth of the audio stream
:: ''48,000 Hz'' - The sample rate

=== System ===
; Screen resolution
: The resolution and refresh rate of the display

; System rendering speed
: Frame rate

; System memory usage
: The memory currently being used on the system. This is a total usage by all processes, not just {{kodi}}

; System CPU usage
: The CPU currently being used on the system. This is a total usage by all processes, not just {{kodi}}

; CPU temperature
: Where available, will display the core temperatures.

= Player Debug Info =
The Player Debug Info screen displays real-time dynamic data of the current audio/video streams.

'''Note''' - What is displayed will depend on your settings for '''[[Settings/Player/Videos#Sync_playback_to_display | Sync playback to display]]''' and '''[[Settings/Player/Videos#Adjust_display_refresh_rate | Adjust display refresh rate]]'''

The OSD can be activated using one of the following methods...
*Pressing {{keypress|ctrl|shift|o}} on a keyboard
*Pressing the equivalent key on your remote control. This is not a standard button press and will need to be mapped to your remote control. '''''See: [[Add-on:Keymap_Editor|Keymap Editor]]'''''
*Using one of the remote control Apps, special functions are available to activate and deactivate this OSD

<gallery mode="packed" widths="700px" heights="394px">
Video Playback OSD 09.jpg|Image 4 - The Player Debug Information overlay
</gallery>

The following is a brief description of the information being displayed:

; Line 1
: ''aq:95%'' - The audio queue saturation
: ''Kb/s:379.70'' - Current audio bitrate reported by the player
: ''a/v corrections'' - The corrections required to sync the audio and video streams. <ref>https://github.com/xbmc/xbmc/pull/22770</ref>
:: The (50ms) is the out-of-sync delay to align the streams. It is calculated at the start of playback.
:: The count, 0 in the image, indicates the number of times corrections have been made during playback.<ref>https://forum.kodi.tv/showthread.php?tid=371292</ref>

; Line 2
: ''vq:95%'' - Video queue saturation
: ''Mb/s:0.26'' - Current video bitrate reported by the player
: ''fr:25.000'' - Frame rate
: ''drop:23'' - Number of dropped frames
: ''skip:11'' - Number of skipped frames
: ''pc:1'' - Pullup correction pattern length

; Player
: ''a/v:-0.022'' - Audio/video sync difference in real time
: ''forward: 22.06 MB / 92% / 38.433s / 1.329%'' - Cache amount in MB / % of cache filled / number of seconds cached / percentage of movie cached
: ''100%'' - Percentage of cache in use

; VSync
: ''VSyncOff: -11.2'' - Indicates the offset between the vertical sync signal of the display and the timestamps of the video frames. This offset is used for audio visual synchronisation. <ref>https://forum.kodi.tv/showthread.php?tid=332156&pid=2737399#pid2737399</ref>
:: If ''VSyncOff'' is greater than zero and constant, then synchronisation is all good.
:: If the value shows 0.0, the framerate (fps) of the video does not match the refresh rate (Hz) of the display which may cause micro-stuttering of the video, especially during panning shots.
: ''Latency: 0.080'' - Adjustment in seconds required to sync audio and video

= Video Debug Info =
{{red|'''This display is available on MS Windows systems only.'''}}

The Video Debug Info screen displays additional video stream and HDR metadata, shader and swapchain information (flip, discard / sequential), Windows HDR state, all of which are not available elsewhere in {{kodi}}<ref>https://github.com/xbmc/xbmc/pull/19126</ref>

The OSD can be activated using one of the following methods...
*Pressing {{keypress|alt|o}} on a keyboard
*Pressing the equivalent key on your remote control. This is not a standard button press and will need to be mapped to your remote control. '''''See: [[Add-on:Keymap_Editor|Keymap Editor]]'''''
*Using one of the remote control Apps, special functions may be available to activate and deactivate this OSD

<gallery mode="packed" widths="700px" heights="394px">
Video-playback-OSD-14.jpg|Image 5 - The Video Debug Information overlay
</gallery>

= Display Info =
The Display Information screen displays the View Mode, Aspect Ratio and other display related data.

The OSD can be activated using one of the following methods...
*Pressing {{keypress|z}} on a keyboard
*Pressing the equivalent key on your remote control. This is not a standard button press and will need to be mapped to your remote control. '''''See: [[Add-on:Keymap_Editor|Keymap Editor]]'''''
*Using one of the remote control Apps, special functions are available to activate and deactivate this OSD

<gallery mode="packed" widths="700px" heights="394px">
Video Playback OSD 10.jpg|Image 6 - The Display Information overlay
</gallery>

The following data is displayed

;View Mode
:The zoom/crop/stretch mode currently in use. For available options see: '''''[[Video_playback#Video_Settings|Video Settings]]'''''.

;Sizing
:Information about the output display of the video stream
::('''720,576''')->('''1920,1080''') '''=''' (Resolution of video)->(Output resolution) Reveals any upscaling or downscaling. The example shows upscaling by {{kodi}} and your TV may further upscale. eg in this example a 4K TV will upscale from 1920x1080 to 3840x2160.
::('''Zoom x1.00''') Reveals if any zoom has been applied
::'''AR:1.78:1''' Aspect Ratio of video
::('''Pixels: 1.00:1''') Pixel ratio in use
::('''VShift: 0.00''') Amount of Vertical Shift applied
:''See:''' [[Video_playback#Video_Settings|Video Settings]]''''' for more information.

;Screen resolution:
:Reported resolution to {{kodi}}. Usually the resolution set on the graphics card, and the TV may then further upscale. Also displays the type of Full Screen in use.
{{-}}

= Debug Mode =
Although normally used to enable debug logging in the {{kodi}} log files, the overlay provides additional useful information.

The Debug Mode can be activated using one of the following methods...

{{#lst:Log_file/Easy|EnableDebugMode}}

<gallery mode="packed" widths="700px" heights="394px">
DebugMode01.jpg|Image 7 - The Debug Mode Information overlay
</gallery>

; LOG
: Reveals the location of the debug log

; MEM
: System memory available / Total system memory in Kilobytes

; FPS
: The refresh rate of the display

; CPU
: #The CPU thread : The work load on the thread as a percentage of maximum rated

= References =
<References />

{{top}}

{{updated|22}}
[[Category:Karellen]]
[[Category:Video library]]

File:Video Playback OSD 09.jpg

2025-08-05T03:08:14Z

Karellen: Karellen uploaded a new version of File:Video Playback OSD 09.jpg

MsUpload

File:Video-Playback-OSD-13.jpg

2025-08-05T03:07:40Z

Karellen: Karellen uploaded a new version of File:Video-Playback-OSD-13.jpg

File uploaded with MsUpload

File:Video Playback OSD 08.jpg

2025-08-05T03:07:00Z

Karellen: Karellen uploaded a new version of File:Video Playback OSD 08.jpg

MsUpload

File:Video-Playback-OSD-12.jpg

2025-08-05T03:06:22Z

Karellen: Karellen uploaded a new version of File:Video-Playback-OSD-12.jpg

File uploaded with MsUpload

NFO files/Movie sets

2025-08-04T20:43:25Z

Karellen:

{{NFO_content}}
{{mininav|[[NFO files]]}}

__TOC__

= Introduction =
The <code>set.nfo</code> was introduced in v22 Piers to allow users to easily edit movie set (aka movie collection) information.<ref>https://github.com/xbmc/xbmc/pull/26295</ref>

This file is a unique nfo file specifically for movie sets. It should be considered an ''override nfo file''. It is not a full metadata nfo file and {{kodi}} will only read it in specific situations.

General information on movie sets can be found here... '''[[Movie_sets|Movie Sets]]'''

= Name and Location =
The nfo file is named <code>set.nfo</code>

The nfo file is saved in the appropriate movie-set sub-folder of the '''[[Movie_set_information_folder|Movie Set Information Folder (MSIF)]]'''

<gallery mode="packed" widths="700px" heights="394px">
File:LocalMovieSetsArt01.jpg|The structure of the MSIF
</gallery>

= Contents =
The format of the nfo file is detailed below.

The set nfo file does not introduce any new metadata fields for the movie-set. The following are the only tags accepted in the set.nfo file.

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<set>
<title>New Title</title>
<originaltitle>Original Title</originaltitle>
<overview>New description</overview>
</set>
</syntaxhighlight>

= Usage =
The Refresh button can be used to edit the title and overview of the movie-set after scanning or scraping of the movies.

The Refresh button will also update new artwork added to the set folder.

* Add the set.nfo file to the movie-set subfolder as described above.
* Navigate to the movie-set in the Sets node
* Call up the Information page by:
** Press {{keypress|i}} on a remote control
** Press {{keypress|i}} on a keyboard
** Using the '''''[[Basic_controls#Context_Menu|Context Menu]]''''', select '''Information'''
* Select Refresh

<gallery mode="packed" widths="700px" heights="394px">
File:MovieSetInfoPage01.jpg|Using the Refresh button
</gallery>

When additional movies from that movie-set are scraped into the library, they will also inherit the modified set metadata as long as the set.nfo remains in place.

== Notes ==
Some general information to be aware of:

* After running an Export to separate files, the nfo files for those movies will still contain the original set metadata from the scraping process. Keeping the set.nfo in place will ensure the set data is updated in the Kodi library when rebuilding your library.
* If you would like to combine movie-sets, eg combine the ''Alien Collection, Alien:Romulus Collection'' and ''The Prometheus Collection'', then this should be done using the '''[[Movie_sets#Kodi_Movie_Set_Editor|Movie Set Editor]]'''
* The scanning hierarchy, in increasing order of priority, is as follows:
** if no movie.nfo is found then the scraper results will be used
** if there is a movie.nfo in the folder of any of the movies in the set then the <overview> tag in the <set> tag is used.
** if a set.nfo is found in the MSIF then that takes priorty over both the above.

= References =
<references />

{{top}}

{{updated|22}}

[[Category:Karellen]]
[[Category:Video library]]

NFO files

2025-08-04T04:53:47Z

Karellen: set.nfo changes

{{NFO_content}}
{{mininav|[[Video library]] {{l2| [[Music library]] }} }}
__NOTOC__

= Introduction =
<section begin="intro" />NFO files are used to populate the music and video library using locally stored information. They are helpful if data for your particular title does not exist, such as for home movies and sporting events. A Parsing and Combination NFO file can be used to control the search behaviour of scrapers when problematic and ambiguous titles prevent your preferred title from being scraped.<section end="intro" />

'''nfo''' is a filename extension - ''mymovie.nfo'' and the contents of the file are written in [http://en.wikipedia.org/wiki/XML XML]. The file itself does nothing except hold information and is basically a text document with XML tags inserted around the information.

'''All NFO files are saved with UTF-8 encoding''' which is standard on most operating systems.

NFO files are also used as a method of exporting the library for various reasons, including backup. '''''See: [[Import-export_library | Import & Export]]'''''

The order of importing metadata into the {{kodi}} library is:
#nfo file. If no nfo file exists then
#Depending on your Source scraper settings:
#* A scraper is set- Scraper will locate online metadata, or
#* Local Info Only is set- Nothing will be scanned or scraped.

; [[NFO files/Creating|Creating NFO files]]
: {{#lst:NFO files/Creating|intro}}

; [[NFO_files/Combination|Combination NFO]]
: {{#lst:NFO_files/Combination|intro}}

; Metadata NFO
: These are the full metadata NFO files that are commonly used. The {{kodi}} '''[[Import-export_library|Export]]''' feature generates these files as well as 3rd party media managers.
: All available XML tags are listed here as well as a description on how and where the files are saved.

; [[NFO_files/Movie_sets|Movie Set NFO]]
: An override nfo file used for Movie Sets.

; [[NFO_files/Parsing|Parsing NFO]]
: {{#lst:NFO_files/Parsing|intro}}

; [[NFO_files/Templates|Templates and Samples]]
: {{#lst:NFO_files/Templates|intro}}

{{updated|20}}

[[Category:Karellen]]
[[Category:Music library]]
[[Category:Video library]]

Movie set information folder

2025-08-04T03:15:11Z

Karellen: set.nfo changes

{{mininav|[[Video library]]|[[Video management|Management]] }}

= Introduction =
<section begin="intro" />The Movie Set Information Folder ('''MSIF''') is a user nominated folder that {{kodi}} will scan to locate '''local artwork''' for movie sets/collections.<section end="intro" />

If you do not use local artwork, and rely on the scrapers to provide your artwork, then there is no requirement for you to use this feature.

Most users are familiar with the movie Source added in {{kodi}} which contains movie folders which in turn contain the video file, artwork and NFO file for a movie. The Movie Set Information Folder is the same concept and will contain a sub-folder for each movie set which in turn contains the artwork for the movie set.

'''Notes:'''
* This is a v19 and later feature.
* Only one MSIF can be used in {{kodi}}.
* From v19 [https://rmrector.github.io/script.artwork.beef/ Artwork Beef] will no longer be available to load movie set artwork from local files.
* This is the only method that {{kodi}} will use to search and cache '''local''' movie set artwork. Movie set artwork saved in the movie folders will not be recognised.

<gallery mode="packed" widths="700px" heights="394px">
File:LocalMovieSetsArt01.jpg|Image 1
</gallery>

= Create Your MSIF =
The first step is to create your Movie Set Information Folder.

* The folder can be created anywhere {{kodi}} can access
* Avoid creating the folder inside another {{kodi}} Source. ie do not create it inside your movie or tv show source folders
* Image 1 above shows the folder ''f:\Movies- Sets Art\'' as the Movie Set Information Folder

= Set MSIF =
The second step is to set the new Movie Set Information Folder in {{kodi}}.

# Go to {{highlight| [[Settings/Media/Videos#Movie_Set_Information_Folder|Settings > Media > Videos]]}}
# Locate the setting '''Movie set information folder''' and select it
# Navigate to the new Movie Set Information Folder, enter it and select '''OK'''
# Your new setting should be saved

If you have not already done so, set the artwork types to be scanned into the library. This is a new process for v19. There is no longer a need to adjust artwork settings in scrapers.
# From the above '''Movie set information folder''' setting scroll down the page to '''Artwork level'''
# Select your preferred artwork level:
## Maximum - All available artwork in the folder will be scanned. This includes all artwork regardless of name and type.
## Basic - Minimal artwork- Poster and Fanart only for Movies and Movie Sets
## Custom - Create a whitelist of artwork to scan
## None - No artwork will be scanned.

'''Note: '''
* The advancedsettings.xml method of whitelisting artwork has been removed in v19.
* Any whitelisted tags in the advancedsettings.xml file will be automatically saved to the ''Custom'' artwork level in v19 the first time you run {{kodi}} with that advancedsettngs.xml file.

= Create Movie Set Sub Folders =
The third step is to create your movie set sub-folders which will contain the local artwork. There are a few ways to accomplish this as listed below. Choose the method that best suits your setup.

Regardless of which method you choose, the following requirements apply:
* The Movie Set Information Folder must contain movie set sub-folders.
* The movie set sub-folder must be named exactly as the collection is named in the {{kodi}} library. The name you see in {{Kodi}} or in an NFO file is the name you use.
* Artwork in each movie set folder must be named in the short format. eg ''fanart, poster, clearart'' etc See image 1 above.

'''Note-''' Illegal characters in the movie set name are replaced with an underscore '''_''' eg ''Mission: Impossible Collection'' becomes '''''Mission_ Impossible Collection'''''

== Manual ==
Create each movie set sub-folder manually and transfer your local artwork.

== Artwork Dump ==
Artwork Dump is the v19 replacement of Artwork Beef and is the '''recommended''' method for creating the MSIF sub-folders

'''Note:''' This method will not work if...
# you have used a media manager to create nfo files and download local artwork. Media managers strip out all artwork links from nfo files which is what Artwork Dump relies on to find artwork online. If you have used a media manager it should have already created the MSIF sub-folders for you during the scraping process.
# your nfo files contain no artwork links.

After updating to v19, install Artwork Dump and adjust the settings
# Enable ''Add artwork for new videos after library updates''
# Nominate which ''Media types to process automatically''
# Enable ''Automatically preload local video library artwork to {{kodi}} texture cache''
# Run the add-on. This will create your movie set folders and download the original artwork to the sub-folders

See: '''''[https://forum.kodi.tv/showthread.php?tid=360078 Artwork Dump forum thread]'''''

== Export ==
Once you update to v19, run an '''''[[Import-export_library/Video#Separate_Files|Export to Separate Files]]'''''
# Ensure you have adjusted all the settings described above
# Choose '''Yes''' to ''Export Artwork''
# Choose '''No''' to ''Overwrite old files''
# {{Kodi}} will create all the movie set sub-folders with artwork from the cache.
# Run a search and delete to remove the artwork files from the movie set sub-folders and replace with your original artwork files

'''Note''': This method will export nfo files and modified artwork for your entire library. We recommend using the Artwork Dump method.

= Using MSIF =
No special procedure is required to scan the artwork from the movie set sub-folder. When a movie is scraped that belongs to a collection, and a correct movie set sub-folder is available, {{kodi}} will scan the artwork.

If a movie set sub-folder is added after a collection is already created in the {{kodi}} library:
* Scanning/scraping another movie from the collection will load the artwork from the movie set sub-folder
* Alternatively you can load the artwork manually using the Choose Art method:
** Navigate to the collection in the {{kodi}} library
** From the '''[[Basic_controls#Context_Menu|Context menu]]''' select {{highlight|Manage > Choose art}}
** Select artwork for the required artwork types

= See Also =
* [[Movie_sets|Movie Sets]]
* [[Movie_sets_artwork|Movie Sets Artwork]]
* [[NFO_files/Movie_sets|Movie Sets nfo file]]
* [[HOW-TO:Movie_universe|Cinematic Universes]]

= References =
<References />

{{Top}}

{{updated|22}}
[[Category:Karellen]]
[[Category:Video library]]

Movie sets artwork

2025-08-04T03:03:42Z

Karellen: set.nfo changes

{{Artwork_Contents}}
{{mininav|[[Video_library|Video Library]] |[[Artwork]]}}

= Introduction =
<section begin="intro" />This page details information specific to the movie sets library.<section end="intro" />

The following artwork types are standard for movie sets and supported by many skins. For more details see '''[[Artwork types|Artwork Types]]'''

{| class="prettytable"
|-
! colspan="10" style="text-align:left;" | Commonly Supported Artwork
|-
|style="width:80px; text-align:left;"|banner
|style="width:80px; text-align:left;"|clearart
|style="width:80px; text-align:left;"|clearlogo
|style="width:80px; text-align:left;"|discart
|style="width:80px; text-align:left;"|fanart
|style="width:100px; text-align:left;"|fanart''x''<br> (extra fanart)
|style="width:80px; text-align:left;"|keyart
|style="width:80px; text-align:left;"|landscape
|style="width:80px; text-align:left;"|poster
|style="width:100px; text-align:left;"|poster''x''<br> (extra poster)
|}

= Scraping =
The {{kodi}} scrapers can automatically download movie set artwork without any extra effort from the user.

Artwork settings for the video library are adjusted in the {{kodi}} settings pages here... {{highlight|[[Settings/Media/Videos#Artwork|Settings > Media > Videos > Artwork]]}}

= Local Artwork =
{{kodi}} v19 (Matrix) improved handling of local movie set artwork. Movie set artwork is now saved in the '''[[Movie_set_information_folder|Movie Set Information Folder]]'''.<ref>https://github.com/xbmc/xbmc/pull/16970</ref> Movie-set artwork traditionally located in the movie folder will no longer be used.

To set up local artwork for movie sets, follow the instructions detailed in the '''[[Movie_set_information_folder|Movie Set Information Folder]]''' page.

{{Kodi}} v22 (Piers) introduces a Refresh option for Movie Sets which is located in the Movie Set Information Page.<ref>https://github.com/xbmc/xbmc/pull/26295</ref> This allows users to update the set with newly added artwork, as well as allowing changes to metadata via the new '''[[NFO_files/Movie_sets|set.nfo file]]'''

When adding new artwork to the MSIF, the new artwork will be immediately visible after refreshing. When changing existing artwork, the 24 hour image cache still has priority so the updated artwork may not be seen immediately.

<gallery mode="packed" widths="700px" heights="394px">
File:MovieSetInfoPage01.jpg|Using the Refresh button
</gallery>

= References =
<references />

{{top}}
{{updated|22}}

[[Category:Karellen]]
[[Category:Video library]]

NFO files/Movie sets

2025-08-04T02:18:59Z

Karellen: First creation

{{NFO_content}}
{{mininav|[[NFO files]]}}

__TOC__

= Introduction =
The <code>set.nfo</code> was introduced in v22 Piers to allow users to easily edit movie set (aka movie collection) information.<ref>https://github.com/xbmc/xbmc/pull/26295</ref>

This file is a unique nfo file specifically for movie sets. It should be considered an ''override nfo file''. It is not a full metadata nfo file and {{kodi}} will only read it in specific situations.

General information on movie sets can be found here... '''[[Movie_sets|Movie Sets]]'''

= Name and Location =
The nfo file is named <code>set.nfo</code>

The nfo file is saved in the appropriate movie-set sub-folder of the '''[[Movie_set_information_folder|Movie Set Information Folder (MSIF)]]'''

<gallery mode="packed" widths="700px" heights="394px">
File:LocalMovieSetsArt01.jpg|The structure of the MSIF
</gallery>

= Contents =
The format of the nfo file is detailed below.

The set nfo file does not introduce any new metadata fields for the movie-set. The following are the only tags accepted in the set.nfo file.

<syntaxhighlight lang="xml">
<set>
<title>New Title</title>
<originaltitle>Original Title</originaltitle>
<overview>New description</overview>
</set>
</syntaxhighlight>

= Usage =
The Refresh button can be used to edit the title and overview of the movie-set after scanning or scraping of the movies.

The Refresh button will also update new artwork added to the set folder.

* Add the set.nfo file to the movie-set subfolder as described above.
* Navigate to the movie-set in the Sets node
* Call up the Information page by:
** Press {{keypress|i}} on a remote control
** Press {{keypress|i}} on a keyboard
** Using the '''''[[Basic_controls#Context_Menu|Context Menu]]''''', select '''Information'''
* Select Refresh

<gallery mode="packed" widths="700px" heights="394px">
File:MovieSetInfoPage01.jpg|Using the Refresh button
</gallery>

When additional movies from that movie-set are scraped into the library, they will also inherit the modified set metadata as long as the set.nfo remains in place.

== Notes ==
Some general information to be aware of:

* After running an Export to separate files, the nfo files for those movies will still contain the original set metadata from the scraping process. Keeping the set.nfo in place will ensure the set data is updated in the Kodi library when rebuilding your library.
* If you would like to combine movie-sets, eg combine the ''Alien Collection, Alien:Romulus Collection'' and ''The Prometheus Collection'', then this should be done using the '''[[Movie_sets#Kodi_Movie_Set_Editor|Movie Set Editor]]'''
* The scanning hierarchy, in increasing order of priority, is as follows:
** if no movie.nfo is found then the scraper results will be used
** if there is a movie.nfo in the folder of any of the movies in the set then the <overview> tag in the <set> tag is used.
** if a set.nfo is found in the MSIF then that takes priorty over both the above.

= References =
<references />

{{top}}

{{updated|22}}

[[Category:Karellen]]
[[Category:Video library]]

File:MovieSetInfoPage01.jpg

2025-08-04T01:53:54Z

Karellen: File uploaded with MsUpload

File uploaded with MsUpload

File:LocalMovieSetsArt01.jpg

2025-08-04T01:52:55Z

Karellen: Karellen uploaded a new version of File:LocalMovieSetsArt01.jpg

File uploaded with MsUpload

Template:NFO content

2025-08-04T01:46:47Z

Karellen: Reorganise and add movie sets

{|class="infobox" style="width:230px"
! NFO Contents
|-
|
'''[[NFO_files|NFO Main Page]]'''
* '''[[NFO files/Creating|Creating NFO files]]'''
* '''[[NFO_files/Combination|Combination NFO]]'''
* '''Metadata NFO'''
** '''[[NFO files/Albums|Albums]]'''
** '''[[NFO files/Artists|Artists]]'''
** '''[[NFO_files/Episodes|Episodes]]'''
** '''[[NFO_files/Movies|Movies]]'''
** '''[[NFO files/Music videos|Music Videos]]'''
** '''[[NFO files/TV shows|TV Shows]]'''
* '''[[NFO_files/Movie_sets|Movie Sets NFO]]'''
* '''[[NFO_files/Parsing|Parsing NFO]]'''
* '''[[NFO_files/Templates|Templates and Samples]]'''

----
See also:
* '''[[Artwork]]'''
* '''[[Databases]]'''
* '''[[Import-export library]]'''
----
Return to:
* '''[[Music_library|Music Library Portal]]'''
* '''[[Video_library|Video Library Portal]]'''
|}<noinclude>[[Category:Navigation templates]]</noinclude>

Template:Download link

2025-07-24T10:18:15Z

Karellen:

{{#switch:{{{1|}}}
| Android ARMV7A (32Bit) = https://mirrors.kodi.tv/releases/android/arm/kodi-21.2-Omega-armeabi-v7a.apk?https=1
| Android ARMV8A (64Bit) = https://mirrors.kodi.tv/releases/android/arm64-v8a/kodi-21.2-Omega-arm64-v8a.apk?https=1
| Google Play = https://play.google.com/store/apps/details?id=org.xbmc.kodi
| Huawei App Gallery = https://appgallery.huawei.com/#/app/C101763539
| iOS (64Bit) = https://mirrors.kodi.tv/releases/darwin/ios-arm64/org.xbmc.kodi-ios_21.2_iphoneos-arm64.deb?https=1
| Mac Apple Silicon (ARM64) = https://mirrors.kodi.tv/releases/osx/arm64/kodi-21.2-Omega-arm64.dmg?https=1
| Mac Intel (x86_64) = https://mirrors.kodi.tv/releases/osx/x86_64/kodi-21.2-Omega-x86_64.dmg?https=1
| tvOS = https://mirrors.kodi.tv/releases/darwin/tvos/org.xbmc.kodi-tvos_21.2-tvos.deb?https=1
| webOS = https://mirrors.kodi.tv/releases/webos/org.xbmc.kodi-webos_21.0.ipk?https=1
| Windows = https://mirrors.kodi.tv/releases/windows/win32/kodi-21.2-Omega-x86.exe?https=1
| Windows (64Bit) = https://mirrors.kodi.tv/releases/windows/win64/kodi-21.2-Omega-x64.exe?https=1
| Windows Store = https://apps.microsoft.com/detail/9nblggh4t892?cid=koditvlinkbadge
}}<noinclude>{{doc}}</noinclude>

Template:Download link

2025-07-24T10:17:37Z

Karellen:

Advancedsettings.xml

2025-07-16T01:17:35Z

Karellen: /* videoextensions */

{{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|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 version="1.0">
<setting>value</setting>
...
<setting>value</setting>
</advancedsettings>
</syntaxhighlight>

where "setting" gives the name of the setting, and "value" gives its value.

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

= List of available settings =
List of available settings that are recognised in the advancedsettings.xml file <ref>https://github.com/xbmc/xbmc/blob/master/xbmc/settings/AdvancedSettings.cpp</ref>

Recommended: Use the table of contents or the search function in your browser to locate items.

== Troubleshooting settings ==

=== loglevel ===
{{Anchor|.3Cloglevel.3E}}

<section begin="loglevel" />
Sets the logging level used to log errors and information. The "hide" attribute is optional.

<syntaxhighlight lang=xml>
<loglevel hide="attribute">options</loglevel>
</syntaxhighlight>

{| class="mw-collapsible mw-collapsed wikitable"
|-
! style="width:100px;" | Attribute
! style="width:500px;" | Action
|-
! '''true'''
| Hides the "enable debugging" setting in the Settings page. (default)
|-
! '''false'''
| Allows "enable debugging" setting to switch between '''0''' and '''2'''.
|}

{| class="mw-collapsible mw-collapsed wikitable"
|-
! style="width:100px;" | Option
! style="width:500px;" | Action
|-
! '''-1'''
| No logging, suppresses all log output
|-
! '''0'''
| Normal logging, only logging errors (default)
|-
! '''1'''
| Debug logging with freemem, fps and cpu usage (no on screen)
|-
! '''2'''
| Same as 1 (with on screen display)
|-
! '''3'''
| Same as 1 + full smb logging
|}

{| class="wikitable"
|-
! style="width:100px;" | Example
! style="width:500px;" |
|-
! Example 1:
|<syntaxhighlight lang=xml enclose="div">
<advancedsettings version="1.0">
<loglevel>2</loglevel>
</advancedsettings>
</syntaxhighlight>
|-
! Example 2:
|<syntaxhighlight lang=xml enclose="div">
<advancedsettings version="1.0">
<loglevel hide="true">2</loglevel>
</advancedsettings>
</syntaxhighlight>
|}

'''Note:''' The setting is persistent through shutdown and restarts.<br>
'''Note:''' If debugging is enabled in the GUI, loglevel will be set to '''2'''. This will over-ride the <code>advancedsettings.xml</code> setting. You must disable the GUI Setting before adding the entry to <code>advancedsettings.xml</code>.<br />
<section end="loglevel" />
:''{{see also|Log_file|label 1=Debug Log}}''

=== jsonrpc ===
{{Anchor|.3Cjsonrpc.3E}}
To make it easier for developers using the [[JSON-RPC_API]] 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>

== Audio/video playback settings ==

=== skiploopfilter ===
{{anchor|.3Cskiploopfilter.3E}}
The amount of the loop filter to skip on h.264 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
* 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}}

The <video> section also includes the following child-tags, which have their own sections:
*[[#cleandatetime]]
*[[#cleanstrings]]
*[[#excludefromscan]]
*[[#excludefromlisting]]
*[[#excludetvshowsfromscan]]

{{note|Some tags that have a "third-level" and are grouped together are highlighted in color.}}

{| class="prettytable"
! Tag !! Description
|-
|
<syntaxhighlight lang=xml>
<video>
</syntaxhighlight>
| Parent tag that all other child tags need to be placed inside of. Do not use more than one '''<code><video></code>''' tag, but instead place all other child-tags within a single '''<code><video></video></code>''' set.
|-
|
<syntaxhighlight lang=xml>
<subsdelayrange>10</subsdelayrange>
</syntaxhighlight>
| Delay range for subtitles, in seconds.
|-
|
<syntaxhighlight lang=xml>
<maxtempo>2.1</maxtempo>
</syntaxhighlight>
| Allow further increase of playback speed over the default of 1.5<br>
maxtempo must be in the range of 1.5 to 2.1 <br>
Be aware of the limitations of your platform / hardware as not all are capable of the increased maxtempo <ref>https://forum.kodi.tv/showthread.php?tid=10023&pid=2795069#pid2795069</ref>
|-
|
<syntaxhighlight lang=xml>
<audiodelayrange>10</audiodelayrange>
</syntaxhighlight>
| Delay range for audio/video sync, in seconds.
|-
|
<syntaxhighlight lang=xml>
<usetimeseeking>true</usetimeseeking>
</syntaxhighlight>
| Whether to use time based or percentage based seeking. {{small see also|Skip steps}}
|-
|
<syntaxhighlight lang=xml>
<timeseekforwardbig>600</timeseekforwardbig>
<timeseekbackwardbig>-600</timeseekbackwardbig>
</syntaxhighlight>
| Time to seek forward in seconds when doing a long seek. Defaults to 600 (10 minutes) and -600 (-10 minutes) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<percentseekforward>2</percentseekforward>
<percentseekbackward>-2</percentseekbackward>
</syntaxhighlight>
| Amount to seek forward as a percentage, when doing a short seek. Defaults to 2 (2%) and -2 (2%) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<percentseekforwardbig>10</percentseekforwardbig>
<percentseekbackwardbig>-10</percentseekbackwardbig>
</syntaxhighlight>
| Amount to seek forward as a percentage, when doing a long seek. Defaults to 10 (10%) and -10 (10%) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<fullscreenonmoviestart>true</fullscreenonmoviestart>
</syntaxhighlight>
| Whether to go to fullscreen or not when starting a movie. Defaults to true.
|-
|
<syntaxhighlight lang=xml>
<defaultplayer>VideoPlayer</defaultplayer>
</syntaxhighlight>
| Set the default video player: VideoPlayer or an external player. See '''[[External players]]''' for more info.
|-
|
<syntaxhighlight lang=xml>
<excludefromscan>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromscan>
</syntaxhighlight>
| Regular expressions that if evaluated to true won't be added to library. It is possible to add multiple <code><regexp></code> tags to match multiple patterns
|-
|
<syntaxhighlight lang=xml>
<excludefromlisting>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromlisting>
</syntaxhighlight>
| Regular expressions that if evaluated to true won't be displayed in files view.
|-
|
<syntaxhighlight lang=xml>
<playcountminimumpercent>90</playcountminimumpercent>
</syntaxhighlight>
| Minimum percentage that has to be played before it is marked as watched. Set to 101 to never auto-mark items as watched. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<ignoresecondsatstart>180</ignoresecondsatstart>
</syntaxhighlight>
| Number of seconds to ignore at video start after which a resume point is created. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<ignorepercentatend>8</ignorepercentatend>
</syntaxhighlight>
| Percentage of video to ignore at the end. If you stop watching the video here no resume point is created. Set to 101 to never save a resume point. The video is already marked as watched at 90%, see above. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<vdpauscaling>true</vdpauscaling>
</syntaxhighlight>
| Scales with vdpau instead of opengl and turns on its HQ scaler when available, enabling this might slow down rendering and cause framedrops especially on ION systems, this setting requires a vdpau feature set C GPU.
|-
|
<syntaxhighlight lang=xml>
<ppffmpegdeinterlacing>linblenddeint</ppffmpegdeinterlacing>
</syntaxhighlight>
| Override the deinterlacing options passed to libpostproc.
|-
|
<syntaxhighlight lang=xml>
<ppffmpegpostprocessing>ha:128:7,va,dr</ppffmpegpostprocessing>
</syntaxhighlight>
| Override the post processing options passed to libpostproc when 'Video post-processing' is activated in GUI Videos-Settings-Playback.
|-
|
<syntaxhighlight lang=xml>
<autoscalemaxfps>30</autoscalemaxfps>
</syntaxhighlight>
| When scaling method is set to auto, bilinear is chosen when the fps is higher than this limit, the default is 30.
|-
|
<syntaxhighlight lang=xml>
<adjustrefreshrate>
</syntaxhighlight>
| style="background:#CADCFB;" | Settings for when "Adjust refreshrate to match video fps" is enabled in the video playback GUI settings.
|-
|
<syntaxhighlight lang=xml>
<override>
<fps>23.976</fps>
<refresh>60.0</refresh>
</override>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' "Adjust refreshrate to match video fps" will try to select the best refreshrate for the video fps but it doesn't always get it right, for example it might switch to an unsupported refreshrate. You can add overrides here to switch to a certain refreshrate based on video fps. It's possible to add as many overrides as you need. Overrides are processed in order, if the first one doesn't match the fps or no refreshrates match that override, it will try the next one until no overrides are left.

* '''fps''' - if the fps is between 23.966 and 23.986
* '''refresh''' - switch to the first found refreshrate that is between 59.99 and 60.01
|-
|
<syntaxhighlight lang=xml>
<override>
<fpsmin>29.96</fpsmin>
<fpsmax>30.01</fpsmax>
<refreshmin>59.0</refreshmin>
<refreshmax>61.0</refreshmax>
</override>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -'''
* '''fpsmin''' / '''fpsmin''' - You can also specify the fps range yourself.
* '''refreshmin''' / '''refreshmax''' - Same for the refreshrate
|-
|
<syntaxhighlight lang=xml>
<fallback>
<refresh>50.0</refresh>
</fallback>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' If none of the overrides match, or none of the refreshrates match any of the fps matching overrides, it will choose a fallback refreshrate. Fallbacks are process in order, if the first fallback doesn't match any refreshrate, it will try the next one until no fallbacks are left.

* '''refresh''' - Switch to the first found refreshrate that is between 49.99 and 50.01.
|-
|
<syntaxhighlight lang=xml>
<fallback>
<refreshmin>49.0</refreshmin>
<refreshmax>51.0</refreshmax>
</fallback>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' You can also specify the range for the fallback yourself.

If none of the overrides match the video fps, or no refreshrates match any of the fps matching overrides, and no fallbacks are specified or no refreshrates match any fallbacks, it will automatically choose the best refreshrate (same as having no overrides and fallbacks).
|-
|
<syntaxhighlight lang=xml>
</adjustrefreshrate>
</syntaxhighlight>
| style="background:#CADCFB;" |
|-
|
<syntaxhighlight lang=xml>
<checkdxvacompatibility>value</checkdxvacompatibility>
</syntaxhighlight>
| Advanced setting not present: let Kodi autodetect cards that support H.264 profile > L4.1. Set value to false to enable DXVA no matter what. Set value to true if Kodi doesn't autodetect that the graphics card doesn't support > L4.1.
|-
|
<syntaxhighlight lang=xml>
<useocclusionquery>-1</useocclusionquery>
</syntaxhighlight>
| Use an occlusion query when capturing videoframes, -1 means auto detect, 0 means disabled, 1 means enabled, the default is -1.
|-
|
<syntaxhighlight lang=xml>
<fpsdetect>1</fpsdetect>
</syntaxhighlight>
| FPS detection for video playback
* 0 = trust codec fps
* 1 = recalculate from video timestamps with uniform spacing
* 2 = recalculate from video timestamps always
|-
|
<syntaxhighlight lang=xml>
<latency>
<delay>0</delay>
<hdrextradelay>0</hdrextradelay>
<refresh>
<min></min>
<max></max>
<rate></rate>
<delay></delay>
<hdrextradelay></hdrextradelay>
</refresh>
</latency>
</syntaxhighlight>
| '''Latency''' helps correct audio/video synchronization (lip-sync) when the display's internal processing introduces noticeable delays in the display of the pictures. The optional overrides and hdr extra delay offer further fine-tuning when the delay is not the same for all refresh rates or the HDR vs SDR modes. Latency is given in milliseconds. For one-off adjustments use the OSD during playback to adjust audio synchronisation.<br/><br/>
'''<delay>''' - Global default display latency.<br>
'''<hdrextradelay>''' - Global default latency added to the global default display latency when the display is in any HDR mode. Note: the display HDR mode is not detected on all platforms (Windows-only at time of writing).<br>
'''<refresh>''' - Override latency for given display (not video) refresh rates. When Kodi is in windowed mode, override is ignored. Multiple overrides are allowed.<br>
'''<min>''', '''<max>''' - refresh rate range, OR<br>
'''<rate>''' - exact refresh rate<br>
'''<delay>''' - display latency for the given refresh rate<br>
'''<hdrextradelay>''' - additional latency when the display is in any HDR mode for the given refresh rate<br>
<br/>
'''Example:''' The following example sets display latency of 125 msec at 23-24 Hz
<syntaxhighlight lang=xml>
<refresh>
<min>23</min>
<max>24</max>
<delay>125</delay>
</refresh>
</syntaxhighlight>
<br/>
'''Example:''' The following example sets display latency of 50 msec at 50 (+/-0.01) Hz
<syntaxhighlight lang=xml>
<refresh>
<rate>50</rate>
<delay>50</delay>
</refresh>
</syntaxhighlight>

|-
|
<syntaxhighlight lang=xml>
<stereoscopicregex3d>[-. _]3d[-. _]</stereoscopicregex3d>
<stereoscopicregexsbs>[-. _]h?sbs[-. _]</stereoscopicregexsbs>
<stereoscopicregextab>[-. _]h?tab[-. _]</stereoscopicregextab>
</syntaxhighlight>
| Filename triggers for 3D (stereoscopic) mode.
|-
|
<syntaxhighlight lang=xml>
<assfixedworks>false</assfixedworks>
</syntaxhighlight>
| Position behavior of ass subtitiles when setting "subtitle position on screen" set to "fixed". True to show at the fixed position set in video calibration. False to show at the bottom of video (default). {{note|Removed in Kodi v20.}}
|-
|
<syntaxhighlight lang=xml>
<subtitleverticalmargin>120</subtitleverticalmargin>
</syntaxhighlight>
| Allows to customise the vertical margin of text based subtitles, which will be applied to each type of subtitle position in subtitle settings. {{note|Available in Kodi v20 and above.}}
|-
|
<syntaxhighlight lang=xml>
</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>

<usetimeseeking>true</usetimeseeking>

<timeseekforwardbig>600</timeseekfowardbig>

<timeseekbackwardbig>-600</timeseekbackward>

<playcountminimumpercent>99</playcountminimumpercent>

<applydrc>-1.0</applydrc>

<limiterhold>0.025</limiterhold>

<limiterrelease>0.1</limiterrelease>

<maxpassthroughoffsyncduration>10</maxpassthroughoffsyncduration>

<allowmultichannelfloat>false</allowmultichannelfloat>

<superviseaudiodelay>false</superviseaudiodelay>
</audio>
</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

=== edl ===
{{anchor|.3Cedl.3E}}
{{main|Edit_decision_list}}
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>


<displaycommbreaknotifications>false</displaycommbreaknotifications>
</edl>
</syntaxhighlight>
'''Notes:'''
* displaycommbreaknotifications<ref>https://github.com/xbmc/xbmc/pull/20711</ref>

== PVR & Live TV ==
{{anchor|.3Cpvr.3E}}
Settings available for PVR, EPG and Live TV. Edit Decision List settings are located in the previous section.

=== pvr ===
<syntaxhighlight lang="xml" line='line'>
<pvr>
<timecorrection>0</timecorrection> 
<infotoggleinterval>3000</infotoggleinterval> 
<channeliconsautoscan>true</channeliconsautoscan> 
<autoscaniconsuserset>false</autoscaniconsuserset> 
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> 
</pvr>
</syntaxhighlight>

==== pvrrecordings ====
In v19 and later, allows users to modify sort type and order of pvr recordings. <ref>https://github.com/xbmc/xbmc/pull/18605</ref>

;Note- These settings are child tags to the ''<pvr>'' tag in the previous section.

<syntaxhighlight lang="xml" line='line'>
<pvr>
<pvrrecordings>
<sortmethod>2</sortmethod> 
<sortorder>2</sortorder> 
</pvrrecordings>
</pvr>
</syntaxhighlight>

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

== 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>
.001 .3g2 .3gp .asf .asx .avc .avi .avs .bdm .bdmv .bin .bivx .dat .divx .dv .dvr-ms .evo .fli .flv .f4v
.h264 .ifo .img .iso .m2t .m2ts .m2v .m3u .m3u8 .m4v .mkv .mk3d .mov .mp4 .mpd .mpeg .mpg .mpl .mpls .mts
.nrg .nsv .nuv .ogm .ogv .pls .pva .pxml .qt .rcv .rec .rm .rmvb .rss .sdp .strm .svq3 .tp .trp .ts .ty
.url .udf .vc1 .vdr .viv .vob .vp3 .webm .wmv .wpl .wtv .xsp .xspf .xvid .zip
</pre>
Examples:
<pre>
<videoextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</videoextensions>
</pre>
<section end="videoextensions" />

=== discstubextensions ===
{{main|Media stubs}}

<section begin="discstubextensions" />
The default filename extension for Disc Stubs is:
<syntaxhighlight lang=xml enclose="div">
.disc
</syntaxhighlight>
Using the following tags, it is possible to <tt><add></tt> additional or <tt><remove></tt> existing disc stub extensions to better suit your requirements.
<syntaxhighlight lang=xml enclose="div">
<discstubextensions>
<add>.disk|.stub</add>
<remove>.disc</remove>
</discstubextensions>
</syntaxhighlight>
<section end="discstubextensions" />

=== languagecodes ===
{{anchor|.3Clanguagecodes.3E}}
User-defined translation table for language codes used in subtitles and audio.
It can be used to add, extend or override Kodi's language codes.

'''How to add a new language code:'''

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

'''How to add a new language code with subtag (e.g. pt-BR):'''
{{note|This support is available from Kodi v20}}

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>pt-BR</short>
<long>Portuguese - Brazil</long>
</code>
</languagecodes>
</syntaxhighlight>

''NOTE FOR MKV FILES:''<br/>
MKV files that contain audio/subtitle tracks with language codes with subtags are not yet supported, but from <code>Kodi v21</code> a workaround was introduced that allows Kodi to recognize language codes with subtags.
To use the workaround, you must open the MKV file with an editor and in the metadata of the desired audio/subtitle track, edit the track Name (or Title field) by adding the language code wrapped in curly brackets, as in following example:
<br/><code>Original track name: Audio portuguese/brazil</code>
<br/><code>Modified track name: Audio portuguese/brazil {pt-BR}</code>

'''How to extend an existing language code:'''

Set the same "long" description of the existing language, for example we reuse the Portughese language for another language code:

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>pt-BR</short>
<long>Portuguese</long>
</code>
</languagecodes>
</syntaxhighlight>

In this case when in Kodi settings you set the "Portuguese" language, when in playing according to availability the track "pt" or "pt-BR" will be chosen.

'''How to override an existing language code:'''

This allow you to rename an existing language. Set to an existing language code your preferred "long" name description.

''WARNING: This can cause problems with add-ons, so do not override languages if you are not aware of the side effects.''

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>en</short>
<long>English example</long>
</code>
<code>
<short>en-GB</short>
<long>English example</long>
</code>
</languagecodes>
</syntaxhighlight>

=== moviestacking ===
{{anchor|.3Cmoviestacking.3E}}<section begin="moviestacking" />
{{main|Naming_video_files/Movies}}
This is used by the [[Naming_video_files/Movies#Split_Video_Files|file stacking]] algorithm to combine multi-part files and contains a list of 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|Naming_video_files/Movies}}
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

Default expression:
<syntaxhighlight lang=xml enclose="div">
<video>
<cleandatetime>(.*[^ _\,\.\[\]\-])[ _\.\[\]\-]+(19[0-9][0-9]|20[0-9][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 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.

{{Github_link|[https://github.com/xbmc/xbmc/blob/Nexus/xbmc/settings/AdvancedSettings.cpp#L201-L211 Code in Github]}}

Default expressions:
<syntaxhighlight lang=xml enclose="div">
<video>
<cleanstrings>
<regexp>([ _\\,\\.\$\$\\[\\]\\-](10bit|480p|480i|576p|576i|720p|720i|1080p|1080i|2160p|3d|aac|ac3|aka|atmos|avi|bd5|bdrip|bluray|brrip|cam|cd[1-9]|custom|dc|ddp|divx|divx5|dolbydigital|dolbyvision|dsr|dsrip|dts|dts-hdma|dts-hra|dts-x|dv|dvd|dvd5|dvd9|dvdivx|dvdrip|dvdscr|dvdscreener|extended|fragment|fs|h264|h265|hdr|hdr10|hevc|hddvd|hdrip|hdtv|hdtvrip|hrhd|hrhdtv|internal|limited|multisubs|nfofix|ntsc|ogg|ogm|pal|pdtv|proper|r3|r5|read.nfo|remastered|remux|repack|rerip|retail|screener|se|svcd|tc|telecine|telesync|truehd|ts|uhd|unrated|ws|x264|x265|xvid|xvidvd|xxx|web-dl|webrip|www.www|\\[.*\\])([ _\\,\\.\$\$\\[\\]\\-]|$)");</regexp>
<regexp>(\[.*\])</regexp>
</cleanstrings>
</video>
</syntaxhighlight>
Updated in v20<ref>https://github.com/xbmc/xbmc/pull/20549</ref>

:* 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 Expressions

{{Github_link|[https://github.com/xbmc/xbmc/blob/Matrix/xbmc/settings/AdvancedSettings.cpp#L232 Code in Github]}}

Defaults:
<syntaxhighlight lang=xml enclose="div">
<tvshowmatching>
<regexp>s([0-9]+)[ ._x-]*e([0-9]+(?:(?:[a-i]|\\.[1-9])(?![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.
:* 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 [https://forum.kodi.tv/showthread.php?tid=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 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 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 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 syntax to match the locally stored trailers to movies in the library. Only files with recognized video file extensions will be considered, and the extensions are removed for the Regular Expression evaluation.

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

<regexp>(.*?)(_Trailer)$</regexp>
</trailermatching>
</syntaxhighlight>

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

{{Note|Kodi v20 users don't need set "importwatched" or "importresumepoint" to true anymore as that's the default then <ref>https://github.com/xbmc/xbmc/pull/20842</ref>}}

<syntaxhighlight lang="xml" line='line'>
<videolibrary>
<allitemsonbottom>false</allitemsonbottom> 
<cleanonupdate>false</cleanonupdate> 
<usefasthash>true</usefasthash> 
<recentlyaddeditems>35</recentlyaddeditems> 
<itemseparator> / </itemseparator> 
<exportautothumbs>true</exportautothumbs> 
<importwatchedstate>true</importwatchedstate> 
<importresumepoint>true</importresumepoint> 
<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>

== Library artwork ==

{{note|Using <imageres>9999</imageres> and <fanartres>9999</fanartres> will allow caching artwork at original size.}}

=== imageres ===
{{anchor|.3Cimageres.3E}}

<section begin="imageres description" />Specify the maximum resolution that [[Artwork/Cache#Texture optimization| cached artwork]] (other than fanart / 16:9 images) 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}}

<section begin="fanartres description" />Specify the maximum resolution that [[Artwork/Cache#Texture optimization| 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>

=== imagescalingalgorithm ===
Specify the image scaling algorithm for image resizing when [[Artwork/Cache#Texture optimization| caching artwork]] to the local texture cache.
<br />
<syntaxhighlight lang=xml enclose="div">
<imagescalingalgorithm>bicubic</imagescalingalgorithm>
</syntaxhighlight>

[https://github.com/xbmc/xbmc/blob/master/xbmc/pictures/PictureScalingAlgorithm.cpp#L20-L32 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>

=== imagequalityjpeg ===
This specifies the quality of the images when stored in jpeg format. By default kodi uses a quality of 4 which is a good compromise between size and quality. If you want to reduce the thumbnail sizes (decreasing quality) choose a higher value up to 21. If high quality (large thumbnail size) is needed, chose a smaller value, e.g. 0,1,2 or 3. (Added in v20 <ref>https://github.com/xbmc/xbmc/pull/21418</ref>)
<br />
<syntaxhighlight lang=xml enclose="div">
<imagequalityjpeg>4</imagequalityjpeg>
</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>

=== sorttokens ===
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>

In the above example "the ", "the." and "the_" will be ignored at the start of titles or names when sorting items, in both video and music libraries. A separator can also be specified, for example
<syntaxhighlight lang=xml enclose="div">
<sorttokens>
<token separators="'">L</token>
</sorttokens>
</syntaxhighlight>
In that case the value L', as in French movie name ''L'argent'', will be ignored and the item listed under "A".

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

:{{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.'''}}

'''Parent tags:'''

* '''<videodatabase>'''
* '''<musicdatabase>'''
* '''<tvdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''
* '''<epgdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''
{{MySQL warning}}

'''Child tags: '''

;<type>
: ''Required'' - Can be either "sqlite3" or "mysql" (default: sqlite3)

;<host>
:''Required'' -
* 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>
: ''Optional'' -
* sqlite3: silently ignored
* mysql: defines the port of the mysql socket (default: 3306)

;<name>
: ''Optional'' -
: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>
: ''Required for MySQL'' -
* sqlite3: silently ignored
* mysql: defines the user with privileged access to the database

;<pass>
: ''Required for MySQL'' -
* sqlite3: silently ignored
* mysql: defines the password for the user with privileged access to the database

;<connecttimeout> [https://github.com/xbmc/xbmc/pull/26657]
: ''Optional'' -
* sqlite3: silently ignored
* mysql: defines a connect timeout, in seconds. Default value is 5 seconds.

;<compression>
: ''Optional'' - 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}}

;<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]

'''Examples:'''

1) Configure a database for MySQL.
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', and '''<epgdatabase>''' 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>
<connecttimeout>3</connecttimeout>
</videodatabase>
</syntaxhighlight>

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

<section end="videodatabase" />

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

== Music settings ==

=== musicextensions ===
{{anchor|.3Cmusicextensions.3E}}
<section begin="musicextensions" />
Default extensions for MUSIC:
<pre>
.aac .ac3 .aif .aiff .ape .cmc .cmr .cue .dmc .dff .dsf .dsp .dts .dtshd .flac .gcm .gdm .idsp .imf
.m15 .m3u .m4a .m4b .mac .mka .mp+ .mp2 .mp3 .mpa .mpc .mpd .mpdsp .mpp .mpt .mss .nsv .oga .ogg .opus
.pls .pxml .rm .rma .rmt .rsd .rss .sap .sfx .shn .spt .strm .tak .tm2 .tm8 .tmc .tta .uni .url
.waa .wam .wav .wma .wpl .wtv .wv .wvs .xsp .xspf .xwav .zip
</pre>

It is possible to add or remove extensions for Music, using the following XML tags. Useful if you keep, say, FLAC and mp3 versions of music in the same folder. The <remove> tag can be used to remove mp3 from being listed in the library, leaving only the higher quality FLAC being displayed.

<musicextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</musicextensions>

<section end="musicextensions" />

=== 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 ===
Options specific to the Music Library
<section begin="MusicLibrary" />
<syntaxhighlight lang="xml" line='line'>
<musiclibrary>
<recentlyaddeditems>35</recentlyaddeditems> 

<prioritiseapetags>true</prioritiseapetags> 

<allitemsonbottom>true</allitemsonbottom> 

<cleanonupdate>false</cleanonupdate> 

<artistsortonupdate>false</artistsortonupdate> 

<albumformat>%B - %Y</albumformat> 

<itemseparator> / </itemseparator> 

<dateadded>1</dateadded> 

<artistseparators> 
<separator>;</separator>
<separator>:</separator>
<separator>|</separator>
<separator> feat. </separator>
<separator> ft. </separator>
</artistseparators>


<useisodates>false</useisodates> 


<artistnavigatestosongs>true</artistnavigatestosongs> 
</musiclibrary>
</syntaxhighlight>
{{Note|Changing the <itemseparator> or <artistseparators> will only affect newly added items. A rescan won't change the existing ones. Remove the Source(s) or delete the Music DB and rebuild. This process should be made easier from v18 and up using <promptfulltagscan>. <artistseparators> are cAsE sensitive and only used if you are not using MBID's. Separators will be used alongside MBID's from v22 onwards.}}<section end="MusicLibrary" />

== 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 .rss .webp .jp2 .apng
</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 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 ==

=== ftp ===
{{anchor|.3Cftp.3DE}}
Specific settings if a ftp server is in use as a source

<syntaxhighlight lang=xml enclose="div">
<ftp>
<remotethumbs>true</remotethumbs> 
</ftp>
</syntaxhighlight>

=== 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}}

<syntaxhighlight lang=xml line='line'>
<network>
<curlclienttimeout>10</curlclienttimeout> 
<curllowspeedtime>20</curllowspeedtime> 
<curlretries>2</curlretries> 
<httpproxyusername></httpproxyusername> 
<httpproxypassword></httpproxypassword> 
<disableipv6>false</disableipv6> 
<disablehttp2>false</disablehttp2> 
<nfstimeout>30</nfstimeout> 
<catrustfile>filepath</catrustfile> 
<curlkeepaliveinterval>30</curlkeepaliveinterval> 
<nfsretries>0</nfsretries> 
</network>
</syntaxhighlight>

'''More information:'''<br>
* <curlkeepaliveinterval><ref>https://github.com/xbmc/xbmc/pull/19319</ref><br>
* <nfsretries><ref>https://github.com/xbmc/xbmc/pull/19513</ref>

=== 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-ons|add-on]] rollback feature. Increasing the size should increase the amount of past versions saved. Defaults to 200 MB.
| example = Example: <syntaxhighlight lang=xml enclose="div"><packagefoldersize>200</packagefoldersize> </syntaxhighlight>
}}
<section end="packagefoldersize" />

=== detectasudf ===
{{anchor|.3Cdetectasudf.3E}}
{{xml setting
| tag name = detectasudf
| option type = binary
| option values = true, false
| default values = false
| platform = all
| XBMC version =
| description = Set to true if you wish to detect joint ISO9660/UDF disks as UDF.
| example = Example: <syntaxhighlight lang=xml enclose="div"><detectasudf>false</detectasudf></syntaxhighlight>
}}

=== handlemounting ===
{{anchor|.3Chandlemounting.3E}}
{{xml setting
| tag name = handlemounting
| option type = binary
| option values = true, false
| default values = false
| platform = Linux
| XBMC version =
| description = Only used in Linux, it defines if Kodi should attempt to mount media drives (via udisks or udisks2).<br/>Default: False. If kodi is executed with the --standalone option (e.g. as done by kodi-standalone.sh) it by default will be True.
| example = Example: <syntaxhighlight lang=xml enclose="div"><handlemounting>false</handlemounting></syntaxhighlight>
}}

=== automountopticalmedia ===
{{xml setting
| tag name = automountopticalmedia
| option type = binary
| option values = true, false
| default values = false
| platform = Linux
| XBMC version =
| description = Only used in linux for the udisks and udisks2 providers<br/>defines if kodi should automount optical discs<ref>https://github.com/xbmc/xbmc/pull/20840</ref>
| example = Example: <syntaxhighlight lang=xml enclose="div"><automountopticalmedia>true</automountopticalmedia></syntaxhighlight>
}}

=== pathsubstitution ===
{{anchor|.3Cpathsubstitution.3E}}
{{main|Path substitution}}

{{divbox|red||'''Note:''' Path substition for "sources" and profiles is broken, and will '''NOT''' be fixed.}}

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>

=== controllerdeadzone ===
{{anchor|.3Ccontrollerdeadzone.3E}}
This advanced settings has been removed.
Since v17, the [[Advancedsettings.xml#controllerdeadzone|<controllerdeadzone>]] advanced setting has been removed. Deadzones can now be configured by plugging in the controller and selecting it in Settings -> System settings -> Input -> Peripherals.

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

=== touchscreen ===
{{anchor|.3Ctouchscreen.3E}}
This setting allows you to move/align the origin of the touch screen with the origin of the display used. If touch input does not result in a correct movement of the mouse pointer, the behaviour can be corrected with an offset and a stretch/compress factor.

Example:
<syntaxhighlight lang=xml enclose="div">
<touchscreen>
<x_offset>0</x_offset> 
<y_offset>0</y_offset> 
<x_stretch_factor>1.0</x_stretch_factor> 
<y_stretch_factor>1.0</y_stretch_factor> 
</touchscreen>
</syntaxhighlight>

=== scanirserver ===
Introduced in v18 and used in MS Windows setups only.<ref>https://github.com/xbmc/xbmc/pull/13896</ref>
Used to disable the regular connection attempts to the IR Server Suite when there is no remote to connect to.

The default setting is to allow connection attempts. To disable connection attempts change value to '''false'''.
<syntaxhighlight lang=xml enclose="div">
<scanirserver>true</scanirserver>
</syntaxhighlight>

== GUI rendering settings ==

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

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

=== smartredraw ===

{{note|This is an experimental feature and you might face issues using it. So please be aware of that.}}

This new feature was introduced in Kodi 18 and if enabled, the GUI process call (and therefore the render call) is only done if anything has changed. The result will be a faster GUI and less load if Kodi plays a video

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

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

=== anisotropicfiltering ===

This new feature was introduced for the GL/GLES rendering backends in Kodi 22. It allows for better (hardware specific) filtering of textures at glancing angles. Depending on the hardware it might have no effect, or there might be a performance degradation. Typical values are "2" or "3", but might go as high as "16", depending on the hardware. The default is "1" (disabled).

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<anisotropicfiltering>2</anisotropicfiltering>
</gui>
</syntaxhighlight>

=== fronttobackrendering ===

This experimental feature was introduced for the GL/GLES rendering backends in Kodi 22. It enables a form of occlusion culling, by rendering opaque object from front to back. Most GPUs should benefit from this setting (especially on ARM based systems), often resulting in higher frame rates or less memory bandwidth usage.

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

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

=== geometryclear ===

This experimental setting was introduced for the GL/GLES rendering backends in Kodi 22. It disables geometry based screen clearing in favor of fixed function clearing. Depending on the GPU (most ARM systems, Intel >gen 12), disabling the setting might be preferable for increased performance.

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

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<geometryclear>false</geometryclear>
</gui>
</syntaxhighlight>

== Other interface settings ==

=== window ===
{{anchor|.3Cwindow.3E}}
{{note|This is a "hidden" guisettings.xml setting (defined by the mouse moving the window size), but it is mentioned here because it is a particularly useful override when used in advancedsettings.xml}}
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>

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

=== showexitbutton ===
{{anchor|.3Cshowexitbutton.3E}}
Setting to hide the exit button, useful for people running appliance based setups 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>

There is also a fake fullscreen GUI option in Kodi's settings.

=== minimizetotray ===
{{anchor|.3Cminimizetotray.3E}}
{{note|Available in Kodi v20 and above.}}

Windows only. Minimizes Kodi to the system tray. Defaults to false.
<syntaxhighlight lang=xml enclose="div">
<minimizetotray>true</minimizetotray>
</syntaxhighlight>

= Removed tags =
{{anchor|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_IDs]] 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.
* {{anchor|.3Ckaraoke.3E}}'''<karaoke>''' - In v16 all of the karaoke features in Kodi were removed.
* '''<useddsfanart>''' - removed in v17 Krypton.
* '''<cachemembuffersize>''' and '''<readbufferfactor>''' - In v17 '''<cachemembuffersize>''' is renamed to '''<memorysize>''' and <code><readbufferfactor></code> is renamed to <code><readfactor></code>. In addition, all three buffer related settings in <network> are moved out of <network> and into a new <cache> parent tag.
* '''<minvideocachelevel>''', '''<minaudiocachelevel>''', and '''<cacheindvdplayer>''' have been removed in v17.
* '''<useffmpegvda>''' - Tag was only used for development testing. Removed in v17.
* '''<nofliptimeout>''' - Removed in v17
* '''<blackbarcolour>''' - Removed in v17 (maybe?)
* '''<disableswmultithreading>''' - Removed in v17 (maybe?)
* '''<controllerdeadzone>''' - Removed in v17
* {{anchor|.3Cmeasurerefreshrate.3E}}'''<measurerefreshrate>''' - Removed in v17 or v18?
* {{anchor|.3Cmyth.3E}}'''<myth>''' - Removed sometime between v16 to v18
* {{anchor|.3Ctuxbox.3E}}'''<tuxbox>''' - Removed
* '''<backgroundupdate>''' - Removed
* '''<hideemptyseries>''' - Replaced by a GUI option.
* '''<mymovies>''' and child tag '''<categoriestogenres>''' - Removed
* '''<albumssortbyartistthenyear'''> - Removed
* '''<albumformatright>''' - Removed
* {{anchor|.3Cremoterepeat.3E}}'''<remoterepeat>''' - Removed
* {{anchor|.3Callowd3d9ex.3E}}'''<allowd3d9ex>''' and {{anchor|.3Cforced3d9ex.3E}}'''<forced3d9ex>''' - Removed sometime between v16 to v18
* '''<lingertime>''' - Replaced by a GUI setting in v18
* '''<forcevaapienabled>''' - Removed in v18
* '''<dxvaallowhqscaling>''' - Removed in v18 <ref>https://github.com/xbmc/xbmc/pull/15466</ref>
* '''<promptfulltagscan>false</promptfulltagscan>''' Removed in v18. Now automatically asked each time a scan is conducted.
* '''<omxdecodestartwithvalidframe>''' - This tag is only in some Raspberry Pi specific distributions, such as OpenELEC. As of March 2015, this tag has not been merged into "vanilla" Kodi builds
* '''<musicthumbs>''' Replaced in v19 by the GUI setting '''Thumbnail image files''' found in Media -> Music
* '''<artistextraart>''' Replaced in v19 by the GUI setting '''Artist art types whitelist''' found in Media -> Music <ref>https://github.com/xbmc/xbmc/pull/22748</ref>
* '''<albumextraart>''' Replaced in v19 by the GUI setting '''Album art types whitelist''' found in Media -> Music
* '''<episodeextraart>''' Replaced in v19 by the GUI setting '''Episode art types whitelist''' found in Media -> Videos
* '''<tvshowextraart>''' Replaced in v19 by the GUI setting '''TV show art types whitelist''' found in Media -> Videos
* '''<tvseasonextraart>''' Replaced in v19 by the GUI setting '''TV show art types whitelist''' found in Media -> Videos
* '''<movieextraart>''' Replaced in v19 by the GUI setting '''Movie art types whitelist''' found in Media -> Videos
* '''<moviesetextraart>''' Replaced in v19 by the GUI setting '''Movie art types whitelist''' found in Media -> Videos
* '''<musicvideoextraart>''' Replaced in v19 by the GUI setting '''Music video art types whitelist''' found in Media -> Videos
* '''<fanart>''' Removed in v19
* '''<assfixedworks>''' Removed in v20
* '''<try10bitoutput>''' Removed in v20 and replaced with [[Settings/System/Display#Use_10_bit_for_SDR|Use 10 bit for SDR]] setting <ref>https://github.com/xbmc/xbmc/pull/20014</ref>
* '''<enablehighqualityhwscalers>''' Removed in v20 <ref>https://github.com/xbmc/xbmc/pull/21537</ref>
* '''<cache> / <memorysize> / <buffermode> / <readfactor> / <chunksize>''' - Removed in v21 and added to GUI settings page

= guisettings.xml Setting Conversion =
It is possible to convert settings found in the '''[[Settings]]''' ''(guisettings.xml)'' pages of {{kodi}} into entries for the advancedsettings.xml file.

When a setting from the guisettings.xml is added to the advancedsettings.xml file, it will override the existing guisettings.xml values and the setting will be removed from the settings pages.

Why would I need to do this?
* You set up multiple devices and then need to individually change settings and preferences on each device. Using this conversion method, you save those settings in the advancedsettings.xml file and simply add the file to each device
* You need to hide settings to prevent those settings from being modified

To convert a guisetting to advancedsettings.xml follow these steps:
# In the {{kodi}} settings pages, adjust the setting(s) to your preference.
# Back out of the settings pages to the main menu, which forces {{kodi}} to save the adjusted settings to the guisettings.xml file
# Locate the guisettings.xml file in the [[Userdata]] folder and open it
# Locate the setting(s) to be converted. The list can be overwhelming so make use of the Search feature of whichever editor you are using
# Using the following setting as an example:
<syntaxhighlight lang="xml">
<setting id="videolibrary.showemptytvshows">true</setting>
</syntaxhighlight>
: Breaking down the string:
::'''videolibrary'''- parent tag
::'''showemptytvshows'''- child tag
::'''true'''- value
: The conversion is as follows and place this in the advancedsettings.xml file
<syntaxhighlight lang="xml">
<advancedsettings version="1.0">
<videolibrary>
<showemptytvshows>true</showemptytvshows>
</videolibrary>
</advancedsettings>
</syntaxhighlight>

'''Note:''' Some parent tags may already be in use in your advancedsettings.xml file. Do not duplicate them, but add the child tag beneath the existing parent tag.

= References =
<references />

{{Updated|18}}
{{DISPLAYTITLE:advancedsettings.xml}}

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

Advancedsettings.xml

2025-07-07T21:46:26Z

Karellen: /* musicextensions */

{{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|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 version="1.0">
<setting>value</setting>
...
<setting>value</setting>
</advancedsettings>
</syntaxhighlight>

where "setting" gives the name of the setting, and "value" gives its value.

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

= List of available settings =
List of available settings that are recognised in the advancedsettings.xml file <ref>https://github.com/xbmc/xbmc/blob/master/xbmc/settings/AdvancedSettings.cpp</ref>

Recommended: Use the table of contents or the search function in your browser to locate items.

== Troubleshooting settings ==

=== loglevel ===
{{Anchor|.3Cloglevel.3E}}

<section begin="loglevel" />
Sets the logging level used to log errors and information. The "hide" attribute is optional.

<syntaxhighlight lang=xml>
<loglevel hide="attribute">options</loglevel>
</syntaxhighlight>

{| class="mw-collapsible mw-collapsed wikitable"
|-
! style="width:100px;" | Attribute
! style="width:500px;" | Action
|-
! '''true'''
| Hides the "enable debugging" setting in the Settings page. (default)
|-
! '''false'''
| Allows "enable debugging" setting to switch between '''0''' and '''2'''.
|}

{| class="mw-collapsible mw-collapsed wikitable"
|-
! style="width:100px;" | Option
! style="width:500px;" | Action
|-
! '''-1'''
| No logging, suppresses all log output
|-
! '''0'''
| Normal logging, only logging errors (default)
|-
! '''1'''
| Debug logging with freemem, fps and cpu usage (no on screen)
|-
! '''2'''
| Same as 1 (with on screen display)
|-
! '''3'''
| Same as 1 + full smb logging
|}

{| class="wikitable"
|-
! style="width:100px;" | Example
! style="width:500px;" |
|-
! Example 1:
|<syntaxhighlight lang=xml enclose="div">
<advancedsettings version="1.0">
<loglevel>2</loglevel>
</advancedsettings>
</syntaxhighlight>
|-
! Example 2:
|<syntaxhighlight lang=xml enclose="div">
<advancedsettings version="1.0">
<loglevel hide="true">2</loglevel>
</advancedsettings>
</syntaxhighlight>
|}

'''Note:''' The setting is persistent through shutdown and restarts.<br>
'''Note:''' If debugging is enabled in the GUI, loglevel will be set to '''2'''. This will over-ride the <code>advancedsettings.xml</code> setting. You must disable the GUI Setting before adding the entry to <code>advancedsettings.xml</code>.<br />
<section end="loglevel" />
:''{{see also|Log_file|label 1=Debug Log}}''

=== jsonrpc ===
{{Anchor|.3Cjsonrpc.3E}}
To make it easier for developers using the [[JSON-RPC_API]] 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>

== Audio/video playback settings ==

=== skiploopfilter ===
{{anchor|.3Cskiploopfilter.3E}}
The amount of the loop filter to skip on h.264 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
* 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}}

The <video> section also includes the following child-tags, which have their own sections:
*[[#cleandatetime]]
*[[#cleanstrings]]
*[[#excludefromscan]]
*[[#excludefromlisting]]
*[[#excludetvshowsfromscan]]

{{note|Some tags that have a "third-level" and are grouped together are highlighted in color.}}

{| class="prettytable"
! Tag !! Description
|-
|
<syntaxhighlight lang=xml>
<video>
</syntaxhighlight>
| Parent tag that all other child tags need to be placed inside of. Do not use more than one '''<code><video></code>''' tag, but instead place all other child-tags within a single '''<code><video></video></code>''' set.
|-
|
<syntaxhighlight lang=xml>
<subsdelayrange>10</subsdelayrange>
</syntaxhighlight>
| Delay range for subtitles, in seconds.
|-
|
<syntaxhighlight lang=xml>
<maxtempo>2.1</maxtempo>
</syntaxhighlight>
| Allow further increase of playback speed over the default of 1.5<br>
maxtempo must be in the range of 1.5 to 2.1 <br>
Be aware of the limitations of your platform / hardware as not all are capable of the increased maxtempo <ref>https://forum.kodi.tv/showthread.php?tid=10023&pid=2795069#pid2795069</ref>
|-
|
<syntaxhighlight lang=xml>
<audiodelayrange>10</audiodelayrange>
</syntaxhighlight>
| Delay range for audio/video sync, in seconds.
|-
|
<syntaxhighlight lang=xml>
<usetimeseeking>true</usetimeseeking>
</syntaxhighlight>
| Whether to use time based or percentage based seeking. {{small see also|Skip steps}}
|-
|
<syntaxhighlight lang=xml>
<timeseekforwardbig>600</timeseekforwardbig>
<timeseekbackwardbig>-600</timeseekbackwardbig>
</syntaxhighlight>
| Time to seek forward in seconds when doing a long seek. Defaults to 600 (10 minutes) and -600 (-10 minutes) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<percentseekforward>2</percentseekforward>
<percentseekbackward>-2</percentseekbackward>
</syntaxhighlight>
| Amount to seek forward as a percentage, when doing a short seek. Defaults to 2 (2%) and -2 (2%) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<percentseekforwardbig>10</percentseekforwardbig>
<percentseekbackwardbig>-10</percentseekbackwardbig>
</syntaxhighlight>
| Amount to seek forward as a percentage, when doing a long seek. Defaults to 10 (10%) and -10 (10%) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<fullscreenonmoviestart>true</fullscreenonmoviestart>
</syntaxhighlight>
| Whether to go to fullscreen or not when starting a movie. Defaults to true.
|-
|
<syntaxhighlight lang=xml>
<defaultplayer>VideoPlayer</defaultplayer>
</syntaxhighlight>
| Set the default video player: VideoPlayer or an external player. See '''[[External players]]''' for more info.
|-
|
<syntaxhighlight lang=xml>
<excludefromscan>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromscan>
</syntaxhighlight>
| Regular expressions that if evaluated to true won't be added to library. It is possible to add multiple <code><regexp></code> tags to match multiple patterns
|-
|
<syntaxhighlight lang=xml>
<excludefromlisting>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromlisting>
</syntaxhighlight>
| Regular expressions that if evaluated to true won't be displayed in files view.
|-
|
<syntaxhighlight lang=xml>
<playcountminimumpercent>90</playcountminimumpercent>
</syntaxhighlight>
| Minimum percentage that has to be played before it is marked as watched. Set to 101 to never auto-mark items as watched. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<ignoresecondsatstart>180</ignoresecondsatstart>
</syntaxhighlight>
| Number of seconds to ignore at video start after which a resume point is created. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<ignorepercentatend>8</ignorepercentatend>
</syntaxhighlight>
| Percentage of video to ignore at the end. If you stop watching the video here no resume point is created. Set to 101 to never save a resume point. The video is already marked as watched at 90%, see above. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<vdpauscaling>true</vdpauscaling>
</syntaxhighlight>
| Scales with vdpau instead of opengl and turns on its HQ scaler when available, enabling this might slow down rendering and cause framedrops especially on ION systems, this setting requires a vdpau feature set C GPU.
|-
|
<syntaxhighlight lang=xml>
<ppffmpegdeinterlacing>linblenddeint</ppffmpegdeinterlacing>
</syntaxhighlight>
| Override the deinterlacing options passed to libpostproc.
|-
|
<syntaxhighlight lang=xml>
<ppffmpegpostprocessing>ha:128:7,va,dr</ppffmpegpostprocessing>
</syntaxhighlight>
| Override the post processing options passed to libpostproc when 'Video post-processing' is activated in GUI Videos-Settings-Playback.
|-
|
<syntaxhighlight lang=xml>
<autoscalemaxfps>30</autoscalemaxfps>
</syntaxhighlight>
| When scaling method is set to auto, bilinear is chosen when the fps is higher than this limit, the default is 30.
|-
|
<syntaxhighlight lang=xml>
<adjustrefreshrate>
</syntaxhighlight>
| style="background:#CADCFB;" | Settings for when "Adjust refreshrate to match video fps" is enabled in the video playback GUI settings.
|-
|
<syntaxhighlight lang=xml>
<override>
<fps>23.976</fps>
<refresh>60.0</refresh>
</override>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' "Adjust refreshrate to match video fps" will try to select the best refreshrate for the video fps but it doesn't always get it right, for example it might switch to an unsupported refreshrate. You can add overrides here to switch to a certain refreshrate based on video fps. It's possible to add as many overrides as you need. Overrides are processed in order, if the first one doesn't match the fps or no refreshrates match that override, it will try the next one until no overrides are left.

* '''fps''' - if the fps is between 23.966 and 23.986
* '''refresh''' - switch to the first found refreshrate that is between 59.99 and 60.01
|-
|
<syntaxhighlight lang=xml>
<override>
<fpsmin>29.96</fpsmin>
<fpsmax>30.01</fpsmax>
<refreshmin>59.0</refreshmin>
<refreshmax>61.0</refreshmax>
</override>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -'''
* '''fpsmin''' / '''fpsmin''' - You can also specify the fps range yourself.
* '''refreshmin''' / '''refreshmax''' - Same for the refreshrate
|-
|
<syntaxhighlight lang=xml>
<fallback>
<refresh>50.0</refresh>
</fallback>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' If none of the overrides match, or none of the refreshrates match any of the fps matching overrides, it will choose a fallback refreshrate. Fallbacks are process in order, if the first fallback doesn't match any refreshrate, it will try the next one until no fallbacks are left.

* '''refresh''' - Switch to the first found refreshrate that is between 49.99 and 50.01.
|-
|
<syntaxhighlight lang=xml>
<fallback>
<refreshmin>49.0</refreshmin>
<refreshmax>51.0</refreshmax>
</fallback>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' You can also specify the range for the fallback yourself.

If none of the overrides match the video fps, or no refreshrates match any of the fps matching overrides, and no fallbacks are specified or no refreshrates match any fallbacks, it will automatically choose the best refreshrate (same as having no overrides and fallbacks).
|-
|
<syntaxhighlight lang=xml>
</adjustrefreshrate>
</syntaxhighlight>
| style="background:#CADCFB;" |
|-
|
<syntaxhighlight lang=xml>
<checkdxvacompatibility>value</checkdxvacompatibility>
</syntaxhighlight>
| Advanced setting not present: let Kodi autodetect cards that support H.264 profile > L4.1. Set value to false to enable DXVA no matter what. Set value to true if Kodi doesn't autodetect that the graphics card doesn't support > L4.1.
|-
|
<syntaxhighlight lang=xml>
<useocclusionquery>-1</useocclusionquery>
</syntaxhighlight>
| Use an occlusion query when capturing videoframes, -1 means auto detect, 0 means disabled, 1 means enabled, the default is -1.
|-
|
<syntaxhighlight lang=xml>
<fpsdetect>1</fpsdetect>
</syntaxhighlight>
| FPS detection for video playback
* 0 = trust codec fps
* 1 = recalculate from video timestamps with uniform spacing
* 2 = recalculate from video timestamps always
|-
|
<syntaxhighlight lang=xml>
<latency>
<delay>0</delay>
<hdrextradelay>0</hdrextradelay>
<refresh>
<min></min>
<max></max>
<rate></rate>
<delay></delay>
<hdrextradelay></hdrextradelay>
</refresh>
</latency>
</syntaxhighlight>
| '''Latency''' helps correct audio/video synchronization (lip-sync) when the display's internal processing introduces noticeable delays in the display of the pictures. The optional overrides and hdr extra delay offer further fine-tuning when the delay is not the same for all refresh rates or the HDR vs SDR modes. Latency is given in milliseconds. For one-off adjustments use the OSD during playback to adjust audio synchronisation.<br/><br/>
'''<delay>''' - Global default display latency.<br>
'''<hdrextradelay>''' - Global default latency added to the global default display latency when the display is in any HDR mode. Note: the display HDR mode is not detected on all platforms (Windows-only at time of writing).<br>
'''<refresh>''' - Override latency for given display (not video) refresh rates. When Kodi is in windowed mode, override is ignored. Multiple overrides are allowed.<br>
'''<min>''', '''<max>''' - refresh rate range, OR<br>
'''<rate>''' - exact refresh rate<br>
'''<delay>''' - display latency for the given refresh rate<br>
'''<hdrextradelay>''' - additional latency when the display is in any HDR mode for the given refresh rate<br>
<br/>
'''Example:''' The following example sets display latency of 125 msec at 23-24 Hz
<syntaxhighlight lang=xml>
<refresh>
<min>23</min>
<max>24</max>
<delay>125</delay>
</refresh>
</syntaxhighlight>
<br/>
'''Example:''' The following example sets display latency of 50 msec at 50 (+/-0.01) Hz
<syntaxhighlight lang=xml>
<refresh>
<rate>50</rate>
<delay>50</delay>
</refresh>
</syntaxhighlight>

|-
|
<syntaxhighlight lang=xml>
<stereoscopicregex3d>[-. _]3d[-. _]</stereoscopicregex3d>
<stereoscopicregexsbs>[-. _]h?sbs[-. _]</stereoscopicregexsbs>
<stereoscopicregextab>[-. _]h?tab[-. _]</stereoscopicregextab>
</syntaxhighlight>
| Filename triggers for 3D (stereoscopic) mode.
|-
|
<syntaxhighlight lang=xml>
<assfixedworks>false</assfixedworks>
</syntaxhighlight>
| Position behavior of ass subtitiles when setting "subtitle position on screen" set to "fixed". True to show at the fixed position set in video calibration. False to show at the bottom of video (default). {{note|Removed in Kodi v20.}}
|-
|
<syntaxhighlight lang=xml>
<subtitleverticalmargin>120</subtitleverticalmargin>
</syntaxhighlight>
| Allows to customise the vertical margin of text based subtitles, which will be applied to each type of subtitle position in subtitle settings. {{note|Available in Kodi v20 and above.}}
|-
|
<syntaxhighlight lang=xml>
</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>

<usetimeseeking>true</usetimeseeking>

<timeseekforwardbig>600</timeseekfowardbig>

<timeseekbackwardbig>-600</timeseekbackward>

<playcountminimumpercent>99</playcountminimumpercent>

<applydrc>-1.0</applydrc>

<limiterhold>0.025</limiterhold>

<limiterrelease>0.1</limiterrelease>

<maxpassthroughoffsyncduration>10</maxpassthroughoffsyncduration>

<allowmultichannelfloat>false</allowmultichannelfloat>

<superviseaudiodelay>false</superviseaudiodelay>
</audio>
</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

=== edl ===
{{anchor|.3Cedl.3E}}
{{main|Edit_decision_list}}
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>


<displaycommbreaknotifications>false</displaycommbreaknotifications>
</edl>
</syntaxhighlight>
'''Notes:'''
* displaycommbreaknotifications<ref>https://github.com/xbmc/xbmc/pull/20711</ref>

== PVR & Live TV ==
{{anchor|.3Cpvr.3E}}
Settings available for PVR, EPG and Live TV. Edit Decision List settings are located in the previous section.

=== pvr ===
<syntaxhighlight lang="xml" line='line'>
<pvr>
<timecorrection>0</timecorrection> 
<infotoggleinterval>3000</infotoggleinterval> 
<channeliconsautoscan>true</channeliconsautoscan> 
<autoscaniconsuserset>false</autoscaniconsuserset> 
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> 
</pvr>
</syntaxhighlight>

==== pvrrecordings ====
In v19 and later, allows users to modify sort type and order of pvr recordings. <ref>https://github.com/xbmc/xbmc/pull/18605</ref>

;Note- These settings are child tags to the ''<pvr>'' tag in the previous section.

<syntaxhighlight lang="xml" line='line'>
<pvr>
<pvrrecordings>
<sortmethod>2</sortmethod> 
<sortorder>2</sortorder> 
</pvrrecordings>
</pvr>
</syntaxhighlight>

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

== 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 .3g2 .3gp .nsv .tp .ts .ty .strm .pls .rm .rmvb .mpd .m3u .m3u8 .ifo .mov .qt .divx .xvid
.bivx .vob .nrg .img .iso .udf .pva .wmv .asf .asx .ogm .m2v .avi .bin .dat .mpg .mpeg .mp4
.mkv .mk3d .avc .vp3 .svq3 .nuv .viv .dv .fli .flv .001 .wpl .xspf .zip .vdr .dvr-ms .xsp .mts
.m2t .m2ts .evo .ogv .sdp .avs .rec .url .pxml .vc1 .h264 .rcv .rss .mpls .mpl .webm .bdmv
.bdm .wtv .trp .f4v
</pre>
Examples:
<pre>
<videoextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</videoextensions>
</pre>
<section end="videoextensions" />

=== discstubextensions ===
{{main|Media stubs}}

<section begin="discstubextensions" />
The default filename extension for Disc Stubs is:
<syntaxhighlight lang=xml enclose="div">
.disc
</syntaxhighlight>
Using the following tags, it is possible to <tt><add></tt> additional or <tt><remove></tt> existing disc stub extensions to better suit your requirements.
<syntaxhighlight lang=xml enclose="div">
<discstubextensions>
<add>.disk|.stub</add>
<remove>.disc</remove>
</discstubextensions>
</syntaxhighlight>
<section end="discstubextensions" />

=== languagecodes ===
{{anchor|.3Clanguagecodes.3E}}
User-defined translation table for language codes used in subtitles and audio.
It can be used to add, extend or override Kodi's language codes.

'''How to add a new language code:'''

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

'''How to add a new language code with subtag (e.g. pt-BR):'''
{{note|This support is available from Kodi v20}}

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>pt-BR</short>
<long>Portuguese - Brazil</long>
</code>
</languagecodes>
</syntaxhighlight>

''NOTE FOR MKV FILES:''<br/>
MKV files that contain audio/subtitle tracks with language codes with subtags are not yet supported, but from <code>Kodi v21</code> a workaround was introduced that allows Kodi to recognize language codes with subtags.
To use the workaround, you must open the MKV file with an editor and in the metadata of the desired audio/subtitle track, edit the track Name (or Title field) by adding the language code wrapped in curly brackets, as in following example:
<br/><code>Original track name: Audio portuguese/brazil</code>
<br/><code>Modified track name: Audio portuguese/brazil {pt-BR}</code>

'''How to extend an existing language code:'''

Set the same "long" description of the existing language, for example we reuse the Portughese language for another language code:

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>pt-BR</short>
<long>Portuguese</long>
</code>
</languagecodes>
</syntaxhighlight>

In this case when in Kodi settings you set the "Portuguese" language, when in playing according to availability the track "pt" or "pt-BR" will be chosen.

'''How to override an existing language code:'''

This allow you to rename an existing language. Set to an existing language code your preferred "long" name description.

''WARNING: This can cause problems with add-ons, so do not override languages if you are not aware of the side effects.''

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>en</short>
<long>English example</long>
</code>
<code>
<short>en-GB</short>
<long>English example</long>
</code>
</languagecodes>
</syntaxhighlight>

=== moviestacking ===
{{anchor|.3Cmoviestacking.3E}}<section begin="moviestacking" />
{{main|Naming_video_files/Movies}}
This is used by the [[Naming_video_files/Movies#Split_Video_Files|file stacking]] algorithm to combine multi-part files and contains a list of 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|Naming_video_files/Movies}}
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

Default expression:
<syntaxhighlight lang=xml enclose="div">
<video>
<cleandatetime>(.*[^ _\,\.\[\]\-])[ _\.\[\]\-]+(19[0-9][0-9]|20[0-9][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 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.

{{Github_link|[https://github.com/xbmc/xbmc/blob/Nexus/xbmc/settings/AdvancedSettings.cpp#L201-L211 Code in Github]}}

Default expressions:
<syntaxhighlight lang=xml enclose="div">
<video>
<cleanstrings>
<regexp>([ _\\,\\.\$\$\\[\\]\\-](10bit|480p|480i|576p|576i|720p|720i|1080p|1080i|2160p|3d|aac|ac3|aka|atmos|avi|bd5|bdrip|bluray|brrip|cam|cd[1-9]|custom|dc|ddp|divx|divx5|dolbydigital|dolbyvision|dsr|dsrip|dts|dts-hdma|dts-hra|dts-x|dv|dvd|dvd5|dvd9|dvdivx|dvdrip|dvdscr|dvdscreener|extended|fragment|fs|h264|h265|hdr|hdr10|hevc|hddvd|hdrip|hdtv|hdtvrip|hrhd|hrhdtv|internal|limited|multisubs|nfofix|ntsc|ogg|ogm|pal|pdtv|proper|r3|r5|read.nfo|remastered|remux|repack|rerip|retail|screener|se|svcd|tc|telecine|telesync|truehd|ts|uhd|unrated|ws|x264|x265|xvid|xvidvd|xxx|web-dl|webrip|www.www|\\[.*\\])([ _\\,\\.\$\$\\[\\]\\-]|$)");</regexp>
<regexp>(\[.*\])</regexp>
</cleanstrings>
</video>
</syntaxhighlight>
Updated in v20<ref>https://github.com/xbmc/xbmc/pull/20549</ref>

:* 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 Expressions

{{Github_link|[https://github.com/xbmc/xbmc/blob/Matrix/xbmc/settings/AdvancedSettings.cpp#L232 Code in Github]}}

Defaults:
<syntaxhighlight lang=xml enclose="div">
<tvshowmatching>
<regexp>s([0-9]+)[ ._x-]*e([0-9]+(?:(?:[a-i]|\\.[1-9])(?![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.
:* 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 [https://forum.kodi.tv/showthread.php?tid=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 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 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 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 syntax to match the locally stored trailers to movies in the library. Only files with recognized video file extensions will be considered, and the extensions are removed for the Regular Expression evaluation.

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

<regexp>(.*?)(_Trailer)$</regexp>
</trailermatching>
</syntaxhighlight>

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

{{Note|Kodi v20 users don't need set "importwatched" or "importresumepoint" to true anymore as that's the default then <ref>https://github.com/xbmc/xbmc/pull/20842</ref>}}

<syntaxhighlight lang="xml" line='line'>
<videolibrary>
<allitemsonbottom>false</allitemsonbottom> 
<cleanonupdate>false</cleanonupdate> 
<usefasthash>true</usefasthash> 
<recentlyaddeditems>35</recentlyaddeditems> 
<itemseparator> / </itemseparator> 
<exportautothumbs>true</exportautothumbs> 
<importwatchedstate>true</importwatchedstate> 
<importresumepoint>true</importresumepoint> 
<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>

== Library artwork ==

{{note|Using <imageres>9999</imageres> and <fanartres>9999</fanartres> will allow caching artwork at original size.}}

=== imageres ===
{{anchor|.3Cimageres.3E}}

<section begin="imageres description" />Specify the maximum resolution that [[Artwork/Cache#Texture optimization| cached artwork]] (other than fanart / 16:9 images) 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}}

<section begin="fanartres description" />Specify the maximum resolution that [[Artwork/Cache#Texture optimization| 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>

=== imagescalingalgorithm ===
Specify the image scaling algorithm for image resizing when [[Artwork/Cache#Texture optimization| caching artwork]] to the local texture cache.
<br />
<syntaxhighlight lang=xml enclose="div">
<imagescalingalgorithm>bicubic</imagescalingalgorithm>
</syntaxhighlight>

[https://github.com/xbmc/xbmc/blob/master/xbmc/pictures/PictureScalingAlgorithm.cpp#L20-L32 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>

=== imagequalityjpeg ===
This specifies the quality of the images when stored in jpeg format. By default kodi uses a quality of 4 which is a good compromise between size and quality. If you want to reduce the thumbnail sizes (decreasing quality) choose a higher value up to 21. If high quality (large thumbnail size) is needed, chose a smaller value, e.g. 0,1,2 or 3. (Added in v20 <ref>https://github.com/xbmc/xbmc/pull/21418</ref>)
<br />
<syntaxhighlight lang=xml enclose="div">
<imagequalityjpeg>4</imagequalityjpeg>
</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>

=== sorttokens ===
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>

In the above example "the ", "the." and "the_" will be ignored at the start of titles or names when sorting items, in both video and music libraries. A separator can also be specified, for example
<syntaxhighlight lang=xml enclose="div">
<sorttokens>
<token separators="'">L</token>
</sorttokens>
</syntaxhighlight>
In that case the value L', as in French movie name ''L'argent'', will be ignored and the item listed under "A".

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

:{{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.'''}}

'''Parent tags:'''

* '''<videodatabase>'''
* '''<musicdatabase>'''
* '''<tvdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''
* '''<epgdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''
{{MySQL warning}}

'''Child tags: '''

;<type>
: ''Required'' - Can be either "sqlite3" or "mysql" (default: sqlite3)

;<host>
:''Required'' -
* 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>
: ''Optional'' -
* sqlite3: silently ignored
* mysql: defines the port of the mysql socket (default: 3306)

;<name>
: ''Optional'' -
: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>
: ''Required for MySQL'' -
* sqlite3: silently ignored
* mysql: defines the user with privileged access to the database

;<pass>
: ''Required for MySQL'' -
* sqlite3: silently ignored
* mysql: defines the password for the user with privileged access to the database

;<connecttimeout> [https://github.com/xbmc/xbmc/pull/26657]
: ''Optional'' -
* sqlite3: silently ignored
* mysql: defines a connect timeout, in seconds. Default value is 5 seconds.

;<compression>
: ''Optional'' - 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}}

;<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]

'''Examples:'''

1) Configure a database for MySQL.
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', and '''<epgdatabase>''' 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>
<connecttimeout>3</connecttimeout>
</videodatabase>
</syntaxhighlight>

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

<section end="videodatabase" />

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

== Music settings ==

=== musicextensions ===
{{anchor|.3Cmusicextensions.3E}}
<section begin="musicextensions" />
Default extensions for MUSIC:
<pre>
.aac .ac3 .aif .aiff .ape .cmc .cmr .cue .dmc .dff .dsf .dsp .dts .dtshd .flac .gcm .gdm .idsp .imf
.m15 .m3u .m4a .m4b .mac .mka .mp+ .mp2 .mp3 .mpa .mpc .mpd .mpdsp .mpp .mpt .mss .nsv .oga .ogg .opus
.pls .pxml .rm .rma .rmt .rsd .rss .sap .sfx .shn .spt .strm .tak .tm2 .tm8 .tmc .tta .uni .url
.waa .wam .wav .wma .wpl .wtv .wv .wvs .xsp .xspf .xwav .zip
</pre>

It is possible to add or remove extensions for Music, using the following XML tags. Useful if you keep, say, FLAC and mp3 versions of music in the same folder. The <remove> tag can be used to remove mp3 from being listed in the library, leaving only the higher quality FLAC being displayed.

<musicextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</musicextensions>

<section end="musicextensions" />

=== 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 ===
Options specific to the Music Library
<section begin="MusicLibrary" />
<syntaxhighlight lang="xml" line='line'>
<musiclibrary>
<recentlyaddeditems>35</recentlyaddeditems> 

<prioritiseapetags>true</prioritiseapetags> 

<allitemsonbottom>true</allitemsonbottom> 

<cleanonupdate>false</cleanonupdate> 

<artistsortonupdate>false</artistsortonupdate> 

<albumformat>%B - %Y</albumformat> 

<itemseparator> / </itemseparator> 

<dateadded>1</dateadded> 

<artistseparators> 
<separator>;</separator>
<separator>:</separator>
<separator>|</separator>
<separator> feat. </separator>
<separator> ft. </separator>
</artistseparators>


<useisodates>false</useisodates> 


<artistnavigatestosongs>true</artistnavigatestosongs> 
</musiclibrary>
</syntaxhighlight>
{{Note|Changing the <itemseparator> or <artistseparators> will only affect newly added items. A rescan won't change the existing ones. Remove the Source(s) or delete the Music DB and rebuild. This process should be made easier from v18 and up using <promptfulltagscan>. <artistseparators> are cAsE sensitive and only used if you are not using MBID's. Separators will be used alongside MBID's from v22 onwards.}}<section end="MusicLibrary" />

== 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 .rss .webp .jp2 .apng
</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 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 ==

=== ftp ===
{{anchor|.3Cftp.3DE}}
Specific settings if a ftp server is in use as a source

<syntaxhighlight lang=xml enclose="div">
<ftp>
<remotethumbs>true</remotethumbs> 
</ftp>
</syntaxhighlight>

=== 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}}

<syntaxhighlight lang=xml line='line'>
<network>
<curlclienttimeout>10</curlclienttimeout> 
<curllowspeedtime>20</curllowspeedtime> 
<curlretries>2</curlretries> 
<httpproxyusername></httpproxyusername> 
<httpproxypassword></httpproxypassword> 
<disableipv6>false</disableipv6> 
<disablehttp2>false</disablehttp2> 
<nfstimeout>30</nfstimeout> 
<catrustfile>filepath</catrustfile> 
<curlkeepaliveinterval>30</curlkeepaliveinterval> 
<nfsretries>0</nfsretries> 
</network>
</syntaxhighlight>

'''More information:'''<br>
* <curlkeepaliveinterval><ref>https://github.com/xbmc/xbmc/pull/19319</ref><br>
* <nfsretries><ref>https://github.com/xbmc/xbmc/pull/19513</ref>

=== 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-ons|add-on]] rollback feature. Increasing the size should increase the amount of past versions saved. Defaults to 200 MB.
| example = Example: <syntaxhighlight lang=xml enclose="div"><packagefoldersize>200</packagefoldersize> </syntaxhighlight>
}}
<section end="packagefoldersize" />

=== detectasudf ===
{{anchor|.3Cdetectasudf.3E}}
{{xml setting
| tag name = detectasudf
| option type = binary
| option values = true, false
| default values = false
| platform = all
| XBMC version =
| description = Set to true if you wish to detect joint ISO9660/UDF disks as UDF.
| example = Example: <syntaxhighlight lang=xml enclose="div"><detectasudf>false</detectasudf></syntaxhighlight>
}}

=== handlemounting ===
{{anchor|.3Chandlemounting.3E}}
{{xml setting
| tag name = handlemounting
| option type = binary
| option values = true, false
| default values = false
| platform = Linux
| XBMC version =
| description = Only used in Linux, it defines if Kodi should attempt to mount media drives (via udisks or udisks2).<br/>Default: False. If kodi is executed with the --standalone option (e.g. as done by kodi-standalone.sh) it by default will be True.
| example = Example: <syntaxhighlight lang=xml enclose="div"><handlemounting>false</handlemounting></syntaxhighlight>
}}

=== automountopticalmedia ===
{{xml setting
| tag name = automountopticalmedia
| option type = binary
| option values = true, false
| default values = false
| platform = Linux
| XBMC version =
| description = Only used in linux for the udisks and udisks2 providers<br/>defines if kodi should automount optical discs<ref>https://github.com/xbmc/xbmc/pull/20840</ref>
| example = Example: <syntaxhighlight lang=xml enclose="div"><automountopticalmedia>true</automountopticalmedia></syntaxhighlight>
}}

=== pathsubstitution ===
{{anchor|.3Cpathsubstitution.3E}}
{{main|Path substitution}}

{{divbox|red||'''Note:''' Path substition for "sources" and profiles is broken, and will '''NOT''' be fixed.}}

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>

=== controllerdeadzone ===
{{anchor|.3Ccontrollerdeadzone.3E}}
This advanced settings has been removed.
Since v17, the [[Advancedsettings.xml#controllerdeadzone|<controllerdeadzone>]] advanced setting has been removed. Deadzones can now be configured by plugging in the controller and selecting it in Settings -> System settings -> Input -> Peripherals.

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

=== touchscreen ===
{{anchor|.3Ctouchscreen.3E}}
This setting allows you to move/align the origin of the touch screen with the origin of the display used. If touch input does not result in a correct movement of the mouse pointer, the behaviour can be corrected with an offset and a stretch/compress factor.

Example:
<syntaxhighlight lang=xml enclose="div">
<touchscreen>
<x_offset>0</x_offset> 
<y_offset>0</y_offset> 
<x_stretch_factor>1.0</x_stretch_factor> 
<y_stretch_factor>1.0</y_stretch_factor> 
</touchscreen>
</syntaxhighlight>

=== scanirserver ===
Introduced in v18 and used in MS Windows setups only.<ref>https://github.com/xbmc/xbmc/pull/13896</ref>
Used to disable the regular connection attempts to the IR Server Suite when there is no remote to connect to.

The default setting is to allow connection attempts. To disable connection attempts change value to '''false'''.
<syntaxhighlight lang=xml enclose="div">
<scanirserver>true</scanirserver>
</syntaxhighlight>

== GUI rendering settings ==

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

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

=== smartredraw ===

{{note|This is an experimental feature and you might face issues using it. So please be aware of that.}}

This new feature was introduced in Kodi 18 and if enabled, the GUI process call (and therefore the render call) is only done if anything has changed. The result will be a faster GUI and less load if Kodi plays a video

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

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

=== anisotropicfiltering ===

This new feature was introduced for the GL/GLES rendering backends in Kodi 22. It allows for better (hardware specific) filtering of textures at glancing angles. Depending on the hardware it might have no effect, or there might be a performance degradation. Typical values are "2" or "3", but might go as high as "16", depending on the hardware. The default is "1" (disabled).

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<anisotropicfiltering>2</anisotropicfiltering>
</gui>
</syntaxhighlight>

=== fronttobackrendering ===

This experimental feature was introduced for the GL/GLES rendering backends in Kodi 22. It enables a form of occlusion culling, by rendering opaque object from front to back. Most GPUs should benefit from this setting (especially on ARM based systems), often resulting in higher frame rates or less memory bandwidth usage.

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

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

=== geometryclear ===

This experimental setting was introduced for the GL/GLES rendering backends in Kodi 22. It disables geometry based screen clearing in favor of fixed function clearing. Depending on the GPU (most ARM systems, Intel >gen 12), disabling the setting might be preferable for increased performance.

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

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<geometryclear>false</geometryclear>
</gui>
</syntaxhighlight>

== Other interface settings ==

=== window ===
{{anchor|.3Cwindow.3E}}
{{note|This is a "hidden" guisettings.xml setting (defined by the mouse moving the window size), but it is mentioned here because it is a particularly useful override when used in advancedsettings.xml}}
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>

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

=== showexitbutton ===
{{anchor|.3Cshowexitbutton.3E}}
Setting to hide the exit button, useful for people running appliance based setups 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>

There is also a fake fullscreen GUI option in Kodi's settings.

=== minimizetotray ===
{{anchor|.3Cminimizetotray.3E}}
{{note|Available in Kodi v20 and above.}}

Windows only. Minimizes Kodi to the system tray. Defaults to false.
<syntaxhighlight lang=xml enclose="div">
<minimizetotray>true</minimizetotray>
</syntaxhighlight>

= Removed tags =
{{anchor|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_IDs]] 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.
* {{anchor|.3Ckaraoke.3E}}'''<karaoke>''' - In v16 all of the karaoke features in Kodi were removed.
* '''<useddsfanart>''' - removed in v17 Krypton.
* '''<cachemembuffersize>''' and '''<readbufferfactor>''' - In v17 '''<cachemembuffersize>''' is renamed to '''<memorysize>''' and <code><readbufferfactor></code> is renamed to <code><readfactor></code>. In addition, all three buffer related settings in <network> are moved out of <network> and into a new <cache> parent tag.
* '''<minvideocachelevel>''', '''<minaudiocachelevel>''', and '''<cacheindvdplayer>''' have been removed in v17.
* '''<useffmpegvda>''' - Tag was only used for development testing. Removed in v17.
* '''<nofliptimeout>''' - Removed in v17
* '''<blackbarcolour>''' - Removed in v17 (maybe?)
* '''<disableswmultithreading>''' - Removed in v17 (maybe?)
* '''<controllerdeadzone>''' - Removed in v17
* {{anchor|.3Cmeasurerefreshrate.3E}}'''<measurerefreshrate>''' - Removed in v17 or v18?
* {{anchor|.3Cmyth.3E}}'''<myth>''' - Removed sometime between v16 to v18
* {{anchor|.3Ctuxbox.3E}}'''<tuxbox>''' - Removed
* '''<backgroundupdate>''' - Removed
* '''<hideemptyseries>''' - Replaced by a GUI option.
* '''<mymovies>''' and child tag '''<categoriestogenres>''' - Removed
* '''<albumssortbyartistthenyear'''> - Removed
* '''<albumformatright>''' - Removed
* {{anchor|.3Cremoterepeat.3E}}'''<remoterepeat>''' - Removed
* {{anchor|.3Callowd3d9ex.3E}}'''<allowd3d9ex>''' and {{anchor|.3Cforced3d9ex.3E}}'''<forced3d9ex>''' - Removed sometime between v16 to v18
* '''<lingertime>''' - Replaced by a GUI setting in v18
* '''<forcevaapienabled>''' - Removed in v18
* '''<dxvaallowhqscaling>''' - Removed in v18 <ref>https://github.com/xbmc/xbmc/pull/15466</ref>
* '''<promptfulltagscan>false</promptfulltagscan>''' Removed in v18. Now automatically asked each time a scan is conducted.
* '''<omxdecodestartwithvalidframe>''' - This tag is only in some Raspberry Pi specific distributions, such as OpenELEC. As of March 2015, this tag has not been merged into "vanilla" Kodi builds
* '''<musicthumbs>''' Replaced in v19 by the GUI setting '''Thumbnail image files''' found in Media -> Music
* '''<artistextraart>''' Replaced in v19 by the GUI setting '''Artist art types whitelist''' found in Media -> Music <ref>https://github.com/xbmc/xbmc/pull/22748</ref>
* '''<albumextraart>''' Replaced in v19 by the GUI setting '''Album art types whitelist''' found in Media -> Music
* '''<episodeextraart>''' Replaced in v19 by the GUI setting '''Episode art types whitelist''' found in Media -> Videos
* '''<tvshowextraart>''' Replaced in v19 by the GUI setting '''TV show art types whitelist''' found in Media -> Videos
* '''<tvseasonextraart>''' Replaced in v19 by the GUI setting '''TV show art types whitelist''' found in Media -> Videos
* '''<movieextraart>''' Replaced in v19 by the GUI setting '''Movie art types whitelist''' found in Media -> Videos
* '''<moviesetextraart>''' Replaced in v19 by the GUI setting '''Movie art types whitelist''' found in Media -> Videos
* '''<musicvideoextraart>''' Replaced in v19 by the GUI setting '''Music video art types whitelist''' found in Media -> Videos
* '''<fanart>''' Removed in v19
* '''<assfixedworks>''' Removed in v20
* '''<try10bitoutput>''' Removed in v20 and replaced with [[Settings/System/Display#Use_10_bit_for_SDR|Use 10 bit for SDR]] setting <ref>https://github.com/xbmc/xbmc/pull/20014</ref>
* '''<enablehighqualityhwscalers>''' Removed in v20 <ref>https://github.com/xbmc/xbmc/pull/21537</ref>
* '''<cache> / <memorysize> / <buffermode> / <readfactor> / <chunksize>''' - Removed in v21 and added to GUI settings page

= guisettings.xml Setting Conversion =
It is possible to convert settings found in the '''[[Settings]]''' ''(guisettings.xml)'' pages of {{kodi}} into entries for the advancedsettings.xml file.

When a setting from the guisettings.xml is added to the advancedsettings.xml file, it will override the existing guisettings.xml values and the setting will be removed from the settings pages.

Why would I need to do this?
* You set up multiple devices and then need to individually change settings and preferences on each device. Using this conversion method, you save those settings in the advancedsettings.xml file and simply add the file to each device
* You need to hide settings to prevent those settings from being modified

To convert a guisetting to advancedsettings.xml follow these steps:
# In the {{kodi}} settings pages, adjust the setting(s) to your preference.
# Back out of the settings pages to the main menu, which forces {{kodi}} to save the adjusted settings to the guisettings.xml file
# Locate the guisettings.xml file in the [[Userdata]] folder and open it
# Locate the setting(s) to be converted. The list can be overwhelming so make use of the Search feature of whichever editor you are using
# Using the following setting as an example:
<syntaxhighlight lang="xml">
<setting id="videolibrary.showemptytvshows">true</setting>
</syntaxhighlight>
: Breaking down the string:
::'''videolibrary'''- parent tag
::'''showemptytvshows'''- child tag
::'''true'''- value
: The conversion is as follows and place this in the advancedsettings.xml file
<syntaxhighlight lang="xml">
<advancedsettings version="1.0">
<videolibrary>
<showemptytvshows>true</showemptytvshows>
</videolibrary>
</advancedsettings>
</syntaxhighlight>

'''Note:''' Some parent tags may already be in use in your advancedsettings.xml file. Do not duplicate them, but add the child tag beneath the existing parent tag.

= References =
<references />

{{Updated|18}}
{{DISPLAYTITLE:advancedsettings.xml}}

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

Audiobooks

2025-07-02T00:26:12Z

Karellen:

{{mininav|[[Music library]]}}

= Introduction =
<section begin="intro" />Audiobooks using the '''.m4b''' or '''.mka''' format and contain '''two or more chapters''' are natively handled in {{kodi}} without the need for additional add-ons or special setup.<section end="intro" />

The books can be used in Files Mode or can be scanned and scraped into the library along with their Authors. With a suitable skin that allows menu customisation, audiobooks can be separated from your traditional music library using '''[[Custom home items]]'''.

If your audiobooks use a different extension like .mp3, .wav or .flac, they can still be played in Kodi, but they will not display chapters nor save resume points, as these formats are not considered true audiobook formats. If you would like to convert your audiobooks to a compatible format, see the ''Converting Audiobooks'' section at the end of this wiki page.

= Setup =
It is strongly recommended that Audiobooks be separated into their own Source folder and not mixed in with your traditional music albums.

Just like music artists, the authors are added to the [[Artist information folder]].

== File Mode ==
If you are using File Mode without scanning or scraping, the only setup required is to add the Audiobook Source.

In the following link complete steps 1 - 6 and answer '''No''' in step 6
;''See:'' [[Adding_music_to_the_library#Initial_Set_Source_.26_Scan|Add Source]]

== Library Mode ==
Audiobooks are treated in the same manner as any other music file and can be scanned and scraped into the library.

MusicBrainz does have some author and audiobook information, but there is always the possibility that your author and audiobooks are not listed, so you may be required to manually tag your audiobooks, and create an '''''artist.nfo''''' file for the author. You should also consider adding them to MusicBrainz.

Authors should have their own folder in the '''[[Artist information folder]]'''
;''See:'' [[HOW-TO:Create_Music_Library|Setting up Music Library]]

= Usage =
Audiobooks follow the same conventions as Music
;''See:'' [[Music navigation]]

== Resume Points ==
Resume points are created for audiobooks using the '''.m4b''' or '''.mka''' file format only.

The first Resume Point can be created anytime after the play time of the first chapter is greater than 3 minutes. Subesequent chapters in the book do not have this requirement.

[[File:Audiobooks05.jpg|500px|left]]
{{-}}

To Resume listening, select a chapter (any chapter) to play. You will be offered a choice as shown in the image.
: '''Play'''- Commence playback of the selected chapter from the start
: '''Resume from...''' - Commence playback from the resume point, which may be in a different chapter to the one selected.

== Play Counts ==
{{Kodi}} will record the playcount of the audiobook when all chapters of the audiobook have been played to the end.

Playing only the final chapter to the end will not set a playcount.

= Converting Audiobooks =
This guide is a quick and easy method to create audiobooks in the '''mka''' format with the required chapters. Chapters are placed at equal time intervals and may not align with natural pauses in the story. Modifying chapter names and locations can be performed later.

*Download and install MKVToolNix... https://mkvtoolnix.download/
*Follow the steps in the images below:

<gallery mode="packed" widths="350px" heights="200px">
File:MKVToolNix01.jpg|Image 1- Adding and setting up conversion
File:MKVToolNix02.jpg|Image 2- Adding chapters and creating new audiobook
File:MKVToolNix03.jpg|Image 3- Modifying chapters if required
</gallery>

*'''Important: Once the book is complete, it will need to be re-tagged using MP3Tag or similar tagging software.'''

= Known Issues =
; 1. Embedded chapters have been renamed but Kodi does not display the new chapter names.
: When using m4b files there have been cases of some audiobooks with two sets of chapter marks embedded in the file. {{Kodi}} will read the first set of chapter markers, but some popular tagging software like mp3tag will only read the second set of chapter marks, so it becomes impossible to edit the first set of chapters. Running the file through [https://mediaarea.net/en/MediaInfo MediaInfo] will reveal in the resulting report if two sets of chapter markers are embedded in the file as ''Menu #1'' and ''Menu #2''
: The cause of the this is unknown. The only solution we are aware of is to reencode the file to mka using MKVToolNix. This keeps the first set of chapter marks and clears out the second set. Then use the chapter editor in MKVToolNix to edit the chapter names.

= Images =
<gallery mode="packed" widths="350px" heights="200px">
File:Audiobooks01.jpg|Image 1- Audiobooks added to Music library
File:Audiobooks02.jpg|Image 2- Audiobooks separated from traditional Music
File:Audiobooks03.jpg|Image 3- List of Audiobooks
File:Audiobooks04.jpg|Image 4- Chapter view of audiobook (using AeonNox:Silvo)
</gallery>

= References =
https://github.com/xbmc/xbmc/pull/11147

https://github.com/xbmc/xbmc/pull/15227

{{Top}}
{{updated|21}}

[[Category:Karellen]]
[[Category:Music library]]

Audiobooks

2025-07-02T00:07:04Z

Karellen:

{{mininav|[[Music library]]}}

= Introduction =
<section begin="intro" />Audiobooks using the '''.m4b''' or '''.mka''' format and contain '''two or more chapters''' are natively handled in {{kodi}} without the need for additional add-ons or special setup.<section end="intro" />

The books can be used in Files Mode or can be scanned and scraped into the library along with their Authors. With a suitable skin that allows menu customisation, audiobooks can be separated from your traditional music library using '''[[Custom home items]]'''.

If your audiobooks use a different extension like .mp3, .wav or .flac, they can still be played in Kodi, but they will not display chapters nor save resume points, as these formats are not considered true audiobook formats. If you would like to convert your audiobooks to a compatible format, see the ''Converting Audiobooks'' section at the end of this wiki page.

= Setup =
It is strongly recommended that Audiobooks be separated into their own Source folder and not mixed in with your traditional music albums.

Just like music artists, the authors are added to the [[Artist information folder]].

== File Mode ==
If you are using File Mode without scanning or scraping, the only setup required is to add the Audiobook Source.

In the following link complete steps 1 - 6 and answer '''No''' in step 6
;''See:'' [[Adding_music_to_the_library#Initial_Set_Source_.26_Scan|Add Source]]

== Library Mode ==
Audiobooks are treated in the same manner as any other music file and can be scanned and scraped into the library.

MusicBrainz does have some author and audiobook information, but there is always the possibility that your author and audiobooks are not listed, so you may be required to manually tag your audiobooks, and create an '''''artist.nfo''''' file for the author. You should also consider adding them to MusicBrainz.

Authors should have their own folder in the '''[[Artist information folder]]'''
;''See:'' [[HOW-TO:Create_Music_Library|Setting up Music Library]]

= Usage =
Audiobooks follow the same conventions as Music
;''See:'' [[Music navigation]]

== Resume Points ==
Resume points are created for audiobooks using the '''.m4b''' or '''.mka''' file format only.

The first Resume Point can be created anytime after the play time of the first chapter is greater than 3 minutes. Subesequent chapters in the book do not have this requirement.

[[File:Audiobooks05.jpg|500px|left]]
{{-}}

To Resume listening, select a chapter (any chapter) to play. You will be offered a choice as shown in the image.
: '''Play'''- Commence playback of the selected chapter from the start
: '''Resume from...''' - Commence playback from the resume point, which may be in a different chapter to the one selected.

== Play Counts ==
{{Kodi}} will record the playcount of the audiobook when all chapters of the audiobook have been played to the end.

Playing only the final chapter to the end will not set a playcount.

= Converting Audiobooks =
This guide is a quick and easy method to create audiobooks in the '''mka''' format with the required chapters. Chapters are placed at equal time intervals and may not align with natural pauses in the story. Modifying chapter names and locations can be performed later.

*Download and install MKVToolNix... https://mkvtoolnix.download/
*Follow the steps in the images below:

<gallery mode="packed" widths="350px" heights="200px">
File:MKVToolNix01.jpg|Image 1- Adding and setting up conversion
File:MKVToolNix02.jpg|Image 2- Adding chapters and creating new audiobook
File:MKVToolNix03.jpg|Image 3- Modifying chapters if required
</gallery>

*'''Important: Once the book is complete, it will need to be re-tagged using MP3Tag or similar tagging software.'''

= Known Issues =
; 1. Embedded chapters have been renamed but Kodi does not display the new chapter names.
: When using m4b files there have been cases of some audiobooks having two sets of chapter marks embedded in the file. {{Kodi}} will read the first set of chapter markers, but some popular tagging software like mp3tag will only read the second set of chapter marks, so it becomes impossible to edit the first set of chapters. The cause of the this is unknown. The only solution we are aware of is to reencode the file to mka using MKVToolNix. This keeps the first set of chapter marks and clears out the second set. Then use the chapter editor in MKVToolNix to edit the chapter names.

= Images =
<gallery mode="packed" widths="350px" heights="200px">
File:Audiobooks01.jpg|Image 1- Audiobooks added to Music library
File:Audiobooks02.jpg|Image 2- Audiobooks separated from traditional Music
File:Audiobooks03.jpg|Image 3- List of Audiobooks
File:Audiobooks04.jpg|Image 4- Chapter view of audiobook (using AeonNox:Silvo)
</gallery>

= References =
https://github.com/xbmc/xbmc/pull/11147

https://github.com/xbmc/xbmc/pull/15227

{{Top}}
{{updated|21}}

[[Category:Karellen]]
[[Category:Music library]]

Autoexec Service

2025-06-14T20:31:33Z

Karellen:

= Automatically execute code when Kodi starts up. =
If you wish to run some code automatically when Kodi starts, you can do so by creating a service add-on.<br>

(This replaces the now deprecated method of adding an autoexec.py file in the [[userdata]] folder.<ref>https://github.com/xbmc/xbmc/pull/18356</ref>)

== Create a folder for your autoexec add-on ==
# Navigate to the '''''addons''''' folder in the [[Backup#Kodi_Data_Folder|Kodi Data Folder]]
#Create a folder named '''service.autoexec'''.

<gallery widths="367px" heights="189px">
Autoexec.jpg|Folder structure
</gallery>

== Add an autoexec.py file ==
Move your existing autoexec.py file to this folder, or if you don't have one yet, create it and check out the code examples below.

== Add an addon.xml file ==
Create an addon.xml file in this folder and copy and paste the following code to it:
<syntaxhighlight lang="XML" enclose="div">
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addon id="service.autoexec" name="Autoexec Service" version="1.0.0" provider-name="your username">
<requires>
<import addon="xbmc.python" version="3.0.0"/>
</requires>
<extension point="xbmc.service" library="autoexec.py">
</extension>
<extension point="xbmc.addon.metadata">
<summary lang="en_GB">Automatically run python code when Kodi starts.</summary>
<description lang="en_GB">The Autoexec Service will automatically be run on Kodi startup.</description>
<platform>all</platform>
<license>GNU GENERAL PUBLIC LICENSE Version 2</license>
</extension>
</addon>
</syntaxhighlight>

== Enable your addon in kodi ==
Navigate to the autoexec add-on in the addonbrowser and enable it:<br>
'''Settings > Add-ons > My add-ons > Services > Autoexec Service'''

= Examples =

== Simple Examples ==

The following example starts your favourite addon:
<syntaxhighlight lang="python" enclose="div">
import xbmc

xbmc.executebuiltin('RunScript(script.globalsearch)')
</syntaxhighlight>

This example takes you to the movie overview:
<syntaxhighlight lang="python" enclose="div">
import xbmc
xbmc.executebuiltin('ActivateWindow(videos,movietitles)')
</syntaxhighlight>

Here is an example that takes you to the Favourites screen:
<syntaxhighlight lang="python" enclose="div">
import xbmc
xbmc.executebuiltin('ActivateWindow(FavouritesBrowser)')
</syntaxhighlight>

== Example using profiles==
If you are using profiles and wish to run specific code based on the user who logs in, it can be done like this:
<syntaxhighlight lang="python" enclose="div">
import xbmc

if xbmc.getInfoLabel('System.ProfileName') == 'Master user':
xbmc.executebuiltin('RunScript(script.globalsearch)')

elif xbmc.getInfoLabel('System.ProfileName') == 'your username':
xbmc.executebuiltin('ActivateWindow(videos,movietitles)')
</syntaxhighlight>

= References =
[[Built-in scripting#Using Built-in Functions from python]]

[[List of built-in functions]]

<References />

{{updated|21}}
[[Category:Python]]
[[Category:Settings]]

Official:Forum rules/Banned add-ons

2025-06-05T05:32:09Z

Karellen:

{{mininav| [[Official:Forum rules]]}}

This is an example list of repositories and add-ons that have been identified as violating the {{kodi}} '''[[Official:Forum rules]]'''. This means they have been banned from any official {{kodi}} forums, websites, IRC channels and any social media accounts that are under the control of Team Kodi or the [[XBMC Foundation]].

'''{{big|{{red|This list is only an example. Due to the dynamic nature of Piracy streams and the add-ons that access them, it is impossible to list all Builds/Repositories/Add-ons that violate the [[Official:Forum_rules#Piracy_Policy|forum rules]]}}}}'''

While Team Kodi does not regulate what users install or use, we offer no support when your install includes add-ons that violate the forum rules. Failure to do so may result in a ban.

== How do I tell if something is allowed or not==
{{collapse top|click "Expand" to view the rules on piracy/bootleg video content -->}}
{{main|Official:Forum rules}}
{{#lst:Official:Forum rules|piracy policy}}
{{collapse bottom}}

The basic rule of thumb for what is not allowed, is that if the Add-on is offering something for free that you would normally expect to pay for by any other means, then it'll most likely be using pirate feeds.

If the Add-on simply allows access to web feeds from the rights holders then discussion of these is normally allowed, in this case there generally will be a website equivalent of the service, for example Youtube, BBC iPlayer, Netflix.

'''Note -''' If the Add-on is from our Official Add-on Repo then it has already been checked that it doesn't break our rules, therefore anything contained in the Official Repo is safe to discuss in any of our websites/channels.

== Kodi Forks ==
* Nodi
* QODI
* Streamsmart
* TVMC

== Wizards ==
All Wizards and addon installers

== Builds ==
Any build featuring or offering one or more of the repositories or add-ons listed below
* <4k Colors>
* alluneed
* <Apollo>
* Balkan Green
* Buildstube
* Buildstuben
* Breezz
* <Bucks>
* cMaNWizard 
* Crewnique
* <Diamond>
* Doomzday
* EzzerMac
* FTMC TTM
* FMC
* Funsterplace
* Grindhouse
* GTKing 
* Infenity
* Kelebek
* Kodianer
* Luar
* Magic Dragon
* <Magnetic> 
* NarcacistWizard 
* One Nation
* Redbox
* Skydarks
* SkyMashi TV
* Slamious 
* Spartan 
* Sports 101
* StreamDigitalRepo
* Supreme build 
* The Crew
* Twistednutz
* Xanax
* Xenon
* Xtasy

== Repository blacklist ==
* 13Clowns 
* 5Star 
* 667repo
* 709 
* Absolut 
* addons4kodi 
* Adjaranet
* Adryan Lists 
* Aenemapy 
* Aftershock 
* <Agent> 
* <AH> 
* Alado 
* AJ Builds 
* Alfa 
* Aliunde 
* AllEyezOnMe 
* Androidbboy 
* <Apollo> 
* <Ares> 
* Atomic 
* Atom Reborn 
* <Awesome> 
* Balandro 
* Bamf 
* Beau B 
* BC Repo 
* Black Ghost 
* Blamo 
* <Blaze> 
* BlissTV 
* Brettus 
* Bubbles 
* Bugatsinho 
* Bulldog Streams 
* Bookmark Lite 
* Camaradas 
* Canal Nereo 
* <Canvas> 
* Carnamaleon 
* Catoal 
* Cazlo 
* Cellar Door TV 
* Cerebro 
* Chains 
* Chikiry 
* Colossus 
* Cosmic Saints 
* Cyberflix
* Cyphers Locker 
* Dandy Media 
* Dark Media 
* Decosub 
* DejaVu 
* Deliverance 
* Diablo 
* <Diamond> 
* Diamondback 
* Diggz 
* Dimitrology 
* Dobbelina 
* Docshadrach 
* Doomsday 
* Duckpool 
* Dudehere 
* Durex 
* Eggman (Overeasy) madtitansports
* Eleazar 
* Elementum 
* Elysium 
* EntertainmentRepo 
* Exodus 
* Exodus Redux 
* Ezra 
* EzzerMacs 
* FanFilms 
* <Flawless> 
* Fido 
* Fierce Gorilla 
* FilmKodi 
* FireTVGuru 
* FireStick Plusman 
* Flecha Nega 
* Foxystreams 
* Fractured 
* FracturedWizard 
* funstersplace 
* Fusion 
* Gaia 
* <Galaxy> 
* GenTec 
* GenieTV 
* Ghost IPTV 
* Goodfellas 
* GB160 
* Goliath 
* Griffin 
* Grindhouse 
* GTKing 
* <Gujal> 
* Hacky 
* HalowTV 
* Hellhounds 
* HEVC Video Club
* Hiraya 
* HSK 
* Host 505 
* House of el 
* Humla
* Iceballs 
* Illuminati 
* Incursion 
* Infiniflix 
* Jewrepo 
* J1nx
* Jesus box tv 
* Jsergio 
* Juggernaut 
* K3l3vra 
* Kaosbox2 
* <kb> 
* KDC 
* Kdil
* Kinkin 
* Kirks Build
* KNE 
* Kod1
* Kodi Addons Club
* Kodiadictos
* Kodi Balkan 
* Kodibae 
* Kodi-CZSK 
* Kodi Ghost 
* Kodi Israel for
* Kodil 
* Kodi Neu Erleben 
* Kodi Rae 
* Kodi Tips 
* KoDIYhelp 
* Kodi UKTV 
* Kodiwpigulce 
* Krogsbell IPTV
* K.U.S. 
* LastShip 
* Lazarus 
* <Lambda> 
* Lazy Kodi
* Legion 
* Leviathan 
* <Lockdown> 
* Loki 
* Looking Glass 
* LoonaticsAsylum 
* <Loop> 
* Man Cave 
* Maestro 
* Mad Titan Sports 
* Magicality 
* Magnetic 
* Maniac 
* Markop159 
* Mar33 
* MasterZD 
* Mats Builds 
* Maverick 
* Mbebe 
* Megatron 
* <Merlin> 
* Metal Kettle 
* Mhancoc 
* Milhano 
* Misfit Mod Light
* Mobie
* MorePower 
* Movie shark
* MoviesHD 
* MrandMrsSmith 
* MrBlamo
* MrFreeworld 
* Mr Stealth 
* MTL FREETV
* Mucky Ducks 
* MyShows.me 
* Narcacist 
* Nixgates 
* No-issue
* Noledynasty 
* Noobs and nerds 
* <Notsure> 
* Number 1 Guru 
* <Numbers>
* Numb3r5
* Oblivion 
* <Octopus> 
* <Oculus> 
* Onealliance 
* OneNation 
* Openeleq 
* Open Wizard 
* <Origin> 
* Orion 
* Ororo TV 
* Pandoras Box 
* <Phoenix Reborn> 
* Pipcan 
* Players Klub 
* Playon Monkey 
* Plexus 
* Podgod 
* Premiumize 
* <Press Play> 
* Prototype 
* Ptom 
* Pulsar 
* <Pulse> 
* PureRepo 
* Quasar 
* raeenterprises 
* Razer 
* Red Hood 
* Redditreaper 
* Renegades 
* Repoil Club 
* Retromania 
* Ring of Saturn 
* Rising Tides 
* Robin Hood 
* Rodrigo 
* Rockcrusher 
* Sanctuary 
* Sandman 
* Sarcasm 
* Sasta TV 
* Scarecrew 
* Sdarot 
* Seren
* Shani 
* Simply caz 
* Skydarks 
* Slam 
* SpinzTV 
* Sports Devil 
* Sports Access 
* Smash repo 
* Smash Wizard 
* Smoothstreams 
* Stealth 
* <Stefano> 
* Steptoes 
* SteamDigitalRepo 
* StreamArmy 
* Stream Hub 
* SubZero 
* SuicideTV 
* Super Repo 
* Supremacy 
* Sweetwork 
* T2K 
* Targetin Wizard
* Tantrum TV 
* TDW1980 
* Team DNA 
* Team Nutz
* Tempest 
* The Crew 
* TheGroove 
* The Mania Services 
* <The Loop> 
* The Real Urban Kingz 
* The Unjudged
* The Vibe 
* The wiz
* Thgiliwt 
* <Titan> 
* Tikipeter 
* Tivustream 
* Tk Norris 
* Total Installer 
* TOTALXBMC
* Tsunami OG 
* TVADDONS 
* TV King 
* Twilight0 
* Ufo 
* Underdog 
* UK Turk 
* UK Turks 
* Ukodil 
* Umbrella 
* <Unity>
* <Universal Scrapers> 
* uRepo 
* Vader Streams 
* <Venom> 
* Vidtime 
* VIP Secret TV 
* <Vista> 
* VKKodi 
* VS247 
* Vstream 
* Warehouse
* Where the monsters live 
* White Devil 
* WikiXBMC
* Willows 
* Wolfpack 
* Wookie 
* Wrestling on Demand 
* Xan 
* XBMC HUB 
* Xfinity
* <Xstream> 
* Xunity
* XvBMC 
* Whitecream 
* Zero Tolerance 

== Add-on blacklist ==
* 123Movies 
* 13Clowns 
* 1Angels
* 1Channel 
* <1x2> 
* 80sstuff 
* AceStreams
* Adryanlist 
* Aftershock 
* Alfa 
* AllDebrid
* All Eyez on Me
* All Movies Stream
* <Alpha> 
* Alvin
* Amigos
* Animeram 
* Aragon 
* Area 51
* <Ares> 
* Arrakis 
* Asgard 
* Aspis 
* At The Flix 
* Atomic 
* Atom Reborn 
* BaddAssMovies4U 
* Bandicoot
* Bassfox-official
* BBTS 
* BBTSIP
* <Beast>
* Bennu 
* Binky TV 
* Black Ghost 
* Blamo 
* Bob Unleashed 
* BrazucaPlay 
* Brettus
* Bubbles 
* Cannabis 
* <Canvas> 
* Caretaker
* CartoonHD
* Cartoons8 
* cCloud 
* Cellar Door
* Cerebro 
* Chappa'ai 
* Chronos 
* Cine 
* Cloud 9 
* Cloudword
* coalition 
* cocoscrapers 
* Community Portal
* Configurator for Kodi
* Config wizard
* Continuum
* Cosmic Saints
* Covenant \
* Cristal Azul 
* DaddyLive 
* Daffys 
* Deccan Delight
* Dexter TV 
* Diabolik 
* Diesel
* Ditto Rain
* Ditto HotRain
* DOCU HUB 
* DosMovies
* Dreamcatcher
* Duck Shitmancave
* Durex 
* Dynasty
* Einthusan
* Eldorado 
* Elementum 
* Eliplex TV
* Elysium 
* Entertainment Hub
* Exodus 
* ExodusRedux 
* Exoshark
* Ezra
* EzzerMan 
* Fan Film
* F_50ci3ty
* F.T.V. 
* F4M proxy 
* F4M tester 
* <Fantastic> 
* Fen 
* Feren
* Film Kodi
* Film Dictator
* Filmux
* Final Gear
* Fine and Dandy 
* Fire TV Guru
* Flixnet
* FutbolTream 
* Free Streams 
* <Fresh start> 
* Gaia
* <Galaxy>
* <Genesis> 
* Genesis Reborn 
* Genie TV
* Goliath
* Good fellas 
* GoMovies
* GoTV
* gratis 
* Green Revolution
* Gurzil 
* HalowIPTV
* Hard Nox
* HDFilme.cx 
* HDHub4u
* Horus 
* Hot rain
* I4a TV
* I Watch Online
* Icarus 
* Ice Films 
* Incursion 
* Indian TV
* Indigo 
* Infiniflix 
* IPTV Stalker
* IPTV Simple Client 2
* Ironman 
* IStream
* IVue TV 
* Iwannawatch 
* J1nxPack
* Jango Music
* Jeckyll Hyde
* Jesus Box
* JokerSports 
* Jor El 
* Kaito 
* Kartina TV 
* Kids1ClickMovie 
* Kidsflix
* Kino.pub
* Kiss Anime 
* Klugscheisser
* KodiCat
* Kodiland
* KodiOnDemand
* Kodi Popcorn Time 
* KodiUK TV
* Kratos 
* Kratos Reborn 
* Lastship
* Latest Dude
* Legendary 
* Leviathan
* Limitless 
* Livehub 
* Live Streams Pro 
* <Logan> 
* Loki 
* Looking Glass
* LoopTV 
* Lucky IP TV 
* Mad Titans 
* Maestro IP TV 
* Magic Dragon 
* Magicality 
* Magyck PI
* MandraKodi 
* Marvin
* MashUp
* Maverick 
* MD repo
* Mega Reborn 
* Mega Search
* Mercury 
* Metallik 
* Metalliq 
* MK Sports
* Mobdina 
* Mobdro 
* Modbro
* Money Sports
* Moria 
* MotorReplays 
* <Movie Hub>
* Movie Hut
* Movie Night
* Movies Tape
* Movie25
* Movie4k 
* Movie Rulz
* Movies XK
* MovieStorm
* Mp3streams
* MrKnow 
* MrPiracy 
* Mucky Duck
* MuchMovies
* Mutts Nuts
* Navi X 
* Navy Seal
* Nemesis 
* Neptune Rising 
* Nextgen 
* Nightwing 
* NLView
* No Limits
* Nole Cinema
* Numb3r5
* <Numbers>
* Numbersbynumbers 
* OCW Reborn 
* Odin 
* One Alliance
* One Click Moviez 
* One Nation 
* Online Movies Pro
* Operation Robocop
* Open Wizard 
* Orion 
* Ororo TV 
* Overeasy 
* P2P Streams 
* Palantir 
* Paradox
* Paragon
* <Phoenix> 
* phstreams 
* Picasso 
* Placenta 
* Players Klub
* Plexus 
* Popcorn Time
* Poseidon 
* POV
* Premiumize 
* Prime Links
* Prime Streams 
* Primewire
* Project Cypher
* Project Free TV 
* <Promise>
* Pro Sport; Pro-Sport; ProSport 
* Pulsar 
* Pyramid 
* Q Sports
* Quantum
* Quasar 
* Rapid Bit
* Real Debrid
* Real Movies 
* Rebirth 
* ReleaseBB
* Release Hub
* Renegades TV
* Rising Tides 
* RockCrusher
* RL series
* RobinHood Project 
* Resistance 
* Royal We 
* SALTS 
* Sanctuary
* Sasta TV 
* Schism 
* Scrubs 
* Season Dream 
* Seren 
* Settv
* Selfless
* Sdarot.tv 
* < Shadow > 
* Showbox 
* Silent Hunter
* Simple Kodi Wizard 
* <Smash> 
* Smooth streams 
* Soap Catchup
* Soulless
* Sparkle 
* Specto 
* Spinz TV
* Sport A Holic
* Sport365
* SportHDme 
* Sports Access 
* Sports Devil 
* Sportsmania
* SportzTV 
* Stallion
* Stream army 
* Stream Cinema 
* Stream hub 
* Stream on Demand
* Stream Storm TV
* Stream This TV
* Subzero 
* Super Streams
* SuperTV
* Supremacy 
* Swa Desi
* Swiftstreamz 
* Tantrumtv 
* TARDIS 
* TATA.TO-TV
* TATA.TO-VIDEO
* TAZ
* TeamZT Kriptix
* Teatv
* TecnoTV
* TeeVee 
* TempTV 
* Tempest 
* Terrarium TV
* The Chains 
* The Crew 
* The Dog's Bollocks 
* <The Loop> 
* The Oath 
* The Promise 
* The Yid 
* Tiggers
* Tiki 
* Tivustream 
* T Killa
* Toon Mania 
* truncatetables 
* TurkVod
* TV One 
* TVOnline 
* TVsupertuga 
* UK Turk Playlist 
* UK TV Now 
* Ultimate installer
* Ultimate IPTV
* <Universal Scrapers> 
* Uranus 
* Vader Streams 
* Vdubt25
* Velocity 
* <Venom> 
* Video devil 
* Videodevil 
* Vip secret
* Vortech TV
* Vstream 
* White cream
* White Devil
* Wolfpack 
* Wookie
* Wraith
* Wrestling On Demand
* Xan 
* Xfinity Installer
* XMovies8
* <Xstream>
* Xunity 
* Xship 
* xxxodus 
* Yify Movies 
* Yoda 
* Zem TV 
* Zeta TV
* Zeus 

==So where do I get support?==
Every Add-on should contain the authors name, this is found by opening the Context menu on the Add-on and selecting '''Add-on Information'''

Generally a search of the Add-on's name together with the author name will give the location of where the author is active.

For example a search term might be:

'''Kodi TheCollective Youtube'''

[[File:add-on-context.JPG|400px]]
[[File:add-on-info.JPG|400px]]

<i style="display:none; speak:none;">
* Abortion
* airline
* Airlines
* Airways
* Astrologer
* Astrology
* Asshole
* Babaji
* Cash Loan
* Credit card
* cruise
* Crypto
* cunt\w*
* Customer
* Divorce
* được
* flight
* fuck\w*
* FullZ
* Gestapo
* Helpline
* Hitler
* India
* payday loans
* PhonePe Support
* Lasix
* Marriage
* Moderator
* Moderators
* Mumbai
* Nazi
* Những
* omegle
* omglz
* Onlyfans
* Real Love
* refund
* Switchonshop
* Switch0sh0p
* Switch0nsh0p
* Switchonsh0p
* Switch0nshop
* \$witchon\$hop
* \$witch0\$hop
* \$witchon\$hop
* \$witch0n\$h0p
* p\.com
* teléfono
* Temu
* tutorials-iptv-xbmc.blogspot
* Viagra
* VPN
* Witch
* ¿Cómo
</i>

{{top}}

__NOINDEX__
[[Category:XBMC_Foundation]]

Log file/Easy

2025-05-26T20:13:12Z

Karellen:

{{mininav| [[Troubleshooting]] | [[Log file]] }}
__FORCETOC__

= Introduction =
<section begin="intro" />This method assumes you are able to navigate the menu system of {{kodi}}. If you cannot gain access to the menu system, then you will need to follow the '''''[[Log_file/Advanced|Advanced Method]]'''''.<section end="intro" />

= Steps =
Ensure you follow each step in the displayed order.

'''Note:''' If you intend to use the '''''[[Add-on:Kodi_Logfile_Uploader| Kodi Logfile Uploader Add-on]]''''' install the add-on '''now''' before commencing the steps.

{| class="prettytable" style="width:70%"
|-
! scope="row" ! style="background-color:#b8ecff; text-align:left;"|1. Enable Debug Mode by using one of the following methods:
|}
<section begin="EnableDebugMode" />:* Enable the setting '''Enable debug logging''' in the settings page located at '''''[[Settings/System/Logging#Debug|Settings > System Settings > Logging]]'''''
:* Pressing {{keypress|ctrl|shift|d}} on a keyboard
:* Create an entry in the '''''[[Advancedsettings.xml#loglevel|advancedsettings.xml]]''''' file. See: '''''[[Log_file/Advanced|Advanced Method]]'''''<section end="EnableDebugMode" />

:If you have been asked to enable component specific logging see '''''[[Log_file/Easy#Enable_component-specific_logging|Enable component-specific logging]]''''' section below.

{| class="prettytable" style="width:70%"
|-
! scope="row" ! style="background-color:#b8ecff; text-align:left;"|2. Restart {{Kodi}} using one of the options in the {{kodi}} Power Menu.
|}
:Do not simply disconnect the power. Doing this may prevent saving the changes you made in the Settings page when you enabled Debug Mode.

:When you restart, you should see counters displayed in the top left corner of the screen. If you do not see these counters, then debug mode is not enabled.

:Restarting has the following effect:
:* Reduce the size of the log by clearing it and starting fresh
:* It captures the startup that can reveal critical information about the installation. eg graphics cards, audio drivers, versions etc

{| class="prettytable" style="width:70%"
|-
! scope="row" ! style="background-color:#b8ecff; text-align:left;"|3. It is important that you now replicate the problem while the log is running. Do whatever you did previously when you experienced the problem.
|}
:For example...

:* If you are having problems scraping, then run an Update Library
:* If you are having problems with playback, then try playing the problematic video or music file
:* If you cannot install add-ons, then try installing the add-on.

{| class="prettytable" style="width:70%"
|-
! scope="row" ! style="background-color:#b8ecff; text-align:left;"|4. The log must now be uploaded to the [https://paste.kodi.tv/ Kodi paste site] using one of the methods in the next section:
|}

= Uploading Methods =
Choose one of these methods to upload the log.

<div style="margin-left: 4em;">
== Add-on Kodi Logfile Uploader ==
:If you are using this method to upload the log, you may run it now. Once you upload the logfile, you must post the provided url into a post on the forum. Without it, we will be unable to locate your logfile.

:By default the add-on only uploads the current ''kodi.log'' file. If you need to upload the ''kodi.old.log'', ensure the setting is enabled in the add-ons setting page. Once enabled, you will need to upload the current ''kodi.log'', then upload the ''kodi.old.log''

::'''''See: [[Add-on:Kodi_Logfile_Uploader| Kodi Logfile Uploader Add-on]]'''''

== Add-on Caber Toss ==
:Caber Toss is a script addon that allows you to move the logs to a more accessible location on your system or network. Useful on restricted operating systems like Android.

::'''''See: [[Add-on:Caber_Toss|Wiki page]] and [https://forum.kodi.tv/showthread.php?tid=379304 Forum thread]'''''

== File Manager ==
{{list|Log file/File manager access}}
:Once you have obtained the log, use the Copy and Paste method to upload the log.
</div>

<div style="margin-left: 4em;">
== Copy and Paste ==
<section begin="CopyAndPaste" />:If you are using a desktop operating system, such as Windows, then you can simply navigate to the Debug Log using the File Manager of the operating system.

:Once you find the log...
:#Open it with any text editor and copy the contents of the file.
:#Paste the contents to a paste site like '''''http://paste.kodi.tv/''''', and press the ''Save'' icon.
:#For very large logs, you may need to split the log into two or more pastes. Each paste can hold approx 15,000 lines or 2MB of log.
:#When the screen refreshes with your paste, '''copy the entire address in the address bar and paste it into a new message in your post'''.

:Logs are located in the following locations: <section end="CopyAndPaste" />

:{{LogfilePath}}
</div>

<div style="margin-left: 4em;">
== iOS Native Sharing ==
From Kodi v19, accessing the {{Kodi}} log file on your iOS device has become a whole lot simpler.
::'''''See: [[Log_file/iOS_native_sharing | iOS native sharing]]'''''
</div>

= Enable component-specific logging =
'''Only enable this if you have been specifically asked to enable it.'''

For more extensive logging, several system components can be selected to put in more detailed debug messages in Kodi's log file. Multiple components can be selected.

Enable the setting '''''Enable component-specific logging''''' in '''''[[Settings/System/Logging#Debug|Settings > System Settings > Logging]]'''''.

Select '''''Specify component-specific logging''''' and select the required components.

<gallery mode="packed" widths="600px" heights="384px">
File:Settings-System-Logging-01.jpg
File:Component-logging-selection.jpg
</gallery>

'''The following components are available, depending upon your hardware.'''
<section begin="ComponentValues" />
{| class="prettytable"
! scope="row" ! style="width:270px; | GUI name || ! scope="row" ! style="width:250px; | <setextraloglevel> code
|-
| The SMB library || style="text-align:center;" | 32
|-
| The libcURL library (HTTP(S), DAV) || style="text-align:center;" | 64
|-
| The FFmpeg libraries || style="text-align:center;" | 128
|-
| JSON-RPC requests || style="text-align:center;" | 1024
|-
| The Audio component || style="text-align:center;" | 2048
|-
| The Airtunes library || style="text-align:center;" | 4096
|-
| The UPnP components || style="text-align:center;" | 8192
|-
| The libCEC library || style="text-align:center;" | 16384
|-
| The Video component || style="text-align:center;" | 32768
|-
| The Webserver component || style="text-align:center;" | 65536
|-
| The Database component || style="text-align:center;" | 131072
|-
| audio/video timing information || style="text-align:center;" | 262144
|-
| Windowing component || style="text-align:center;" | 524288
|-
| PVR component || style="text-align:center;" | 1048576
|-
| EPG component || style="text-align:center;" | 2097152
|-
| Announce Logging || style="text-align:center;" | 4194304
|-
| WS-Discovery component || style="text-align:center;" | 8388608
|-
| Add-ons component<ref>https://github.com/xbmc/xbmc/pull/22162</ref> || style="text-align:center;" | 16777216
|}
<section end="ComponentValues" />

{{Top}}
{{updated|20}}

[[Category:Karellen]]
[[Category:Troubleshooting]]

Advancedsettings.xml

2025-05-25T19:42:37Z

Karellen: /* videolibrary */

{{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|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 version="1.0">
<setting>value</setting>
...
<setting>value</setting>
</advancedsettings>
</syntaxhighlight>

where "setting" gives the name of the setting, and "value" gives its value.

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

= List of available settings =
List of available settings that are recognised in the advancedsettings.xml file <ref>https://github.com/xbmc/xbmc/blob/master/xbmc/settings/AdvancedSettings.cpp</ref>

Recommended: Use the table of contents or the search function in your browser to locate items.

== Troubleshooting settings ==

=== loglevel ===
{{Anchor|.3Cloglevel.3E}}

<section begin="loglevel" />
Sets the logging level used to log errors and information. The "hide" attribute is optional.

<syntaxhighlight lang=xml>
<loglevel hide="attribute">options</loglevel>
</syntaxhighlight>

{| class="mw-collapsible mw-collapsed wikitable"
|-
! style="width:100px;" | Attribute
! style="width:500px;" | Action
|-
! '''true'''
| Hides the "enable debugging" setting in the Settings page. (default)
|-
! '''false'''
| Allows "enable debugging" setting to switch between '''0''' and '''2'''.
|}

{| class="mw-collapsible mw-collapsed wikitable"
|-
! style="width:100px;" | Option
! style="width:500px;" | Action
|-
! '''-1'''
| No logging, suppresses all log output
|-
! '''0'''
| Normal logging, only logging errors (default)
|-
! '''1'''
| Debug logging with freemem, fps and cpu usage (no on screen)
|-
! '''2'''
| Same as 1 (with on screen display)
|-
! '''3'''
| Same as 1 + full smb logging
|}

{| class="wikitable"
|-
! style="width:100px;" | Example
! style="width:500px;" |
|-
! Example 1:
|<syntaxhighlight lang=xml enclose="div">
<advancedsettings version="1.0">
<loglevel>2</loglevel>
</advancedsettings>
</syntaxhighlight>
|-
! Example 2:
|<syntaxhighlight lang=xml enclose="div">
<advancedsettings version="1.0">
<loglevel hide="true">2</loglevel>
</advancedsettings>
</syntaxhighlight>
|}

'''Note:''' The setting is persistent through shutdown and restarts.<br>
'''Note:''' If debugging is enabled in the GUI, loglevel will be set to '''2'''. This will over-ride the <code>advancedsettings.xml</code> setting. You must disable the GUI Setting before adding the entry to <code>advancedsettings.xml</code>.<br />
<section end="loglevel" />
:''{{see also|Log_file|label 1=Debug Log}}''

=== jsonrpc ===
{{Anchor|.3Cjsonrpc.3E}}
To make it easier for developers using the [[JSON-RPC_API]] 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>

== Audio/video playback settings ==

=== skiploopfilter ===
{{anchor|.3Cskiploopfilter.3E}}
The amount of the loop filter to skip on h.264 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
* 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}}

The <video> section also includes the following child-tags, which have their own sections:
*[[#cleandatetime]]
*[[#cleanstrings]]
*[[#excludefromscan]]
*[[#excludefromlisting]]
*[[#excludetvshowsfromscan]]

{{note|Some tags that have a "third-level" and are grouped together are highlighted in color.}}

{| class="prettytable"
! Tag !! Description
|-
|
<syntaxhighlight lang=xml>
<video>
</syntaxhighlight>
| Parent tag that all other child tags need to be placed inside of. Do not use more than one '''<code><video></code>''' tag, but instead place all other child-tags within a single '''<code><video></video></code>''' set.
|-
|
<syntaxhighlight lang=xml>
<subsdelayrange>10</subsdelayrange>
</syntaxhighlight>
| Delay range for subtitles, in seconds.
|-
|
<syntaxhighlight lang=xml>
<maxtempo>2.1</maxtempo>
</syntaxhighlight>
| Allow further increase of playback speed over the default of 1.5<br>
maxtempo must be in the range of 1.5 to 2.1 <br>
Be aware of the limitations of your platform / hardware as not all are capable of the increased maxtempo <ref>https://forum.kodi.tv/showthread.php?tid=10023&pid=2795069#pid2795069</ref>
|-
|
<syntaxhighlight lang=xml>
<audiodelayrange>10</audiodelayrange>
</syntaxhighlight>
| Delay range for audio/video sync, in seconds.
|-
|
<syntaxhighlight lang=xml>
<usetimeseeking>true</usetimeseeking>
</syntaxhighlight>
| Whether to use time based or percentage based seeking. {{small see also|Skip steps}}
|-
|
<syntaxhighlight lang=xml>
<timeseekforwardbig>600</timeseekforwardbig>
<timeseekbackwardbig>-600</timeseekbackwardbig>
</syntaxhighlight>
| Time to seek forward in seconds when doing a long seek. Defaults to 600 (10 minutes) and -600 (-10 minutes) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<percentseekforward>2</percentseekforward>
<percentseekbackward>-2</percentseekbackward>
</syntaxhighlight>
| Amount to seek forward as a percentage, when doing a short seek. Defaults to 2 (2%) and -2 (2%) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<percentseekforwardbig>10</percentseekforwardbig>
<percentseekbackwardbig>-10</percentseekbackwardbig>
</syntaxhighlight>
| Amount to seek forward as a percentage, when doing a long seek. Defaults to 10 (10%) and -10 (10%) respectively. ''{{small|See also: [[Skip steps]] }}''
|-
|
<syntaxhighlight lang=xml>
<fullscreenonmoviestart>true</fullscreenonmoviestart>
</syntaxhighlight>
| Whether to go to fullscreen or not when starting a movie. Defaults to true.
|-
|
<syntaxhighlight lang=xml>
<defaultplayer>VideoPlayer</defaultplayer>
</syntaxhighlight>
| Set the default video player: VideoPlayer or an external player. See '''[[External players]]''' for more info.
|-
|
<syntaxhighlight lang=xml>
<excludefromscan>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromscan>
</syntaxhighlight>
| Regular expressions that if evaluated to true won't be added to library. It is possible to add multiple <code><regexp></code> tags to match multiple patterns
|-
|
<syntaxhighlight lang=xml>
<excludefromlisting>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromlisting>
</syntaxhighlight>
| Regular expressions that if evaluated to true won't be displayed in files view.
|-
|
<syntaxhighlight lang=xml>
<playcountminimumpercent>90</playcountminimumpercent>
</syntaxhighlight>
| Minimum percentage that has to be played before it is marked as watched. Set to 101 to never auto-mark items as watched. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<ignoresecondsatstart>180</ignoresecondsatstart>
</syntaxhighlight>
| Number of seconds to ignore at video start after which a resume point is created. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<ignorepercentatend>8</ignorepercentatend>
</syntaxhighlight>
| Percentage of video to ignore at the end. If you stop watching the video here no resume point is created. Set to 101 to never save a resume point. The video is already marked as watched at 90%, see above. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang=xml>
<vdpauscaling>true</vdpauscaling>
</syntaxhighlight>
| Scales with vdpau instead of opengl and turns on its HQ scaler when available, enabling this might slow down rendering and cause framedrops especially on ION systems, this setting requires a vdpau feature set C GPU.
|-
|
<syntaxhighlight lang=xml>
<ppffmpegdeinterlacing>linblenddeint</ppffmpegdeinterlacing>
</syntaxhighlight>
| Override the deinterlacing options passed to libpostproc.
|-
|
<syntaxhighlight lang=xml>
<ppffmpegpostprocessing>ha:128:7,va,dr</ppffmpegpostprocessing>
</syntaxhighlight>
| Override the post processing options passed to libpostproc when 'Video post-processing' is activated in GUI Videos-Settings-Playback.
|-
|
<syntaxhighlight lang=xml>
<autoscalemaxfps>30</autoscalemaxfps>
</syntaxhighlight>
| When scaling method is set to auto, bilinear is chosen when the fps is higher than this limit, the default is 30.
|-
|
<syntaxhighlight lang=xml>
<adjustrefreshrate>
</syntaxhighlight>
| style="background:#CADCFB;" | Settings for when "Adjust refreshrate to match video fps" is enabled in the video playback GUI settings.
|-
|
<syntaxhighlight lang=xml>
<override>
<fps>23.976</fps>
<refresh>60.0</refresh>
</override>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' "Adjust refreshrate to match video fps" will try to select the best refreshrate for the video fps but it doesn't always get it right, for example it might switch to an unsupported refreshrate. You can add overrides here to switch to a certain refreshrate based on video fps. It's possible to add as many overrides as you need. Overrides are processed in order, if the first one doesn't match the fps or no refreshrates match that override, it will try the next one until no overrides are left.

* '''fps''' - if the fps is between 23.966 and 23.986
* '''refresh''' - switch to the first found refreshrate that is between 59.99 and 60.01
|-
|
<syntaxhighlight lang=xml>
<override>
<fpsmin>29.96</fpsmin>
<fpsmax>30.01</fpsmax>
<refreshmin>59.0</refreshmin>
<refreshmax>61.0</refreshmax>
</override>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -'''
* '''fpsmin''' / '''fpsmin''' - You can also specify the fps range yourself.
* '''refreshmin''' / '''refreshmax''' - Same for the refreshrate
|-
|
<syntaxhighlight lang=xml>
<fallback>
<refresh>50.0</refresh>
</fallback>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' If none of the overrides match, or none of the refreshrates match any of the fps matching overrides, it will choose a fallback refreshrate. Fallbacks are process in order, if the first fallback doesn't match any refreshrate, it will try the next one until no fallbacks are left.

* '''refresh''' - Switch to the first found refreshrate that is between 49.99 and 50.01.
|-
|
<syntaxhighlight lang=xml>
<fallback>
<refreshmin>49.0</refreshmin>
<refreshmax>51.0</refreshmax>
</fallback>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' You can also specify the range for the fallback yourself.

If none of the overrides match the video fps, or no refreshrates match any of the fps matching overrides, and no fallbacks are specified or no refreshrates match any fallbacks, it will automatically choose the best refreshrate (same as having no overrides and fallbacks).
|-
|
<syntaxhighlight lang=xml>
</adjustrefreshrate>
</syntaxhighlight>
| style="background:#CADCFB;" |
|-
|
<syntaxhighlight lang=xml>
<checkdxvacompatibility>value</checkdxvacompatibility>
</syntaxhighlight>
| Advanced setting not present: let Kodi autodetect cards that support H.264 profile > L4.1. Set value to false to enable DXVA no matter what. Set value to true if Kodi doesn't autodetect that the graphics card doesn't support > L4.1.
|-
|
<syntaxhighlight lang=xml>
<useocclusionquery>-1</useocclusionquery>
</syntaxhighlight>
| Use an occlusion query when capturing videoframes, -1 means auto detect, 0 means disabled, 1 means enabled, the default is -1.
|-
|
<syntaxhighlight lang=xml>
<fpsdetect>1</fpsdetect>
</syntaxhighlight>
| FPS detection for video playback
* 0 = trust codec fps
* 1 = recalculate from video timestamps with uniform spacing
* 2 = recalculate from video timestamps always
|-
|
<syntaxhighlight lang=xml>
<latency>
<delay>0</delay>
<hdrextradelay>0</hdrextradelay>
<refresh>
<min></min>
<max></max>
<rate></rate>
<delay></delay>
<hdrextradelay></hdrextradelay>
</refresh>
</latency>
</syntaxhighlight>
| '''Latency''' helps correct audio/video synchronization (lip-sync) when the display's internal processing introduces noticeable delays in the display of the pictures. The optional overrides and hdr extra delay offer further fine-tuning when the delay is not the same for all refresh rates or the HDR vs SDR modes. Latency is given in milliseconds. For one-off adjustments use the OSD during playback to adjust audio synchronisation.<br/><br/>
'''<delay>''' - Global default display latency.<br>
'''<hdrextradelay>''' - Global default latency added to the global default display latency when the display is in any HDR mode. Note: the display HDR mode is not detected on all platforms (Windows-only at time of writing).<br>
'''<refresh>''' - Override latency for given display (not video) refresh rates. When Kodi is in windowed mode, override is ignored. Multiple overrides are allowed.<br>
'''<min>''', '''<max>''' - refresh rate range, OR<br>
'''<rate>''' - exact refresh rate<br>
'''<delay>''' - display latency for the given refresh rate<br>
'''<hdrextradelay>''' - additional latency when the display is in any HDR mode for the given refresh rate<br>
<br/>
'''Example:''' The following example sets display latency of 125 msec at 23-24 Hz
<syntaxhighlight lang=xml>
<refresh>
<min>23</min>
<max>24</max>
<delay>125</delay>
</refresh>
</syntaxhighlight>
<br/>
'''Example:''' The following example sets display latency of 50 msec at 50 (+/-0.01) Hz
<syntaxhighlight lang=xml>
<refresh>
<rate>50</rate>
<delay>50</delay>
</refresh>
</syntaxhighlight>

|-
|
<syntaxhighlight lang=xml>
<stereoscopicregex3d>[-. _]3d[-. _]</stereoscopicregex3d>
<stereoscopicregexsbs>[-. _]h?sbs[-. _]</stereoscopicregexsbs>
<stereoscopicregextab>[-. _]h?tab[-. _]</stereoscopicregextab>
</syntaxhighlight>
| Filename triggers for 3D (stereoscopic) mode.
|-
|
<syntaxhighlight lang=xml>
<assfixedworks>false</assfixedworks>
</syntaxhighlight>
| Position behavior of ass subtitiles when setting "subtitle position on screen" set to "fixed". True to show at the fixed position set in video calibration. False to show at the bottom of video (default). {{note|Removed in Kodi v20.}}
|-
|
<syntaxhighlight lang=xml>
<subtitleverticalmargin>120</subtitleverticalmargin>
</syntaxhighlight>
| Allows to customise the vertical margin of text based subtitles, which will be applied to each type of subtitle position in subtitle settings. {{note|Available in Kodi v20 and above.}}
|-
|
<syntaxhighlight lang=xml>
</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>

<usetimeseeking>true</usetimeseeking>

<timeseekforwardbig>600</timeseekfowardbig>

<timeseekbackwardbig>-600</timeseekbackward>

<playcountminimumpercent>99</playcountminimumpercent>

<applydrc>-1.0</applydrc>

<limiterhold>0.025</limiterhold>

<limiterrelease>0.1</limiterrelease>

<maxpassthroughoffsyncduration>10</maxpassthroughoffsyncduration>

<allowmultichannelfloat>false</allowmultichannelfloat>

<superviseaudiodelay>false</superviseaudiodelay>
</audio>
</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

=== edl ===
{{anchor|.3Cedl.3E}}
{{main|Edit_decision_list}}
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>


<displaycommbreaknotifications>false</displaycommbreaknotifications>
</edl>
</syntaxhighlight>
'''Notes:'''
* displaycommbreaknotifications<ref>https://github.com/xbmc/xbmc/pull/20711</ref>

== PVR & Live TV ==
{{anchor|.3Cpvr.3E}}
Settings available for PVR, EPG and Live TV. Edit Decision List settings are located in the previous section.

=== pvr ===
<syntaxhighlight lang="xml" line='line'>
<pvr>
<timecorrection>0</timecorrection> 
<infotoggleinterval>3000</infotoggleinterval> 
<channeliconsautoscan>true</channeliconsautoscan> 
<autoscaniconsuserset>false</autoscaniconsuserset> 
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> 
</pvr>
</syntaxhighlight>

==== pvrrecordings ====
In v19 and later, allows users to modify sort type and order of pvr recordings. <ref>https://github.com/xbmc/xbmc/pull/18605</ref>

;Note- These settings are child tags to the ''<pvr>'' tag in the previous section.

<syntaxhighlight lang="xml" line='line'>
<pvr>
<pvrrecordings>
<sortmethod>2</sortmethod> 
<sortorder>2</sortorder> 
</pvrrecordings>
</pvr>
</syntaxhighlight>

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

== 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 .3g2 .3gp .nsv .tp .ts .ty .strm .pls .rm .rmvb .mpd .m3u .m3u8 .ifo .mov .qt .divx .xvid
.bivx .vob .nrg .img .iso .udf .pva .wmv .asf .asx .ogm .m2v .avi .bin .dat .mpg .mpeg .mp4
.mkv .mk3d .avc .vp3 .svq3 .nuv .viv .dv .fli .flv .001 .wpl .xspf .zip .vdr .dvr-ms .xsp .mts
.m2t .m2ts .evo .ogv .sdp .avs .rec .url .pxml .vc1 .h264 .rcv .rss .mpls .mpl .webm .bdmv
.bdm .wtv .trp .f4v
</pre>
Examples:
<pre>
<videoextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</videoextensions>
</pre>
<section end="videoextensions" />

=== discstubextensions ===
{{main|Media stubs}}

<section begin="discstubextensions" />
The default filename extension for Disc Stubs is:
<syntaxhighlight lang=xml enclose="div">
.disc
</syntaxhighlight>
Using the following tags, it is possible to <tt><add></tt> additional or <tt><remove></tt> existing disc stub extensions to better suit your requirements.
<syntaxhighlight lang=xml enclose="div">
<discstubextensions>
<add>.disk|.stub</add>
<remove>.disc</remove>
</discstubextensions>
</syntaxhighlight>
<section end="discstubextensions" />

=== languagecodes ===
{{anchor|.3Clanguagecodes.3E}}
User-defined translation table for language codes used in subtitles and audio.
It can be used to add, extend or override Kodi's language codes.

'''How to add a new language code:'''

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

'''How to add a new language code with subtag (e.g. pt-BR):'''
{{note|This support is available from Kodi v20}}

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>pt-BR</short>
<long>Portuguese - Brazil</long>
</code>
</languagecodes>
</syntaxhighlight>

''NOTE FOR MKV FILES:''<br/>
MKV files that contain audio/subtitle tracks with language codes with subtags are not yet supported, but from <code>Kodi v21</code> a workaround was introduced that allows Kodi to recognize language codes with subtags.
To use the workaround, you must open the MKV file with an editor and in the metadata of the desired audio/subtitle track, edit the track Name (or Title field) by adding the language code wrapped in curly brackets, as in following example:
<br/><code>Original track name: Audio portuguese/brazil</code>
<br/><code>Modified track name: Audio portuguese/brazil {pt-BR}</code>

'''How to extend an existing language code:'''

Set the same "long" description of the existing language, for example we reuse the Portughese language for another language code:

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>pt-BR</short>
<long>Portuguese</long>
</code>
</languagecodes>
</syntaxhighlight>

In this case when in Kodi settings you set the "Portuguese" language, when in playing according to availability the track "pt" or "pt-BR" will be chosen.

'''How to override an existing language code:'''

This allow you to rename an existing language. Set to an existing language code your preferred "long" name description.

''WARNING: This can cause problems with add-ons, so do not override languages if you are not aware of the side effects.''

<syntaxhighlight lang=xml enclose="div">
<languagecodes>
<code>
<short>en</short>
<long>English example</long>
</code>
<code>
<short>en-GB</short>
<long>English example</long>
</code>
</languagecodes>
</syntaxhighlight>

=== moviestacking ===
{{anchor|.3Cmoviestacking.3E}}<section begin="moviestacking" />
{{main|Naming_video_files/Movies}}
This is used by the [[Naming_video_files/Movies#Split_Video_Files|file stacking]] algorithm to combine multi-part files and contains a list of 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|Naming_video_files/Movies}}
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

Default expression:
<syntaxhighlight lang=xml enclose="div">
<video>
<cleandatetime>(.*[^ _\,\.\[\]\-])[ _\.\[\]\-]+(19[0-9][0-9]|20[0-9][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 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.

{{Github_link|[https://github.com/xbmc/xbmc/blob/Nexus/xbmc/settings/AdvancedSettings.cpp#L201-L211 Code in Github]}}

Default expressions:
<syntaxhighlight lang=xml enclose="div">
<video>
<cleanstrings>
<regexp>([ _\\,\\.\$\$\\[\\]\\-](10bit|480p|480i|576p|576i|720p|720i|1080p|1080i|2160p|3d|aac|ac3|aka|atmos|avi|bd5|bdrip|bluray|brrip|cam|cd[1-9]|custom|dc|ddp|divx|divx5|dolbydigital|dolbyvision|dsr|dsrip|dts|dts-hdma|dts-hra|dts-x|dv|dvd|dvd5|dvd9|dvdivx|dvdrip|dvdscr|dvdscreener|extended|fragment|fs|h264|h265|hdr|hdr10|hevc|hddvd|hdrip|hdtv|hdtvrip|hrhd|hrhdtv|internal|limited|multisubs|nfofix|ntsc|ogg|ogm|pal|pdtv|proper|r3|r5|read.nfo|remastered|remux|repack|rerip|retail|screener|se|svcd|tc|telecine|telesync|truehd|ts|uhd|unrated|ws|x264|x265|xvid|xvidvd|xxx|web-dl|webrip|www.www|\\[.*\\])([ _\\,\\.\$\$\\[\\]\\-]|$)");</regexp>
<regexp>(\[.*\])</regexp>
</cleanstrings>
</video>
</syntaxhighlight>
Updated in v20<ref>https://github.com/xbmc/xbmc/pull/20549</ref>

:* 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 Expressions

{{Github_link|[https://github.com/xbmc/xbmc/blob/Matrix/xbmc/settings/AdvancedSettings.cpp#L232 Code in Github]}}

Defaults:
<syntaxhighlight lang=xml enclose="div">
<tvshowmatching>
<regexp>s([0-9]+)[ ._x-]*e([0-9]+(?:(?:[a-i]|\\.[1-9])(?![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.
:* 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 [https://forum.kodi.tv/showthread.php?tid=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 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 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 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 syntax to match the locally stored trailers to movies in the library. Only files with recognized video file extensions will be considered, and the extensions are removed for the Regular Expression evaluation.

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

<regexp>(.*?)(_Trailer)$</regexp>
</trailermatching>
</syntaxhighlight>

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

{{Note|Kodi v20 users don't need set "importwatched" or "importresumepoint" to true anymore as that's the default then <ref>https://github.com/xbmc/xbmc/pull/20842</ref>}}

<syntaxhighlight lang="xml" line='line'>
<videolibrary>
<allitemsonbottom>false</allitemsonbottom> 
<cleanonupdate>false</cleanonupdate> 
<usefasthash>true</usefasthash> 
<recentlyaddeditems>35</recentlyaddeditems> 
<itemseparator> / </itemseparator> 
<exportautothumbs>true</exportautothumbs> 
<importwatchedstate>true</importwatchedstate> 
<importresumepoint>true</importresumepoint> 
<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>

== Library artwork ==

{{note|Using <imageres>9999</imageres> and <fanartres>9999</fanartres> will allow caching artwork at original size.}}

=== imageres ===
{{anchor|.3Cimageres.3E}}

<section begin="imageres description" />Specify the maximum resolution that [[Artwork/Cache#Texture optimization| cached artwork]] (other than fanart / 16:9 images) 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}}

<section begin="fanartres description" />Specify the maximum resolution that [[Artwork/Cache#Texture optimization| 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>

=== imagescalingalgorithm ===
Specify the image scaling algorithm for image resizing when [[Artwork/Cache#Texture optimization| caching artwork]] to the local texture cache.
<br />
<syntaxhighlight lang=xml enclose="div">
<imagescalingalgorithm>bicubic</imagescalingalgorithm>
</syntaxhighlight>

[https://github.com/xbmc/xbmc/blob/master/xbmc/pictures/PictureScalingAlgorithm.cpp#L20-L32 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>

=== imagequalityjpeg ===
This specifies the quality of the images when stored in jpeg format. By default kodi uses a quality of 4 which is a good compromise between size and quality. If you want to reduce the thumbnail sizes (decreasing quality) choose a higher value up to 21. If high quality (large thumbnail size) is needed, chose a smaller value, e.g. 0,1,2 or 3. (Added in v20 <ref>https://github.com/xbmc/xbmc/pull/21418</ref>)
<br />
<syntaxhighlight lang=xml enclose="div">
<imagequalityjpeg>4</imagequalityjpeg>
</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>

=== sorttokens ===
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>

In the above example "the ", "the." and "the_" will be ignored at the start of titles or names when sorting items, in both video and music libraries. A separator can also be specified, for example
<syntaxhighlight lang=xml enclose="div">
<sorttokens>
<token separators="'">L</token>
</sorttokens>
</syntaxhighlight>
In that case the value L', as in French movie name ''L'argent'', will be ignored and the item listed under "A".

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

:{{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.'''}}

'''Parent tags:'''

* '''<videodatabase>'''
* '''<musicdatabase>'''
* '''<tvdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''
* '''<epgdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''
{{MySQL warning}}

'''Child tags: '''

;<type>
: ''Required'' - Can be either "sqlite3" or "mysql" (default: sqlite3)

;<host>
:''Required'' -
* 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>
: ''Optional'' -
* sqlite3: silently ignored
* mysql: defines the port of the mysql socket (default: 3306)

;<name>
: ''Optional'' -
: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>
: ''Required for MySQL'' -
* sqlite3: silently ignored
* mysql: defines the user with privileged access to the database

;<pass>
: ''Required for MySQL'' -
* sqlite3: silently ignored
* mysql: defines the password for the user with privileged access to the database

;<connecttimeout> [https://github.com/xbmc/xbmc/pull/26657]
: ''Optional'' -
* sqlite3: silently ignored
* mysql: defines a connect timeout, in seconds. Default value is 5 seconds.

;<compression>
: ''Optional'' - 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}}

;<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]

'''Examples:'''

1) Configure a database for MySQL.
:{{note| ''The '''<videodatabase>''', '''<musicdatabase>''', '''<tvdatabase>''', and '''<epgdatabase>''' 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>
<connecttimeout>3</connecttimeout>
</videodatabase>
</syntaxhighlight>

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

<section end="videodatabase" />

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

== Music settings ==

=== musicextensions ===
{{anchor|.3Cmusicextensions.3E}}
<section begin="musicextensions" />
Default extensions for MUSIC:
<pre>
.nsv .m4a .flac .aac .strm .pls .rm .rma .mpa .wav .wma .ogg .mp3 .mp2 .m3u .gdm .imf .m15 .sfx
.uni .ac3 .dts .cue .aif .aiff .wpl .xspf .ape .mac .mpc .mp+ .mpp .shn .zip .wv .dsp .xsp .xwav
.waa .wvs .wam .gcm .idsp .mpdsp .mss .spt .rsd .sap .cmc .cmr .dmc .mpt .mpd .rmt .tmc .tm8
.tm2 .oga .url .pxml .tta .rss .wtv .mka .tak .opus .dff .dsf .m4b .dtshd
</pre>

It is possible to add or remove extensions for Music, using the following XML tags. Useful if you keep, say, FLAC and mp3 versions of music in the same folder. The <remove> tag can be used to remove mp3 from being listed in the library, leaving only the higher quality FLAC being displayed.

<musicextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</musicextensions>

<section end="musicextensions" />

=== 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 ===
Options specific to the Music Library
<section begin="MusicLibrary" />
<syntaxhighlight lang="xml" line='line'>
<musiclibrary>
<recentlyaddeditems>35</recentlyaddeditems> 

<prioritiseapetags>true</prioritiseapetags> 

<allitemsonbottom>true</allitemsonbottom> 

<cleanonupdate>false</cleanonupdate> 

<artistsortonupdate>false</artistsortonupdate> 

<albumformat>%B - %Y</albumformat> 

<itemseparator> / </itemseparator> 

<dateadded>1</dateadded> 

<artistseparators> 
<separator>;</separator>
<separator>:</separator>
<separator>|</separator>
<separator> feat. </separator>
<separator> ft. </separator>
</artistseparators>


<useisodates>false</useisodates> 


<artistnavigatestosongs>true</artistnavigatestosongs> 
</musiclibrary>
</syntaxhighlight>
{{Note|Changing the <itemseparator> or <artistseparators> will only affect newly added items. A rescan won't change the existing ones. Remove the Source(s) or delete the Music DB and rebuild. This process should be made easier from v18 and up using <promptfulltagscan>. <artistseparators> are cAsE sensitive and only used if you are not using MBID's. Separators will be used alongside MBID's from v22 onwards.}}<section end="MusicLibrary" />

== 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 .rss .webp .jp2 .apng
</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 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 ==

=== ftp ===
{{anchor|.3Cftp.3DE}}
Specific settings if a ftp server is in use as a source

<syntaxhighlight lang=xml enclose="div">
<ftp>
<remotethumbs>true</remotethumbs> 
</ftp>
</syntaxhighlight>

=== 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}}

<syntaxhighlight lang=xml line='line'>
<network>
<curlclienttimeout>10</curlclienttimeout> 
<curllowspeedtime>20</curllowspeedtime> 
<curlretries>2</curlretries> 
<httpproxyusername></httpproxyusername> 
<httpproxypassword></httpproxypassword> 
<disableipv6>false</disableipv6> 
<disablehttp2>false</disablehttp2> 
<nfstimeout>30</nfstimeout> 
<catrustfile>filepath</catrustfile> 
<curlkeepaliveinterval>30</curlkeepaliveinterval> 
<nfsretries>0</nfsretries> 
</network>
</syntaxhighlight>

'''More information:'''<br>
* <curlkeepaliveinterval><ref>https://github.com/xbmc/xbmc/pull/19319</ref><br>
* <nfsretries><ref>https://github.com/xbmc/xbmc/pull/19513</ref>

=== 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-ons|add-on]] rollback feature. Increasing the size should increase the amount of past versions saved. Defaults to 200 MB.
| example = Example: <syntaxhighlight lang=xml enclose="div"><packagefoldersize>200</packagefoldersize> </syntaxhighlight>
}}
<section end="packagefoldersize" />

=== detectasudf ===
{{anchor|.3Cdetectasudf.3E}}
{{xml setting
| tag name = detectasudf
| option type = binary
| option values = true, false
| default values = false
| platform = all
| XBMC version =
| description = Set to true if you wish to detect joint ISO9660/UDF disks as UDF.
| example = Example: <syntaxhighlight lang=xml enclose="div"><detectasudf>false</detectasudf></syntaxhighlight>
}}

=== handlemounting ===
{{anchor|.3Chandlemounting.3E}}
{{xml setting
| tag name = handlemounting
| option type = binary
| option values = true, false
| default values = false
| platform = Linux
| XBMC version =
| description = Only used in Linux, it defines if Kodi should attempt to mount media drives (via udisks or udisks2).<br/>Default: False. If kodi is executed with the --standalone option (e.g. as done by kodi-standalone.sh) it by default will be True.
| example = Example: <syntaxhighlight lang=xml enclose="div"><handlemounting>false</handlemounting></syntaxhighlight>
}}

=== automountopticalmedia ===
{{xml setting
| tag name = automountopticalmedia
| option type = binary
| option values = true, false
| default values = false
| platform = Linux
| XBMC version =
| description = Only used in linux for the udisks and udisks2 providers<br/>defines if kodi should automount optical discs<ref>https://github.com/xbmc/xbmc/pull/20840</ref>
| example = Example: <syntaxhighlight lang=xml enclose="div"><automountopticalmedia>true</automountopticalmedia></syntaxhighlight>
}}

=== pathsubstitution ===
{{anchor|.3Cpathsubstitution.3E}}
{{main|Path substitution}}

{{divbox|red||'''Note:''' Path substition for "sources" and profiles is broken, and will '''NOT''' be fixed.}}

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>

=== controllerdeadzone ===
{{anchor|.3Ccontrollerdeadzone.3E}}
This advanced settings has been removed.
Since v17, the [[Advancedsettings.xml#controllerdeadzone|<controllerdeadzone>]] advanced setting has been removed. Deadzones can now be configured by plugging in the controller and selecting it in Settings -> System settings -> Input -> Peripherals.

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

=== touchscreen ===
{{anchor|.3Ctouchscreen.3E}}
This setting allows you to move/align the origin of the touch screen with the origin of the display used. If touch input does not result in a correct movement of the mouse pointer, the behaviour can be corrected with an offset and a stretch/compress factor.

Example:
<syntaxhighlight lang=xml enclose="div">
<touchscreen>
<x_offset>0</x_offset> 
<y_offset>0</y_offset> 
<x_stretch_factor>1.0</x_stretch_factor> 
<y_stretch_factor>1.0</y_stretch_factor> 
</touchscreen>
</syntaxhighlight>

=== scanirserver ===
Introduced in v18 and used in MS Windows setups only.<ref>https://github.com/xbmc/xbmc/pull/13896</ref>
Used to disable the regular connection attempts to the IR Server Suite when there is no remote to connect to.

The default setting is to allow connection attempts. To disable connection attempts change value to '''false'''.
<syntaxhighlight lang=xml enclose="div">
<scanirserver>true</scanirserver>
</syntaxhighlight>

== GUI rendering settings ==

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

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

=== smartredraw ===

{{note|This is an experimental feature and you might face issues using it. So please be aware of that.}}

This new feature was introduced in Kodi 18 and if enabled, the GUI process call (and therefore the render call) is only done if anything has changed. The result will be a faster GUI and less load if Kodi plays a video

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

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

=== anisotropicfiltering ===

This new feature was introduced for the GL/GLES rendering backends in Kodi 22. It allows for better (hardware specific) filtering of textures at glancing angles. Depending on the hardware it might have no effect, or there might be a performance degradation. Typical values are "2" or "3", but might go as high as "16", depending on the hardware. The default is "1" (disabled).

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<anisotropicfiltering>2</anisotropicfiltering>
</gui>
</syntaxhighlight>

=== fronttobackrendering ===

This experimental feature was introduced for the GL/GLES rendering backends in Kodi 22. It enables a form of occlusion culling, by rendering opaque object from front to back. Most GPUs should benefit from this setting (especially on ARM based systems), often resulting in higher frame rates or less memory bandwidth usage.

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

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

=== geometryclear ===

This experimental setting was introduced for the GL/GLES rendering backends in Kodi 22. It disables geometry based screen clearing in favor of fixed function clearing. Depending on the GPU (most ARM systems, Intel >gen 12), disabling the setting might be preferable for increased performance.

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

Example:
<syntaxhighlight lang=xml enclose="div">
<gui>
<geometryclear>false</geometryclear>
</gui>
</syntaxhighlight>

== Other interface settings ==

=== window ===
{{anchor|.3Cwindow.3E}}
{{note|This is a "hidden" guisettings.xml setting (defined by the mouse moving the window size), but it is mentioned here because it is a particularly useful override when used in advancedsettings.xml}}
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>

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

=== showexitbutton ===
{{anchor|.3Cshowexitbutton.3E}}
Setting to hide the exit button, useful for people running appliance based setups 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>

There is also a fake fullscreen GUI option in Kodi's settings.

=== minimizetotray ===
{{anchor|.3Cminimizetotray.3E}}
{{note|Available in Kodi v20 and above.}}

Windows only. Minimizes Kodi to the system tray. Defaults to false.
<syntaxhighlight lang=xml enclose="div">
<minimizetotray>true</minimizetotray>
</syntaxhighlight>

= Removed tags =
{{anchor|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_IDs]] 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.
* {{anchor|.3Ckaraoke.3E}}'''<karaoke>''' - In v16 all of the karaoke features in Kodi were removed.
* '''<useddsfanart>''' - removed in v17 Krypton.
* '''<cachemembuffersize>''' and '''<readbufferfactor>''' - In v17 '''<cachemembuffersize>''' is renamed to '''<memorysize>''' and <code><readbufferfactor></code> is renamed to <code><readfactor></code>. In addition, all three buffer related settings in <network> are moved out of <network> and into a new <cache> parent tag.
* '''<minvideocachelevel>''', '''<minaudiocachelevel>''', and '''<cacheindvdplayer>''' have been removed in v17.
* '''<useffmpegvda>''' - Tag was only used for development testing. Removed in v17.
* '''<nofliptimeout>''' - Removed in v17
* '''<blackbarcolour>''' - Removed in v17 (maybe?)
* '''<disableswmultithreading>''' - Removed in v17 (maybe?)
* '''<controllerdeadzone>''' - Removed in v17
* {{anchor|.3Cmeasurerefreshrate.3E}}'''<measurerefreshrate>''' - Removed in v17 or v18?
* {{anchor|.3Cmyth.3E}}'''<myth>''' - Removed sometime between v16 to v18
* {{anchor|.3Ctuxbox.3E}}'''<tuxbox>''' - Removed
* '''<backgroundupdate>''' - Removed
* '''<hideemptyseries>''' - Replaced by a GUI option.
* '''<mymovies>''' and child tag '''<categoriestogenres>''' - Removed
* '''<albumssortbyartistthenyear'''> - Removed
* '''<albumformatright>''' - Removed
* {{anchor|.3Cremoterepeat.3E}}'''<remoterepeat>''' - Removed
* {{anchor|.3Callowd3d9ex.3E}}'''<allowd3d9ex>''' and {{anchor|.3Cforced3d9ex.3E}}'''<forced3d9ex>''' - Removed sometime between v16 to v18
* '''<lingertime>''' - Replaced by a GUI setting in v18
* '''<forcevaapienabled>''' - Removed in v18
* '''<dxvaallowhqscaling>''' - Removed in v18 <ref>https://github.com/xbmc/xbmc/pull/15466</ref>
* '''<promptfulltagscan>false</promptfulltagscan>''' Removed in v18. Now automatically asked each time a scan is conducted.
* '''<omxdecodestartwithvalidframe>''' - This tag is only in some Raspberry Pi specific distributions, such as OpenELEC. As of March 2015, this tag has not been merged into "vanilla" Kodi builds
* '''<musicthumbs>''' Replaced in v19 by the GUI setting '''Thumbnail image files''' found in Media -> Music
* '''<artistextraart>''' Replaced in v19 by the GUI setting '''Artist art types whitelist''' found in Media -> Music <ref>https://github.com/xbmc/xbmc/pull/22748</ref>
* '''<albumextraart>''' Replaced in v19 by the GUI setting '''Album art types whitelist''' found in Media -> Music
* '''<episodeextraart>''' Replaced in v19 by the GUI setting '''Episode art types whitelist''' found in Media -> Videos
* '''<tvshowextraart>''' Replaced in v19 by the GUI setting '''TV show art types whitelist''' found in Media -> Videos
* '''<tvseasonextraart>''' Replaced in v19 by the GUI setting '''TV show art types whitelist''' found in Media -> Videos
* '''<movieextraart>''' Replaced in v19 by the GUI setting '''Movie art types whitelist''' found in Media -> Videos
* '''<moviesetextraart>''' Replaced in v19 by the GUI setting '''Movie art types whitelist''' found in Media -> Videos
* '''<musicvideoextraart>''' Replaced in v19 by the GUI setting '''Music video art types whitelist''' found in Media -> Videos
* '''<fanart>''' Removed in v19
* '''<assfixedworks>''' Removed in v20
* '''<try10bitoutput>''' Removed in v20 and replaced with [[Settings/System/Display#Use_10_bit_for_SDR|Use 10 bit for SDR]] setting <ref>https://github.com/xbmc/xbmc/pull/20014</ref>
* '''<enablehighqualityhwscalers>''' Removed in v20 <ref>https://github.com/xbmc/xbmc/pull/21537</ref>
* '''<cache> / <memorysize> / <buffermode> / <readfactor> / <chunksize>''' - Removed in v21 and added to GUI settings page

= guisettings.xml Setting Conversion =
It is possible to convert settings found in the '''[[Settings]]''' ''(guisettings.xml)'' pages of {{kodi}} into entries for the advancedsettings.xml file.

When a setting from the guisettings.xml is added to the advancedsettings.xml file, it will override the existing guisettings.xml values and the setting will be removed from the settings pages.

Why would I need to do this?
* You set up multiple devices and then need to individually change settings and preferences on each device. Using this conversion method, you save those settings in the advancedsettings.xml file and simply add the file to each device
* You need to hide settings to prevent those settings from being modified

To convert a guisetting to advancedsettings.xml follow these steps:
# In the {{kodi}} settings pages, adjust the setting(s) to your preference.
# Back out of the settings pages to the main menu, which forces {{kodi}} to save the adjusted settings to the guisettings.xml file
# Locate the guisettings.xml file in the [[Userdata]] folder and open it
# Locate the setting(s) to be converted. The list can be overwhelming so make use of the Search feature of whichever editor you are using
# Using the following setting as an example:
<syntaxhighlight lang="xml">
<setting id="videolibrary.showemptytvshows">true</setting>
</syntaxhighlight>
: Breaking down the string:
::'''videolibrary'''- parent tag
::'''showemptytvshows'''- child tag
::'''true'''- value
: The conversion is as follows and place this in the advancedsettings.xml file
<syntaxhighlight lang="xml">
<advancedsettings version="1.0">
<videolibrary>
<showemptytvshows>true</showemptytvshows>
</videolibrary>
</advancedsettings>
</syntaxhighlight>

'''Note:''' Some parent tags may already be in use in your advancedsettings.xml file. Do not duplicate them, but add the child tag beneath the existing parent tag.

= References =
<references />

{{Updated|18}}
{{DISPLAYTITLE:advancedsettings.xml}}

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

Adding video sources

2025-05-20T01:17:50Z

Karellen:

{{VideoLibraryCreate}}
{{mininav| [[Video library]] |[[HOW-TO:Create_Video_Library|Create Video Library]] }}

= Introduction =
{{warning|For media files that are stored on network sources: [[UPnP]] cannot be used to create a library. It is recommended that you share your media using another protocol such as [[SMB]].}}

This step of the guide will enable you to complete the following actions:
#'''Add Sources''' - Add the Source folder to {{Kodi}}
#'''Set Content''' - Advise {{kodi}} what type of media is in the Source
#'''Scraper Settings''' - Adjust the scraper settings to your preferences, or change to a different scraper
#'''Add to Library''' - Scrape the media into the library

{{note|Each section is a direct continuation of the previous section, and only separated for clarity.}}

= Adding Sources =
<gallery mode="packed" widths="500px" heights="283px">
File:Quick-start-1.png|'''{{big|Step 1}}:''' Select '''VIDEOS''' in the home screen menu. <br />(Or select ''Enter files section'' if that button is visible)
File:Quick-start-2.png|'''{{big|Step 2}}:''' Select '''FILES'''
File:Quick-start-2.1.png|'''{{big|Step 3}}:''' Select '''ADD VIDEOS...'''.<br />
File:Quick-start-3.png|'''{{big|Step 4}}:''' Select the '''BROWSE'''
File:Quick-start-4.png|'''{{big|Step 5}}:''' Browse to locate your Source folder. Enter the Source folder so you see your titles. Select '''OK'''
File:Quick-start-5.png|'''{{big|Step 6}}:''' Either use the default name or rename the Source. The name doesn't matter to Kodi, but keep the names unique for ease of maintenance.<br>Then select '''OK'''.
</gallery>

= Set Content =
<gallery mode="packed" widths="600px" heights="337px">
File:Quick-start-6a.jpg|'''{{big|Step 7}}:''' The set content window will display. This is where the media type is set. <br>Select the option '''This directory contains'''.
File:Quick-start-6.1.png|'''{{big|Step 8}}:''' Select the type of media that is in the Source.
</gallery>

{|
! style="width: 45%;" | {{resize|1.4em|Set Content for Movies}}
! style="width: 10%;" |
! style="width: 45%;" | {{resize|1.4em|Set Content for TV Shows}}
|-
| style="width: 45%; text-align:center;" | [[File:Set-content-Movies.jpg|600px]]<br>'''{{big|Step 9a}}''': Select '''OK''' when done
| style="width: 10%;" |
| style="width: 45%; text-align:center;" | [[File:Set-content-TV-Shows.jpg|600px]]<br>'''{{big|Step 9b}}''': Select '''OK''' when done
|-
| || ||
|-
| style="width: 40%;" |
;Choose information provider
:Select this setting to change the scraper that this Source uses<br>
:{{note|If your preferred scraper is not listed, use the '''Get more...''' button.}}

;Settings
:Adjust the scraper settings, '''for this Source only'''.
:{{note|Default movie scraper settings are explained in the wiki page for each scraper.}}

;Movies are in separate folders that match the movie title
:If your movies are in Movie folders, '''Enable''' this setting
:*If '''Enabled''' {{Kodi}} will use the '''folder''' name to scrape the movie
::*Kodi will [[NFO files/Movies#nfo Placement| load NFO files]] from NFO files named '''movie.nfo''', but will fallback to ''<videofilename>.nfo'' as required
::*Kodi will load artwork files using the short format ''<artworktype>.jpg/png'' filenames, but will fallback to the longer ''<NameOfVideoFile>-<artworktype>.jpg/png'' format as required.
:*If '''Disabled''' {{kodi}} will use the '''filename''' to scrape the movie
::*NFO files must be named the long format ''<MovieFileName>.nfo'' filename.
::*Artwork files must be named using the long format ''<NameOfVideoFile>-<artworktype>.jpg/png'' filenames.

;Scan Recursively
:Used for deep folder structures such as when additional Genre or Movie Set folders are used. Will allow the video scanner to search deeper to find the playable file

;Selected folder contains a single video;
:Available only when you have selected '''''Change content''''' from the '''''[[Basic_controls#Context_Menu|Context Menu]]''''' on a Movie folder, instead of the Source folder. Allows you to adjust scraper settings for a particular movie which is different to the rest of the Source.

;Exclude path from library updates
:Prevents the Source from being scanned when an Update Library is running. When '''Enabled''' it will speed up the Update Library process in large libraries if the Source no longer has content added to it.

;Skip filename matching for external audio tracks
: When enabled Kodi skips name checks of external audio files in the folder and returns '''all''' found audio tracks to the player for the video. <ref>https://github.com/xbmc/xbmc/pull/16273</ref>

| style="width: 10%;" |
| style="width: 45%; text-align:left; vertical-align:top;" |

;Choose information provider
:Select this setting to change the scraper that this Source uses<br>
:{{note|If your preferred scraper is not listed, use the '''Get more...''' button.}}

;Settings
:Adjust the scraper settings, '''for this Source only'''.
:{{note|Default movie scraper settings are explained in the wiki page for each scraper.}}

;Selected folder contains a single TV show
:Allows you to change the Content settings for a particular TV Show without affecting the entire Source. Disabled when a Source is selected. Becomes Enabled when a TV Show folder is selected.

;Exclude path from library updates
:Prevents the Source from being scanned when an Update Library is running. When '''Enabled''' it will speed up the Update Library process in large libraries if the Source no longer has content added to it.

;Skip filename matching for external audio tracks
: When enabled Kodi skips name checks of external audio files in the folder and returns '''all''' found audio tracks to the player for the video. <ref>https://github.com/xbmc/xbmc/pull/16273</ref>
|}

'''Note:''' Additional scrapers are available.
{| class="mw-collapsible mw-collapsed wikitable" style="margin: 0.0em 0 0.0em 0em; {{border-radius|5px}}; {{box-shadow|0px|1px|3px|#878787}};"
! scope="row" style="width:500px; background-color:#dfedf0; text-align:left;"| List of Movie scrapers compatible with v21 Omega
|-
|
<dpl>
category = Omega_add-on_repository
category = Movie scraper add-ons
notcategory = Broken add-ons
</dpl>
|}

{| class="mw-collapsible mw-collapsed wikitable" style="margin: 0.0em 0 0.0em 0em; {{border-radius|5px}}; {{box-shadow|0px|1px|3px|#878787}};"
! scope="row" style="width:500px; background-color:#dfedf0; text-align:left;"| List of TV Show scrapers compatible with v21 Omega
|-
|
<dpl>
category = Omega_add-on_repository
category = TV scraper add-ons
notcategory = Broken add-ons
</dpl>
|}

{| class="mw-collapsible mw-collapsed wikitable" style="margin: 0.0em 0 0.0em 0em; {{border-radius|5px}}; {{box-shadow|0px|1px|3px|#878787}};"
! scope="row" style="width:500px; background-color:#dfedf0; text-align:left;"| List of Music Video scrapers compatible with v21 Omega
|-
|
<dpl>
category = Omega_add-on_repository
category = Category:Music_video_scraper_add-ons
notcategory = Broken add-ons
</dpl>
|}

= Add to Library =
<gallery mode="packed" widths="600px" heights="337px">
File:Quick-start-8.png|'''{{big|Step 10}}:''' Press '''Yes''' to scrape the content to the library <br />If '''No''' is selected, it can be scanned later from the '''''[[Basic_controls#Context_Menu|Context Menu]]''''' of the Source
</gallery>
<section end="adding video" />

* Once you press '''Yes''', {{kodi}} will scan your library and attempt to match each title in your library to the title at the site of the Information Provider. If a match is found, the metadata and artwork are downloaded and used for the library display.
* Depending upon the size of your library, this could take some time. A single movie could take approx 30 seconds, a library of 400 movies could take over an hour.

When the scraping process is complete, be sure to check the '''''[[Event_Log|Event Log]]''''' to view any titles that were not added to the library, which is normally due to incorrect naming. '''''See... [[Incorrect_and_missing_videos|Scraping Problems]]'''''

<center>'''{{big|{{green|At this point, you should now have a fully functioning video library. Repeat the steps on this page to add the remainder of your media Sources.}}}}'''</center>

= References =
<references />

<center>
{| style="border: 1px solid black;"
| scope="row" rowspan="2" style=" text-align:center;" | [[File:Mergefrom.gif|60px|link=Naming_video_files/Episodes]]
| style="width:200px; text-align:center;" | '''Previous step'''
|-
| style="width:200px; text-align:center;" | '''[[Naming_video_files/Episodes|Episodes Setup]]'''
|}</center>

{{top}}
{{updated|21}}

[[Category:Karellen]]
[[Category:Video library]]

Add-on:Extras

2025-05-07T23:34:47Z

Karellen:

{{Addon
|Name=Extras
|provider-name=takoi,pkscout
|ID=context.item.extras
|latest-version=1.4.2
|extension point=kodi.context.item
|provides=
|Summary=View extras and special features
|Description=Provides an easy way to browse and view movie and TV show extras. Extras can be accessed from the context menu in the video library. By default, the add-on will look in the "Extras" sub-folder for content (can be changed in settings).

Tip: for how to avoid extras beings scraped to library, see http://kodi.wiki/view/Add-on:Extras
|Platform=all
|Language=
|License=GPL-3.0-ONLY
|Forum=https://forum.kodi.tv/showthread.php?tid=312338
|Website=http://kodi.wiki/view/Add-on:Extras
|Source=https://github.com/tamland/kodi-addon-extras
|Email=
|broken=
|icon url=http://mirrors.kodi.tv/addons/omega/context.item.extras/icon.png}}

= Introduction =
<section begin="intro" />The Extras add-on allows easy access to all the bonus material that usually comes packaged with the main movie of the DVD or BluRay. Save these Extras, such as Bloopers, Cast Interviews, Production Notes, etc along with the main movie in a folder named '''Extras'''. Access theses Extras from the Context Menu of the movie.<section end="intro" />

'''Note:''' {{kodi}} v21 introduces native support for Extras using '''[[Video_extras|Video Extras]]'''. Video Extras currently only supports Movies and this add-on is still required for TV Show Extras. This add-on and the native Video Extras will not interfere with each other, and both can be used in the same library.

= Location of Extras folder =
By default, the add-on will look for the folder named '''Extras'''. The name of this folder can be changed in settings but you can only use one name. The location of the Extras folder is important as failing to locate the folder correctly will return an empty listing.

The use of sub-folders is supported, should you have a need to organise your Extras content. eg <code>...\Extras\Trailers\</code> <code>...\Extras\Making of\</code> <code>...\Extras\Cast Interviews\</code> etc

Following are typical examples of correct placement

== For Movies ==
The Extras folder must be located in the same folder as your video file. Some typical examples are listed below.

Cannot be used where all movies are in the same folder. (flat folder structure)

=== DVD Structure ===
...\Chronicles of Riddick\
...\Chronicles of Riddick\AUDIO_TS\
...\Chronicles of Riddick\VIDEO_TS\
...\Chronicles of Riddick\VIDEO_TS\'''Extras'''\

=== Bluray Structure ===
...\Lucy (2014)\
...\Lucy (2014)\BDMV\
...\Lucy (2014)\BDMV\'''Extras'''\
...\Lucy (2014)\CERTIFICATE\

This assumes you have index.bdmv or MovieObject.bdmv in the \BDMV\ folder. (sub-directories in the BDMV and Certificate directories are intentionally omitted)

=== Single Movie Folders ===
...\Lucy (2014)\
...\Lucy (2014)\'''Extras'''\

== For TV Shows ==
You are not able to use Extras per individual episode. Extras for a TV Show are located within the main TV Show folder.

...\iZombie (2015)
...\iZombie (2015)\'''Extras'''\
...\iZombie (2015)\Season 1\iZombie (2015) S01E01
...\iZombie (2015)\Season 2\iZombie (2015) S02E01

== Usage ==
If you have followed these instructions correctly, selecting Extra's from the Context Menu should return a display similar to this.

<gallery widths="700" heights="400">
File:Add-On Extras Listing.jpg|
</gallery>

= Preventing Extras Being Added To Library =
Extras are video files the same way the main feature movie is a video file. This may cause Kodi to see your Extras as additional movies. To prevent each Extras video file being scraped as a movie, and adding random or duplicated movies into your library, you must tell Kodi not to scrape the Extras folder.

A number of methods are available. A listing is found here '''''[[Updating_or_removing_videos#Exclude|Excluding folders and file types]]''''' or use the [[Advancedsettings.xml]] method using the code below by simply copying and pasting the following code into your [[Advancedsettings.xml]] file. If you already have an advancedsettings.xml file, do not duplicate the <advancedsettings></advancedsettings> tags.
<syntaxhighlight lang=xml enclose="div">
<advancedsettings version="1.0">
<video>
<excludefromscan>
<regexp>[-\._ ](extrafanart|sample|trailer|extrathumbs)[-\._ ]</regexp>
</excludefromscan>
<excludefromlisting>
<regexp>[-._ \\/](extrafanart|sample|trailer|extrathumbs)[-._ \\/]</regexp>
</excludefromlisting>

<excludefromscan action="append">
<regexp>/extras/</regexp>
<regexp>[\\/]extras[\\/]</regexp>
</excludefromscan>
<excludetvshowsfromscan action="append">
<regexp>/extras/</regexp>
<regexp>[\\/]extras[\\/]</regexp>
</excludetvshowsfromscan>

</video>
</advancedsettings>
</syntaxhighlight>

= Usage =
Extras is accessed via the Context Menu. To view Extras:
# Highlight the Movie or TV Show
# Call up the [[Basic_controls#Context_Menu|Context Menu]]
# Select Extras
# A listing of the Extras folder will be displayed as shown in the image above.

In previous versions it could also be accessed via the Movie Information page, but has been removed from v17.

= Known Issues =
;When I try to play an Extra, Kodi tries to scrape it
:This is a result of selecting as default '''Show Information''' in the setting '''''[[Settings/Media/Videos#Default_select_action|Default Select Action]]'''''
:Change this to '''Play''' to prevent Kodi from scraping instead of playing.

= Bug and Issue Reports =
If you experience any issues with this add-on, click [https://forum.kodi.tv/showthread.php?tid=356731 here] and post details of the issue to seek further assistance.

{{top}}

{{updated|20}}

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Context menu add-ons]]
[[Category:Karellen]]
[[Category:Nexus]]
[[Category:Video add-ons]]
[[Category:Video library]]
[[Category:Isengard add-on repository]]
[[Category:Jarvis add-on repository]]
[[Category:Krypton add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Nexus add-on repository]]
[[Category:Omega add-on repository]]