Userdata: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
(24 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{mininav|[[General topics]]|[[Settings]]}}
{{mininav|[[Settings]]|[[Kodi data folder]]}}


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


<section begin="intro" />The '''userdata''' folder is where all of your settings and customizations are stored.<section end="intro" />
 
<br />
= Introduction =
== Location of the userdata folder ==
The Userdata folder is a subfolder of the '''[[Kodi data folder|Kodi Data Folder]]'''. The folders and files described on this page may vary between releases and forks.
 
This Userdata folder is used for the '''Master''' (default) profile. When creating a new profile, the userdata folder for the new profile is stored in the Profiles folder detailed below.
 
Modifying items in the Userdata folder is an advanced topic and not recommended. If you find it necessary, create a '''[[Backup]]''' of the Kodi data folder first.
 
 
 
= Location =
<section begin="location all" />
<section begin="location all" />
<includeonly>:::</includeonly>{{Note|In older versions of the software (before v14) the <code>'''kodi'''</code> directories were named <code>'''xbmc'''</code>.}}
The Userdata folder is a subfolder of the '''''[[Kodi data folder|Kodi Data Folder]]''''' and is located as shown in the table below.  
<includeonly>:::</includeonly>{{{!}} class="datatable" <!-- Weird trick used to make the table indent when transcluded -->
{| class="prettytable"
! Operative system
! scope="row" ! style="width:150px; background-color:#f8fc36; | Operating system
! File path
! scope="row" ! style="width:700px; background-color:#f8fc36; | Userdata Folder
|-
| '''Android''' || {{userdata|Android}}
|-
|-
| '''[[Android]]''' {{small | ''(see [[Userdata#Android location|note]])'' }} || Android/data/org.xbmc.kodi/files/.kodi/userdata/
| '''iOS''' || {{userdata|iOS}}
|-
|-
| '''[[iOS]]''' || /private/var/mobile/Library/Preferences/Kodi/userdata/
| '''LibreELEC''' || {{userdata|LibreELEC}}
|-
|-
| '''[[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/
| '''OSMC''' || {{userdata|OSMC}}
|-
|-
| '''[[OpenELEC]]''' || /storage/.kodi/userdata/
| '''Mac''' || {{userdata|Mac}}
|-
|-
| '''[[Windows]]''' || Start - type %APPDATA%\kodi\userdata - press <Enter>
| '''tvOS''' || {{userdata|iOS}}
|-
| '''Windows''' || {{userdata|Windows}}
|-
| '''Windows Portable''' || <''Install location chosen by you''>\portable_data\userdata\
|-
| '''Windows UWP ''' || {{userdata|Windows UWP}}
|}
|}
:'''Note:''' In some Android setups the path may be slightly different to the one stated above.
<section end="location all" />
<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.kodi/files/.kodi/userdata/


== Backing up your settings ==
{{See|Backup}}


== UserData folder contents ==
= Folders =
Below are the elements contained in the UserData folder and their role:
The following subfolders are located in the Userdata folder:
 
 
== addon_data ==
Is the counterpart to the '''[[Kodi_data_folder#addons|addons]]''' folder in the Kodi Data folder.
 
For addons that require it, this folder holds user specified settings and other data. Not all installed add-ons will have a folder here.
 
 
 
== Database ==
{{See|Databases}}
 
 
 
== keymaps ==
This folder is where your customized keymapping files reside (e.g. MyRemote.xml or keyboard.xml)
 
{{See|Keyboard controls}}
{{See|Keymap}}
 
 
 
== library ==
The folder where user created library nodes are stored.
 
If creating a new node, first copy the contents of the identical '''library''' folder located in the program installation folder. Once copied across, you are able to modify existing nodes or add new nodes. Using the '''[[Add-on:Library_Node_Editor|Node Editor]]''' will automatically copy the files across.
 
If you need to remove a node, open the xml file and add '''visible="false"''' to the opening ''<node>'' tag. eg '''''<node order="80" type="folder" visible="false">'''''
 
{{See|Music nodes}}
{{See|Video nodes}}
 
 
 
== peripheral_data ==
Settings and other data for hardware using the Peripheral API, such as joysticks.
 
 
 
== playlists ==
Playlists are saved in one of the following subfolders.
 
If using the {{kodi}} interface to create your smart playlist, {{kodi}} will save the playlist to the correct folder. If creating a playlist using an XML editor, ensure the playlist is saved to the correct folder or it will not be available in {{kodi}}.
 
* '''mixed''' - playlists containing both music and music videos, will show in both the Music and Video Libraries.
* '''music''' - playlists containing music only, will show in the Music Library.
* '''video''' - playlists containing videos only, will show in the Video Library.
 
{{See|Playlists}}
 
 
 
== profiles ==
Available only when one or more new profiles have been created.
 
New Profiles are created in this folder. Each subfolder is a Profile and contains a replica of the Userdata folder. Depending on which settings you chose during setup, the Profile Userdata folder may contain structure and data or structure only.
 
{{See|Profiles}}
 
 
 
== Savestates ==
Save points for the Games section of {{kodi}}
 
{{See|Games}}
 
 
 
== Thumbnails ==
This is the location of all the cached artwork.
 
{{See|Artwork}}
{{See|Artwork/Cache}}
 
 
 
= Files =
The following files are located in the Userdata folder:
 
 
== advancedsettings.xml ==
'''This file does not exist by default. It must be created by the user.'''
 
This file can be used to modify additional settings that are not displayed in the {{kodi}} Settings pages.
 
{{See|Advancedsettings.xml}}
 
 
 
== autoexec.py ==
'''This file does not exist by default. It must be created by the user.'''
 
An autoexec.py file can be used to perform certain actions during startup of {{kodi}}.
 
;Notes:
* From v12 - v18 either the autoexec.py or the Autoexec Service methods can be used (not both).
* From v19 the autoexec.py feature has been removed for security reasons. Use the Autoexec Service instead and delete the autoexec.py file if one remains from a previous setup.
 
{{See|Autoexec Service}}
 
 
 
== favourites.xml ==
Contains the items that have been added through the use of '''''Add to favourites'''''.
 
The file is created by {{Kodi}} when adding items to Favourites for the first time, or it can be manually created by the user.
 
{{See|Favourites}}
{{See|Favourites.xml}}
 
 
 
== guisettings.xml ==
Holds the configuration of all the settings in the {{kodi}} Settings pages.
 
{{See|Settings}}
 
It is also possible to transfer these settings out of the settings pages and into the advancedsettings.xml file.
 
:{{big|See: '''[[Advancedsettings.xml#guisettings.xml_Setting_Conversion|Settings Conversion]]}}'''
 
 
 
==Lircmap.xml ==
Created when there are changes to the default Lircmap (Linux Only).
 
{{See|LIRC}}
 
 
 
== mediasources.xml ==
Similar to sources.xml, but used to add custom network locations when browsing in the GUI for a path.
 
'''mediasources.xml''' does not exist by default and is only created when '''Add network location...''' is used in the ''Browse for new share window'' when adding a new Source.
 
{{warning|Editing this file '''does not''' change the paths in your library. The folder paths for library items are stored in the databases.}}
 
An example entry of a network share in the mediasources.xml file
<syntaxhighlight lang="xml">
<mediasources>
    <network>
        <location id="0">smb://192.168.0.20/j/</location>
    </network>
</mediasources>
</syntaxhighlight>
 
 
 
== PartyMode.xsp ==
Contains the rules for the ''Party Mode playlist'' when it has been edited from the default rules. The file does not exist until the ''Party mode playlist'' has been edited.
 
{{See|Party Mode}}
 
 
 
== passwords.xml ==
{{warning|Passwords are stored in unencrypted text format.}}
Contains the passwords for your network shares. These passwords are stored as text which can be easily read by prying eyes.
 
We recommend creating a new user on your network to access your media files only and not any other sensitive files. Use a new and simple password for the new user login.
 
 
 
== profiles.xml ==
Holds data for the Master (default) profile as well as any additional profiles and allows you to switch between profiles.
 
{{See|Profiles}}
 
 
 
== RssFeeds.xml ==
RssFeeds.xml is used to configure the RSS feeds displayed on the home screen.
 
{{see|RssFeeds.xml}}
 
 
 
== sources.xml ==
Defines the paths for Media Sources as displayed in the GUI. The file does not exist until a media Source is added to {{kodi}} for the first time.
 
{{warning|Editing this file '''does not''' change the paths in your library. The folder paths for library items are stored in the databases.}}
 
{{See|Sources.xml}}
{{See|Sources.xml/Types}}
 
 
 
== upnpserver.xml ==
Created when {{kodi}} is enabled as either a uPnP Client or Server.
 
{{See|UPnP}}
 
 
 
== wakeonlan.xml ==
Automatically created when the Wake On Lan setting is enabled. The file can be edited to add or remove options.
 
{{See|Wake on lan}}
 
 


* '''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 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 {{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...).
** '''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 {{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|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 on the home screen.
* '''[[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 {{kodi}} startup.


{{Helix updated}}
{{top}}


{{updated|19}}
[[Category:Karellen]]
[[Category:Settings]]
[[Category:Settings]]
[[Category:Manual]]
[[Category:Advanced topics]]

Revision as of 11:41, 23 March 2021

Home icon grey.png   ▶ Settings ▶ Kodi data folder ▶ Userdata


Introduction

The Userdata folder is a subfolder of the Kodi Data Folder. The folders and files described on this page may vary between releases and forks.

This Userdata folder is used for the Master (default) profile. When creating a new profile, the userdata folder for the new profile is stored in the Profiles folder detailed below.

Modifying items in the Userdata folder is an advanced topic and not recommended. If you find it necessary, create a Backup of the Kodi data folder first.


Location

The Userdata folder is a subfolder of the Kodi Data Folder and is located as shown in the table below.

Operating system Userdata Folder
Android Android/data/org.xbmc.kodi/files/.kodi/userdata/ (see note)
iOS /private/var/mobile/Library/Preferences/Kodi/userdata/
LibreELEC /storage/.kodi/userdata/
Linux ~/.kodi/userdata/
OSMC /home/osmc/.kodi/userdata/
Mac /Users/<your_user_name>/Library/Application Support/Kodi/userdata/
tvOS /private/var/mobile/Library/Preferences/Kodi/userdata/
Windows %APPDATA%\Kodi\userdata
Windows Portable <Install location chosen by you>\portable_data\userdata\
Windows UWP %LOCALAPPDATA%\Packages\XBMCFoundation.Kodi_4n2hpmxwrvr6p\LocalCache\Roaming\Kodi\
Note: In some Android setups the path may be slightly different to the one stated above.



Folders

The following subfolders are located in the Userdata folder:


addon_data

Is the counterpart to the addons folder in the Kodi Data folder.

For addons that require it, this folder holds user specified settings and other data. Not all installed add-ons will have a folder here.


Database

See: Databases


keymaps

This folder is where your customized keymapping files reside (e.g. MyRemote.xml or keyboard.xml)

See: Keyboard controls
See: Keymap


library

The folder where user created library nodes are stored.

If creating a new node, first copy the contents of the identical library folder located in the program installation folder. Once copied across, you are able to modify existing nodes or add new nodes. Using the Node Editor will automatically copy the files across.

If you need to remove a node, open the xml file and add visible="false" to the opening <node> tag. eg <node order="80" type="folder" visible="false">

See: Music nodes
See: Video nodes


peripheral_data

Settings and other data for hardware using the Peripheral API, such as joysticks.


playlists

Playlists are saved in one of the following subfolders.

If using the Kodi interface to create your smart playlist, Kodi will save the playlist to the correct folder. If creating a playlist using an XML editor, ensure the playlist is saved to the correct folder or it will not be available in Kodi.

  • mixed - playlists containing both music and music videos, will show in both the Music and Video Libraries.
  • music - playlists containing music only, will show in the Music Library.
  • video - playlists containing videos only, will show in the Video Library.
See: Playlists


profiles

Available only when one or more new profiles have been created.

New Profiles are created in this folder. Each subfolder is a Profile and contains a replica of the Userdata folder. Depending on which settings you chose during setup, the Profile Userdata folder may contain structure and data or structure only.

See: Profiles


Savestates

Save points for the Games section of Kodi

See: Games


Thumbnails

This is the location of all the cached artwork.

See: Artwork
See: Artwork/Cache


Files

The following files are located in the Userdata folder:


advancedsettings.xml

This file does not exist by default. It must be created by the user.

This file can be used to modify additional settings that are not displayed in the Kodi Settings pages.

See: Advancedsettings.xml


autoexec.py

This file does not exist by default. It must be created by the user.

An autoexec.py file can be used to perform certain actions during startup of Kodi.

Notes
  • From v12 - v18 either the autoexec.py or the Autoexec Service methods can be used (not both).
  • From v19 the autoexec.py feature has been removed for security reasons. Use the Autoexec Service instead and delete the autoexec.py file if one remains from a previous setup.
See: Autoexec Service


favourites.xml

Contains the items that have been added through the use of Add to favourites.

The file is created by Kodi when adding items to Favourites for the first time, or it can be manually created by the user.

See: Favourites
See: Favourites.xml


guisettings.xml

Holds the configuration of all the settings in the Kodi Settings pages.

See: Settings

It is also possible to transfer these settings out of the settings pages and into the advancedsettings.xml file.

See: Settings Conversion


Lircmap.xml

Created when there are changes to the default Lircmap (Linux Only).

See: LIRC


mediasources.xml

Similar to sources.xml, but used to add custom network locations when browsing in the GUI for a path.

mediasources.xml does not exist by default and is only created when Add network location... is used in the Browse for new share window when adding a new Source.

Stop hand.png Editing this file does not change the paths in your library. The folder paths for library items are stored in the databases.


An example entry of a network share in the mediasources.xml file

<mediasources>
    <network>
        <location id="0">smb://192.168.0.20/j/</location>
    </network>
</mediasources>


PartyMode.xsp

Contains the rules for the Party Mode playlist when it has been edited from the default rules. The file does not exist until the Party mode playlist has been edited.

See: Party Mode


passwords.xml

Stop hand.png Passwords are stored in unencrypted text format.

Contains the passwords for your network shares. These passwords are stored as text which can be easily read by prying eyes.

We recommend creating a new user on your network to access your media files only and not any other sensitive files. Use a new and simple password for the new user login.


profiles.xml

Holds data for the Master (default) profile as well as any additional profiles and allows you to switch between profiles.

See: Profiles


RssFeeds.xml

RssFeeds.xml is used to configure the RSS feeds displayed on the home screen.

See: RssFeeds.xml


sources.xml

Defines the paths for Media Sources as displayed in the GUI. The file does not exist until a media Source is added to Kodi for the first time.

Stop hand.png Editing this file does not change the paths in your library. The folder paths for library items are stored in the databases.


See: Sources.xml
See: Sources.xml/Types


upnpserver.xml

Created when Kodi is enabled as either a uPnP Client or Server.

See: UPnP


wakeonlan.xml

Automatically created when the Wake On Lan setting is enabled. The file can be edited to add or remove options.

See: Wake on lan



Return to top