Userdata: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
>UNiversal
m (→‎UserData folder contents: Thers a few incomplete and unclear entries that need filling in.)
(96 intermediate revisions by 17 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:userdata folder}}{{XBMC faq toc Inline}}
{{mininav|[[General topics]]|[[Settings]]}}
:'''''Note:''' Manually editing the UserData Folder is an advanced topic in XBMC. New users normally 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.''


This is where all of your settings and customizations are stored.  
{{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 [[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.''}}


==Location of the UserData folder==
<section begin="intro" />The '''userdata''' folder is where all of your settings and customizations are stored.<section end="intro" />
* '''Android:''' <code>Android/data/org.xbmc.xbmc/files/.xbmc/userdata/</code>
<br />
* '''iOS/ATV2:''' <code>/private/var/mobile/Library/Preferences/XBMC/userdata/</code>
== Location of the userdata folder ==
* '''Linux:''' <code>$HOME/.xbmc/userdata/</code>
<section begin="location all" />
* '''Mac OS X:''' <code>/Users/<your_user_name>/Library/Application Support/XBMC/userdata/</code>
<includeonly>:::</includeonly>{{Note|In older versions of the software (before v14) the <code>'''kodi'''</code> directories were named <code>'''xbmc'''</code>.}}
* '''Windows Vista/7:''' <code>Users\%userprofile%\AppData\Roaming\XBMC\userdata\</code>
<includeonly>:::</includeonly>{{{!}} class="datatable" <!-- Weird trick used to make the table indent when transcluded -->  
* '''Windows XP:''' <code>Documents and Settings\%userprofile%\Application Data\XBMC\userdata\</code>
! Operative system
! File path
|-
| '''Android''' || {{userdata|Android}}
|-
| '''iOS''' || {{userdata|iOS}}
|-
| '''Linux''' || {{userdata|Linux}}
|-
| '''Mac''' || {{userdata|Mac}}
|-
| '''OpenELEC''' || {{userdata|OpenELEC}}
|-
| '''Windows''' || {{userdata|Windows}}
|}
<section end="location all" />


==UserData folder contents==
=== Android location ===
{{incomplete}}
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/
 
== Backing up your settings ==
{{See|Backup}}
 
== UserData folder contents ==
Below are the elements contained in the UserData folder and their role:
Below are the elements contained in the UserData folder and their role:


*'''addon_data''' - Contains your currently installed 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.
**'''MyMusic18.db''' - Database file containing Music information.
** '''MyMusic#.db''' - Database file containing Music information.
**'''MyPrograms6.db''' - Database file containing Program information.
** '''MyVideos#.db''' - Database file containing Movie, TV Show and Music Videos information.
**'''MyVideos60.db''' - Database file containing Movie, TV Show and Music Videos information.
** '''ViewModes#.db''' - Database file containing information on all {{kodi}} views (viewmode, sorting etc.).
**'''ViewModes4.db''' - Database file containing information on all XBMC views (viewmode, sorting etc.).
** '''Addons#.db''' - Database file containing information on all {{kodi}} addons (skins, scraper, video-addons...).
**'''Addons15.db''' - Database file containing information on all XBMC addons (skins, scraper, video-addons...).
** '''Textures#.db''' - Database file containing information on all {{kodi}} textures (thumbs, fanart, posters...).
**'''Textures6.db''' - Database file containing information on all XBMC textures (thumbs, fanart, posters...).
** '''TV#.db''' - Database file containing information on Live-TV channels (experimental PVR-builds only!).
**'''TV16.db''' - Database file containing information on Live-TV channels (experimental PVR-builds only!).
** '''EPG#.db''' - Database file containing information on EPG for Live-TV (experimental PVR-builds only!).
**'''EPG5.db''' - Database file containing information on EPG for Live-TV (experimental PVR-builds only!).
:{{note|Where <big>'''#'''</big> is the number of current '''[[database version]]''' 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 stores what exactly{{?}}
* '''library''' - Directory to store [[custom library nodes]].
*'''peripheral_data''' - Directory stores what exactly{{?}}
* '''[[Playlists]]''' - This is where your playlists are stored. There are separate subfolders for mixed, music and video playlists.
*'''[[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.
**'''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.
**'''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.
*'''[[Thumbnails#Thumbnail Cache|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]]''' - This file, which may be created by a user in their UserData folder can contain additional settings, and can contain 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 {{kodi}} 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 XBMC 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.
*'''[[LCD.xml]]''' - The LCD.xml file is used for customizing the output of the LCD Display.
* '''[[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. {{?}}
*'''[[partymode.xsp]]''' - Defines the [[Playlists#Smart_Playlists|Smart Playlist]] to be used when using Party Mode for music playback.
* '''[[RssFeeds.xml]]''' - RssFeeds.xml is used to configure the RSS feeds displayed on the home screen.
*'''[[profiles]]''' - Directory stores your profiles information this is a directory which contains {{?}}
* '''[[sources.xml]]''' - Defines your [[Adding Media Sources|Media Sources]] and locations.
*'''[[RssFeeds.xml]]''' - RssFeeds.xml is used to configure the RSS feeds displayed in XBMC.
* '''[[mediasources.xml]]''' - Similar to sources.xml, but just for the "Browse for new share" window.
*'''[[sources.xml]]''' - Defines your [[Adding Media Sources|Media Sources]] and locations.
* '''[[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]] '''{{?}}'''
*'''[[mediasources.xml]]''' - Similar to sources.xml, but just for the "Browse for new share" window.
* '''[[autoexec.py]]''' - optional python script that is run at {{kodi}} startup.
*'''[[Profiles#profiles_folder_and_profiles.xml|profiles.xml''']] - Stores your [[Master lock]] codes and profiles information see also [[Settings/System#Master lock]] and [[Media_sources#Locking]] {{?}}
 
{{Helix updated}}


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

Revision as of 22:17, 21 June 2015

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.

Operative 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/
OpenELEC
Windows %APPDATA%\Kodi\userdata


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/

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 (experimental PVR-builds only!).
    • EPG#.db - Database file containing information on EPG for Live-TV (experimental PVR-builds only!).
Note: Where # is the number of current database version 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.