Userdata: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
>Sho
m (Source tag)
No edit summary
(132 intermediate revisions by 23 users not shown)
Line 1: Line 1:
The UserData folder, which is located in the main XBMC installation folder is where all of your settings and customizations are stored.  
{{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]]}}
{{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.''}}


Here is an example of the structure:
<section begin="intro" />The '''userdata''' folder is where all of your settings and customizations are stored.<section end="intro" />
<br />
== Location of the userdata folder ==
<section begin="location all" />
<includeonly>:::</includeonly>{{Helix note|In the upcoming Kodi v14 the <code>'''xbmc'''</code> directories will be renamed to <code>'''kodi'''</code>.}}
<includeonly>:::</includeonly>{{{!}} class="datatable" <!-- Weird trick used to make the table indent when transcluded -->
! Operative system
! File path
|-
| '''[[Android]]''' {{small | ''(see [[Userdata#Android location|note]])'' }} || Android/data/org.xbmc.xbmc/files/.xbmc/userdata/
|-
| '''[[iOS]]''' || /private/var/mobile/Library/Preferences/XBMC/userdata/
|-
| '''[[Linux]]''' || ~/.xbmc/userdata/
|-
| '''[[Mac OS X]]''' {{small | ''(see [[Mac FAQ#Lion userdata|note]])'' }} || /Users/<your_user_name>/Library/Application Support/XBMC/userdata/
|-
| '''[[OpenELEC]]''' || /storage/.xbmc/userdata/
|-
| '''[[Windows]]''' || Start - type %APPDATA%\XBMC\userdata - press <Enter>
|}
<section end="location all" />


=== 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.xbmc/files/.xbmc/userdata/


*'''[[The_XBMC_Database|Database]]''' - This is where all of the databases required for your Music and Video Libraries are located, along with any downloaded CDDB or IMDb information.
== Backing up your settings ==
**'''CDDB'''
{{See|Backup}}
**'''IMDb'''
**'''MyMusic6.db'''
**'''MyPrograms6.db'''
**'''MyVideos31.db'''
*'''[[Playlists]]''' - This is where your playlists are stored. There are separate subfolders for music and video playlists.
**'''music'''
**'''video'''
*'''[[Thumbnails#Thumbnail Cache|Thumbnails]]''' - Cached  Thumbnails (icons) are stored in this folder.
*'''Visualizations''' - All of your visualization settings are stored in this folder.
*'''[[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.
*'''[[Favourites|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]]).
*'''kai-vectors.xml'''
*'''[[LCD.xml]]''' - The LCD.xml file is used for customizing the output of the LCD Display.
*'''[[PartyMode.xml]]''' - 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 in XBMC.
*'''[[Adding Media Sources#Through_Sources.xml|Sources.xml]]''' - Defines your [[Adding Media Sources|Media Sources]]


[[category:Settings]]
== UserData folder contents ==
[[category:Customization]]
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'
* '''[[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.
** '''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.
** '''ViewModes#.db''' - Database file containing information on all XBMC views (viewmode, sorting etc.).
** '''Addons#.db''' - Database file containing information on all XBMC addons (skins, scraper, video-addons...).
** '''Textures#.db''' - Database file containing information on all XBMC textures (thumbs, fanart, posters...).
** '''TV1#.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 <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)
* '''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#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.
* '''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.
* '''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).
* '''[[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. {{?}}
* '''[[RssFeeds.xml]]''' - RssFeeds.xml is used to configure the RSS feeds displayed in XBMC.
* '''[[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.
* '''[[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.
 
{{Gotham updated}}
 
[[Category:Settings]]
[[Category:Manual]]
[[Category:Advanced topics]]

Revision as of 01:22, 6 December 2014

Home icon grey.png   ▶ General topics ▶ Settings ▶ Userdata
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
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.


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

Location of the userdata folder

Template:Helix note

Operative system File path
Android (see note) Android/data/org.xbmc.xbmc/files/.xbmc/userdata/
iOS /private/var/mobile/Library/Preferences/XBMC/userdata/
Linux ~/.xbmc/userdata/
Mac OS X (see note) /Users/<your_user_name>/Library/Application Support/XBMC/userdata/
OpenELEC /storage/.xbmc/userdata/
Windows Start - type %APPDATA%\XBMC\userdata - press <Enter>


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.xbmc/files/.xbmc/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.
    • MyPrograms#.db - Database file containing Program 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.).
    • Addons#.db - Database file containing information on all XBMC addons (skins, scraper, video-addons...).
    • Textures#.db - Database file containing information on all XBMC textures (thumbs, fanart, posters...).
    • TV1#.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 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).
  • 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 in XBMC.
  • 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 XBMC startup.