Userdata: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
mNo edit summary
(19 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{mininav|[[General topics]]|[[Settings]]}}
{{mininav|[[General topics]]|[[Settings]]}}
{{DISPLAYTITLE:userdata folder}}
 
{{redv|'''NOTICE:'''|Manually editing files in the '''userdata''' folder is an '''advanced topic in XBMC'''. New users '''don't need to manually edit files''' in the '''userdata''' folder. XBMC does this for you, when you change the options in the XBMC GUI'' with the exception of [[advancedsettings.xml]]}}
{{redv|'''NOTICE:'''|Manually editing files in the '''userdata''' folder is an '''advanced topic for {{kodi}}'''. New users '''don't need to manually edit files''' in the '''userdata''' folder. {{kodi}} does this for you, when you change the options in the {{kodi}} GUI'' with the exception of [[advancedsettings.xml]]}}
{{bluev|'''NOTE'''|''There are two userdata folders, the system one contains default settings necessary for XBMC to operate, and the userdata folder for user modifications. Do not touch the files in the first system-userdata folder. This page (and most references on the wiki) are about editing the second, user-accessible, '''userdata''' folder.''}}
{{bluev|'''NOTE'''|''There are two userdata folders, the [[Systemdata]] one contains default settings necessary for {{kodi}} to operate, and the userdata folder for user modifications. Do not touch the files in the first system-userdata folder. This page (and most references on the wiki) are about editing the second, user-accessible, '''userdata''' folder.''}}


