Files
DevOps/Kodi/Advanced settings/Special protocol.md
2025-11-11 19:36:32 +01:00

45 lines
12 KiB
Markdown

# Special protocol
The "Special Protocol" is Kodi's solution to platform dependent directories. Common directory names are assigned a `special://[name]` path which is passed around inside Kodi and then translated to the platform specific path before the operating system sees it.
Available Paths
Below is a list of commonly used protocols. Further protocols for specific and limited uses can be found on GitHub.
| Path<br> | Description<br> |
|----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| library://music/<br> | This path points to the Music Library folders and to the File Sources<br> |
| library://video/<br> | This path points to the Video Library folders and to the File Sources<br> |
| &#160; * * * * *<br> | |
| special://cdrips<br> | This path contains the tracks from CDs you rip with Kodi. You will be asked to specify this directory the first time you rip a CD.<br> |
| special://database<br> | This path contains the database files Kodi uses to store library info. Normally special://masterprofile/Database.<br> |
| special://home<br> | Leads to the Kodi_data_folder.<br> |
| special://home/addons<br> | Directory where addons are installed after installation. Does not include default addons installed with Kodi.<br> |
| special://home/media<br> | Leads to the \media\ folder in the Kodi_data_folder.<br> |
| special://home/media/Fonts<br> | Directory where user defined fonts are located.<br> |
| special://logpath<br> | This path points to the path where the log file is saved.<br> |
| special://masterprofile<br> | Kodi's main configuration directory. Normally located at special://home/userdata, this directory contains global settings and sources, as well as any Kodi profile directories. Normally special://home/userdata<br> |
| special://musicartistsinfo<br> | This path points to the Artist_information_folder if one has been set.<br> |
| special://musicplaylists<br> | This path contains saved music playlists. Normally special://profile/playlists/music.<br> |
| special://profile/playlists<br> | Parent folder of special://videoplaylists and special://musicplaylists and will allow access to the Mixed playlist folder<br> |
| special://profile/addon_data<br> | This path leads to the addon_data folder located in the Userdata folder. It contains user modified settings for installed add-ons.<br> |
| special://profile<br> | Kodi's currently active profile directory. This directory points at special://masterprofile/profile_name (or special://masterprofile if no profile is in use) and contains per profile overrides for settings and sources.<br> |
| special://recordings<br> | This path contains saved PVR recordings.<br> |
| special://screenshots<br> | This path contains Kodi screen shots. You will be asked to specify this directory the first time you take a screen shot.<br> |
| special://skin<br> | This path points to the currently active skin's root directory.<br> |
| special://subtitles<br> | User defined custom subtitle path. Set it in Video Settings.<br> |
| special://temp<br> | Kodi's temporary directory. This path is used to cache various data during normal usage. Unless you need the log, nothing in this directory is detrimental to Kodi's operation. Normally special://home/temp<br> |
| special://temp/fonts<br> | A temporary font path where MKV fonts are extracted and temporarily stored.<br> |
| special://thumbnails<br> | This path contains cached thumbnails. Normally special://masterprofile/Thumbnails<br> |
| special://userdata<br> | Alias from special://masterprofile.<br> |
| special://videoplaylists<br> | This path contains saved video playlists. Normally special://profile/playlists/video.<br> |
| special://xbmc<br> | Kodi's installation root directory. This path is read-only contains the Kodi binary, support libraries and default configuration files, skins, scripts and plugins. Users should not modify files or install addons in this directory.<br>Note: The special://xbmc/ path is still valid . special://kodi/ does not exist yet.<br> |
| special://xbmc/media/Fonts<br> | Directory where Kodi bundled fonts files are located.<br> |
| special://xbmc/system<br> | This path points to the System folder in Kodi's installation root directory.<br> |
| special://xbmcbinaddons<br> | This path points to the addon folder in Kodi's installation root directory.<br> |
| &#160; * * * * *<br> | |
| sources://music<br> | This path points to the music source folders.<br> |
| sources://video<br> | This path points to the video source folders.<br> |