<section begin="intro" />The '''userdata''' folder is where all of your settings and customizations are stored.<section end="intro" />
<section begin="intro" />The '''userdata''' folder is where all of your settings and customizations are stored.<section end="intro" />
Line 10: Line 10:
<includeonly>:::</includeonly>{{Note|In older versions of the software (before v14) the <code>'''kodi'''</code> directories were named <code>'''xbmc'''</code>.}}
<includeonly>:::</includeonly>{{Note|In older versions of the software (before v14) the <code>'''kodi'''</code> directories were named <code>'''xbmc'''</code>.}}
<includeonly>:::</includeonly>{{{!}} class="datatable" <!-- Weird trick used to make the table indent when transcluded -->  
<includeonly>:::</includeonly>{{{!}} class="datatable" <!-- Weird trick used to make the table indent when transcluded -->  
! Operative system
! Operating system
! File path
! File path
|-
|-
| '''[[Android]]''' {{small | ''(see [[Userdata#Android location|note]])'' }} || Android/data/org.xbmc.xbmc/files/.xbmc/userdata/
| '''Android''' || {{userdata|Android}}
|-
|-
| '''[[iOS]]''' || /private/var/mobile/Library/Preferences/kodi/userdata/
| '''iOS''' || {{userdata|iOS}}
|-
|-
| '''[[Linux]]''' || ~/.kodi/userdata/
| '''Linux''' || {{userdata|Linux}}
|-
|-
| '''[[Mac OS X]]''' {{small | ''(see [[Mac FAQ#Lion userdata|note]])'' }} || /Users/<your_user_name>/Library/Application Support/kodi/userdata/
| '''Mac''' || {{userdata|Mac}}
|-
|-
| '''[[OpenELEC]]''' || /storage/.kodi/userdata/
| '''LibreELEC/OpenELEC''' || {{userdata|OpenELEC}}
|-
|-
| '''[[Windows]]''' || Start - type %APPDATA%\kodi\userdata - press <Enter>
| '''Windows''' || {{userdata|Windows}}
|-
| '''Windows UWP ''' || {{userdata|Windows UWP}}
|}
|}
<section end="location all" />
<section end="location all" />
Line 29: Line 31:
=== Android location ===
=== Android location ===
Sometimes the exact path will differ from device to device. The Android userdata folder is usually inside of "sdcard" so the path might be /sdcard/Android/data/org.xbmc.kodi/files/.kodi/userdata/
Sometimes the exact path will differ from device to device. The Android userdata folder is usually inside of "sdcard" so the path might be /sdcard/Android/data/org.xbmc.kodi/files/.kodi/userdata/
=== Windows 10 App Store version ===
Kodi Krypton installed from the Win 10 App Store puts user data in %LOCALAPPDATA%\Packages\XBMCFoundation.Kodi_4n2hpmxwrvr6p\LocalCache\Roaming\Kodi\userdata


== Backing up your settings ==
== Backing up your settings ==
Line 37: Line 42:


* '''addon_data''' - Contains configuration data for your currently installed addons, the addons themselves are not in userdata but one folder up in 'addons'
* '''addon_data''' - Contains configuration data for your currently installed addons, the addons themselves are not in userdata but one folder up in 'addons'
* '''[[The XBMC Database|Database]]''' - This is where all of the databases required for your [[Music Library|Music]] and [[Video Library|Video Libraries]] are located, containing any downloaded [[Scraper.xml|(scraped)]] music or video information.
* '''[[Database]]''' - This is where all of the databases required for your [[Music Library|Music]] and [[Video Library|Video Libraries]] are located, containing any downloaded [[Scraper.xml|(scraped)]] music or video information.
** '''MyMusic#.db''' - Database file containing Music information.
** '''MyMusic#.db''' - Database file containing Music information.
** '''MyPrograms#.db''' - Database file containing Program information.
** '''MyVideos#.db''' - Database file containing Movie, TV Show and Music Videos information.
** '''MyVideos#.db''' - Database file containing Movie, TV Show and Music Videos information.
** '''ViewModes#.db''' - Database file containing information on all XBMC views (viewmode, sorting etc.).
** '''ViewModes#.db''' - Database file containing information on all Kodi views (viewmode, sorting etc.).
** '''Addons#.db''' - Database file containing information on all XBMC addons (skins, scraper, video-addons...).
** '''Addons#.db''' - Database file containing information on all Kodi addons (skins, scraper, video-addons...).
** '''Textures#.db''' - Database file containing information on all XBMC textures (thumbs, fanart, posters...).
** '''Textures#.db''' - Database file containing information on all Kodi textures (thumbs, fanart, posters...).
** '''TV1#.db''' - Database file containing information on Live-TV channels (experimental PVR-builds only!).
** '''TV#.db''' - Database file containing information on Live-TV channels.
** '''EPG#.db''' - Database file containing information on EPG for Live-TV (experimental PVR-builds only!).
** '''EPG#.db''' - Database file containing information on EPG for Live-TV.
:{{note|Where <big>'''#'''</big> is the number of current '''[[database version]]''' in use.}}
** '''ADSP#.db''' - Database file containing information for Audio Digital Signal Processing add-ons.
:{{note|Where <big>'''#'''</big> is the number of current '''[[Databases#Database_Versions]]''' in use.}}
* '''[[keyboard.xml|keymaps]]''' - This folder is where your customized keymapping files reside (e.g. MyRemote.xml or keyboard.xml)
* '''[[keyboard.xml|keymaps]]''' - This folder is where your customized keymapping files reside (e.g. MyRemote.xml or keyboard.xml)
* '''library''' - Directory to store [[custom library nodes]].
* '''library''' - Directory to store [[custom library nodes]].
Line 53: Line 58:
** '''music''' - playlists containing audio only, will show in the Music Library.
** '''music''' - playlists containing audio only, will show in the Music Library.
** '''video''' - playlists containing videos only, will show in the Video Library.
** '''video''' - playlists containing videos only, will show in the Video Library.
* '''[[Thumbnails#Thumbnail Cache|Thumbnails]]''' - Cached  Thumbnails (icons) are stored in this folder.
* '''[[Artwork|Thumbnails]]''' - Cached  Thumbnails (icons) are stored in this folder.
* '''[[advancedsettings.xml]]''' - A user can create this file in their UserData folder. The file can contain additional settings and pre-defined values for the settings available in the GUI (thus removing them from the GUI settings screens). Useful for advanced users and for installers.
* '''[[advancedsettings.xml]]''' - A user can create this file in their UserData folder. The file can contain additional settings and pre-defined values for the settings available in the GUI (thus removing them from the GUI settings screens). Useful for advanced users and for installers.
* '''Visualizations''' - All of your visualization settings are stored in this folder. <<this is not present in frodo?
* '''Visualizations''' - All of your visualization settings are stored in this folder. <<this is not present in frodo?
* '''[[favourites.xml]]''' - This file, which may be created by XBMC or the user in their UserData folder contains items added via the ''Add to Favourites'' context menu option.
* '''[[favourites.xml]]''' - This file, which may be created by Kodi or the user in their UserData folder contains items added via the ''Add to Favourites'' context menu option.
* '''guisettings.xml''' - This is where your settings configured in the GUI are stored (through the User Interface [[Settings]]).
* '''guisettings.xml''' - This is where your settings configured in the GUI are stored (through the User Interface [[Settings]]).
* '''[[lircmap.xml|Lircmap.xml]]''' - This file which may be created can contain changes to the default Lircmap (Linux Only).
* '''[[lircmap.xml|Lircmap.xml]]''' - This file which may be created can contain changes to the default Lircmap (Linux Only).
* '''[[partymode.xsp]]''' - Defines the [[Playlists#Smart Playlists|Smart Playlist]] to be used when using Party Mode for music playback.
* '''[[partymode.xsp]]''' - Defines the [[Playlists#Smart Playlists|Smart Playlist]] to be used when using Party Mode for music playback.
* '''[[profiles]]''' - Directory stores your additionally created user-profiles settings and data information this directory may contain all the contents of the [[userdata]] list depending on settings used to create the user. {{?}}
* '''[[profiles]]''' - Directory stores your additionally created user-profiles settings and data information this directory may contain all the contents of the [[userdata]] list depending on settings used to create the user. {{?}}
* '''[[RssFeeds.xml]]''' - RssFeeds.xml is used to configure the RSS feeds displayed in XBMC.
* '''[[RssFeeds.xml]]''' - RssFeeds.xml is used to configure the RSS feeds displayed on the home screen.
* '''[[sources.xml]]''' - Defines your [[Adding Media Sources|Media Sources]] and locations.
* '''[[sources.xml]]''' - Defines your [[Adding Media Sources|Media Sources]] and locations.
* '''[[mediasources.xml]]''' - Similar to sources.xml, but just for the "Browse for new share" window.
* '''[[mediasources.xml]]''' - Similar to sources.xml, but just for the "Browse for new share" window.
* '''[[Profiles#Profiles folder contents|profiles.xml]]''' - Stores your Master user and additional user(s) [[Master lock]] codes and profiles information see also [[Settings/System#Master lock]] and [[Media sources#Locking]] '''{{?}}'''
* '''[[Profiles#Profiles folder contents|profiles.xml]]''' - Stores your Master user and additional user(s) [[Master lock]] codes and profiles information see also [[Settings/System#Master lock]] and [[Media sources#Locking]] '''{{?}}'''
* '''[[autoexec.py]]''' - optional python script that is run at XBMC startup.
* '''[[autoexec.py]]''' - optional python script that is run at Kodi startup.


{{Gotham updated}}
{{Krypton updated}}


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

Revision as of 09:02, 17 January 2019

Home icon grey.png   ▶ General topics ▶ Settings ▶ Userdata
NOTICE: Manually editing files in the userdata folder is an advanced topic for Kodi. New users don't need to manually edit files in the userdata folder. Kodi does this for you, when you change the options in the Kodi GUI with the exception of advancedsettings.xml
NOTE There are two userdata folders, the Systemdata one contains default settings necessary for Kodi to operate, and the userdata folder for user modifications. Do not touch the files in the first system-userdata folder. This page (and most references on the wiki) are about editing the second, user-accessible, userdata folder.


The userdata folder is where all of your settings and customizations are stored.

Location of the userdata folder

Note: In older versions of the software (before v14) the kodi directories were named xbmc.

Operating system File path
Android Android/data/org.xbmc.kodi/files/.kodi/userdata/ (see note)
iOS /private/var/mobile/Library/Preferences/Kodi/userdata/
Linux ~/.kodi/userdata/
Mac /Users/<your_user_name>/Library/Application Support/Kodi/userdata/
LibreELEC/OpenELEC
Windows %APPDATA%\Kodi\userdata
Windows UWP %LOCALAPPDATA%\Packages\XBMCFoundation.Kodi_4n2hpmxwrvr6p\LocalCache\Roaming\Kodi\


Android location

Sometimes the exact path will differ from device to device. The Android userdata folder is usually inside of "sdcard" so the path might be /sdcard/Android/data/org.xbmc.kodi/files/.kodi/userdata/

Windows 10 App Store version

Kodi Krypton installed from the Win 10 App Store puts user data in %LOCALAPPDATA%\Packages\XBMCFoundation.Kodi_4n2hpmxwrvr6p\LocalCache\Roaming\Kodi\userdata

Backing up your settings

See: Backup

UserData folder contents

Below are the elements contained in the UserData folder and their role:

  • addon_data - Contains configuration data for your currently installed addons, the addons themselves are not in userdata but one folder up in 'addons'
  • Database - This is where all of the databases required for your Music and Video Libraries are located, containing any downloaded (scraped) music or video information.
    • MyMusic#.db - Database file containing Music information.
    • MyVideos#.db - Database file containing Movie, TV Show and Music Videos information.
    • ViewModes#.db - Database file containing information on all Kodi views (viewmode, sorting etc.).
    • Addons#.db - Database file containing information on all Kodi addons (skins, scraper, video-addons...).
    • Textures#.db - Database file containing information on all Kodi textures (thumbs, fanart, posters...).
    • TV#.db - Database file containing information on Live-TV channels.
    • EPG#.db - Database file containing information on EPG for Live-TV.
    • ADSP#.db - Database file containing information for Audio Digital Signal Processing add-ons.
Note: Where # is the number of current Databases#Database_Versions in use.
  • keymaps - This folder is where your customized keymapping files reside (e.g. MyRemote.xml or keyboard.xml)
  • library - Directory to store custom library nodes.
  • Playlists - This is where your playlists are stored. There are separate subfolders for mixed, music and video playlists.
    • mixed - playlists containing both audio and music videos, will show in both the Music and Video Libraries.
    • music - playlists containing audio only, will show in the Music Library.
    • video - playlists containing videos only, will show in the Video Library.
  • Thumbnails - Cached Thumbnails (icons) are stored in this folder.
  • advancedsettings.xml - A user can create this file in their UserData folder. The file can contain additional settings and pre-defined values for the settings available in the GUI (thus removing them from the GUI settings screens). Useful for advanced users and for installers.
  • Visualizations - All of your visualization settings are stored in this folder. <<this is not present in frodo?
  • favourites.xml - This file, which may be created by Kodi or the user in their UserData folder contains items added via the Add to Favourites context menu option.
  • guisettings.xml - This is where your settings configured in the GUI are stored (through the User Interface Settings).
  • Lircmap.xml - This file which may be created can contain changes to the default Lircmap (Linux Only).
  • partymode.xsp - Defines the Smart Playlist to be used when using Party Mode for music playback.
  • profiles - Directory stores your additionally created user-profiles settings and data information this directory may contain all the contents of the userdata list depending on settings used to create the user. ?
  • RssFeeds.xml - RssFeeds.xml is used to configure the RSS feeds displayed on the home screen.
  • sources.xml - Defines your Media Sources and locations.
  • mediasources.xml - Similar to sources.xml, but just for the "Browse for new share" window.
  • profiles.xml - Stores your Master user and additional user(s) Master lock codes and profiles information see also Settings/System#Master lock and Media sources#Locking ?
  • autoexec.py - optional python script that is run at Kodi startup.