Special protocol - Revision history

Thofficial: Fix capitalization

2025-10-21T10:22:36Z

Fix capitalization

← Older revision		Revision as of 10:22, 21 October 2025
Line 6:		Line 6:

	== Available Paths ==		== Available Paths ==
	Below is a list of commonly used protocols. Further protocols for specific and limited uses can be found on ~~Github~~.		Below is a list of commonly used protocols. Further protocols for specific and limited uses can be found on GitHub.


Line 15:		Line 15:
	\|-		\|-
	\| <code>'''library://music/'''</code>		\| <code>'''library://music/'''</code>
	\| This path points to the Music Library folders and to the ~~file~~ Sources		\| This path points to the Music Library folders and to the File Sources
	\|-		\|-
	\| <code>'''library://video/'''</code>		\| <code>'''library://video/'''</code>
	\| This path points to the Video Library folders and to the ~~file~~ Sources		\| This path points to the Video Library folders and to the File Sources
	\|-		\|-
	\|   * * * * *		\|   * * * * *

Karellen at 23:54, 1 February 2025

2025-02-01T23:54:04Z

Karellen at 21:04, 1 February 2025

2025-02-01T21:04:10Z

← Older revision		Revision as of 21:04, 1 February 2025
Line 1:		Line 1:
	{{mininav\|[[Development]]}}		{{mininav\|[[Development]]}}
	<section begin="intro" />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~~. This helps keep most of the platform mess centralized in the code~~.<section end="intro" />		<section begin="intro" />The "Special Protocol" is Kodi's solution to platform dependent directories. Common directory names are assigned a <code>special://[name]</code> path which is passed around inside Kodi and then translated to the platform specific path before the operating system sees it.<section end="intro" />

	~~Below is a list of commonly used protocols. Further protocols for specific and limited uses can be found on Github.~~



	== Available Paths ==		== Available Paths ==
			Below is a list of commonly used protocols. Further protocols for specific and limited uses can be found on Github.


	{\| class="prettytable"		{\| class="prettytable"
	\|-		\|-
Line 107:		Line 109:
	\| This path points to the video source folders.		\| This path points to the video source folders.
	\|}		\|}



			= Applying Special Protocols =
			Special Protocols are used in the {{Kodi}} File Manager. The below images will guide you through the process.


			<gallery mode="packed" widths="500px" heights="283px">
			File:SettingsOverview-leia.png\| '''Image 1'''- Access File Manager from the Settings page
			File:SpecialProtocol01.jpg\| '''Image 2'''- Select '''Add source'''
			File:SpecialProtocol02.jpg\| '''Image 3'''- Select the '''<none>''' entry
			File:SpecialProtocol03.jpg\| '''Image 4'''- Type in or paste the Special Protocol then select OK
			File:SpecialProtocol04.jpg\| '''Image 5'''- Once you confirm the protocol has been correctly entered, select OK
			</gallery>

			The newly added Special Protocol should now be available in the File Manager listing (image 2).

Karellen at 20:12, 1 February 2025

2025-02-01T20:12:05Z

← Older revision		Revision as of 20:12, 1 February 2025
Line 175:		Line 175:
	[[Category:Development]]		[[Category:Development]]
	[[Category:Advanced topics]]		[[Category:Advanced topics]]
			[[Category:Karellen]]

Karellen at 01:21, 21 April 2024

2024-04-21T01:21:51Z

Show changes

Sundermann: Add webOS

2024-04-20T23:25:46Z

Add webOS

← Older revision		Revision as of 23:25, 20 April 2024
Line 96:		Line 96:
	* '''special://temp''' - /Users/''[username]''/.kodi/temp		* '''special://temp''' - /Users/''[username]''/.kodi/temp
	:: {{Note\|The '.', this directory is hidden so you need to enable hidden files to see it.		:: {{Note\|The '.', this directory is hidden so you need to enable hidden files to see it.

			=== webOS ===
			* '''special://xbmc''' - /media/developer/apps/usr/palm/applications/org.xbmc.kodi
			* '''special://home''' - /media/developer/apps/usr/palm/applications/org.xbmc.kodi/.kodi
			* '''special://temp''' - /media/developer/apps/usr/palm/applications/org.xbmc.kodi/.kodi/temp

	=== Windows ===		=== Windows ===
Line 107:		Line 112:
	* '''special://xbmc''' - Where ever you installed Kodi (MUST be writable).		* '''special://xbmc''' - Where ever you installed Kodi (MUST be writable).
	* '''special://home''' - special://xbmc/portable_data		* '''special://home''' - special://xbmc/portable_data



	== See also ==		== See also ==

SistemaRayoXP: Added "portable_data" to userdata portable path

2021-09-19T21:20:08Z

Added "portable_data" to userdata portable path

← Older revision		Revision as of 21:20, 19 September 2021
Line 106:		Line 106:
	In portable mode, Kodi is entirely self contained, so its install directory must be writable.		In portable mode, Kodi is entirely self contained, so its install directory must be writable.
	* '''special://xbmc''' - Where ever you installed Kodi (MUST be writable).		* '''special://xbmc''' - Where ever you installed Kodi (MUST be writable).
	* '''special://home''' - special://xbmc		* '''special://home''' - special://xbmc/portable_data

Karellen at 05:50, 28 July 2020

2020-07-28T05:50:10Z

← Older revision		Revision as of 05:50, 28 July 2020
Line 95:		Line 95:
	* '''special://home''' - /Users/''[username]''/Library/Application Support/Kodi		* '''special://home''' - /Users/''[username]''/Library/Application Support/Kodi
	* '''special://temp''' - /Users/''[username]''/.kodi/temp		* '''special://temp''' - /Users/''[username]''/.kodi/temp
	:: {{Note\|The '.', this directory is hidden so you need to enable hidden files to see it. ~~See '''[[Mac FAQ]]''' for more info.}}~~		:: {{Note\|The '.', this directory is hidden so you need to enable hidden files to see it.

	=== Windows ===		=== Windows ===
Line 118:		Line 118:
	{{Helix updated}}		{{Helix updated}}

	~~[[Category:Manual]]~~
	[[Category:Add-on development]]		[[Category:Add-on development]]
	[[Category:Skin development]]		[[Category:Skin development]]
	[[Category:Development]]		[[Category:Development]]
	[[Category:Advanced topics]]		[[Category:Advanced topics]]

Karellen at 21:44, 2 August 2018

2018-08-02T21:44:21Z

← Older revision		Revision as of 21:44, 2 August 2018
Line 113:		Line 113:
	* [[Userdata]]		* [[Userdata]]
	* [[Development]]		* [[Development]]
	* [[~~Add-on development~~]]		* [[Opening_Windows_and_Dialogs]]
	* [[Skinning]]

	{{Helix updated}}		{{Helix updated}}

Karellen: add library// entries

2018-07-09T05:31:43Z

add library// entries

← Older revision		Revision as of 05:31, 9 July 2018
Line 1:		Line 1:
	{{mininav\|[[Development]]}}		{{mininav\|[[Development]]}}
	<section begin="intro" />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. This helps keep most of the platform mess centralized in the code.<section end="intro" />		<section begin="intro" />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. This helps keep most of the platform mess centralized in the code.<section end="intro" />


	== Available Paths ==		== Available Paths ==
Line 56:		Line 57:
	\| <code>'''special://logpath'''</code>		\| <code>'''special://logpath'''</code>
	\| This path points to the path where the [[log file]] is saved.		\| This path points to the path where the [[log file]] is saved.
			\|-
			\| <code>'''library://video/'''</code>
			\| This path points to the Video Library folders and to the file Sources
			\|-
			\| <code>'''library://music/'''</code>
			\| This path points to the Music Library folders and to the file Sources
	\|}		\|}



	== Default OS mappings ==		== Default OS mappings ==
			* Bulleted list item

	* Bulleted list item
	=== Android ===		=== Android ===
	* '''special://xbmc''' - /data/data/org.xbmc.kodi/cache/apk/assets/		* '''special://xbmc''' - /data/data/org.xbmc.kodi/cache/apk/assets/
Line 98:		Line 107:
	* '''special://xbmc''' - Where ever you installed Kodi (MUST be writable).		* '''special://xbmc''' - Where ever you installed Kodi (MUST be writable).
	* '''special://home''' - special://xbmc		* '''special://home''' - special://xbmc



	== See also ==		== See also ==

← Older revision		Revision as of 23:54, 1 February 2025
Line 128:		Line 128:


	== Default OS mappings ==		= Default OS mappings =
	* Bulleted list item		* Bulleted list item

	=== Android ===		== Android ==
	* '''special://xbmc''' - /data/data/org.xbmc.kodi/cache/apk/assets/		* '''special://xbmc''' - /data/data/org.xbmc.kodi/cache/apk/assets/
	* '''special://home''' - /sdcard/Android/data/org.xbmc.kodi/files/.kodi/		* '''special://home''' - /sdcard/Android/data/org.xbmc.kodi/files/.kodi/
	* '''special://temp''' - /sdcard/Android/data/org.xbmc.kodi/files/.kodi/temp/		* '''special://temp''' - /sdcard/Android/data/org.xbmc.kodi/files/.kodi/temp/

	=== iOS ===		== iOS ==
	==== Apple TV 2 (black) ====		=== Apple TV 2 (black) ===
	* '''special://xbmc''' - /private/var/stash/Applications/Kodi.frappliance/KodiData/KodiHome		* '''special://xbmc''' - /private/var/stash/Applications/Kodi.frappliance/KodiData/KodiHome
	* '''special://home''' - /private/var/mobile/Library/Preferences/Kodi		* '''special://home''' - /private/var/mobile/Library/Preferences/Kodi
	* '''special://temp''' - /private/var/mobile/Library/Preferences/Kodi/temp		* '''special://temp''' - /private/var/mobile/Library/Preferences/Kodi/temp

	==== iDevice ====		=== iDevice ===
	* '''special://xbmc''' - /Applications/Kodi.app/KodiData/KodiHome {{highlight\|''<- Symbolic link, but the real path has some random characters in it.''}}		* '''special://xbmc''' - /Applications/Kodi.app/KodiData/KodiHome {{highlight\|''<- Symbolic link, but the real path has some random characters in it.''}}
	* '''special://home''' - /private/var/mobile/Library/Preferences/Kodi		* '''special://home''' - /private/var/mobile/Library/Preferences/Kodi
	* '''special://temp''' - private/var/mobile/Library/Preferences/Kodi/temp		* '''special://temp''' - private/var/mobile/Library/Preferences/Kodi/temp

	=== Linux ===		== Linux ==
	* '''special://xbmc''' - /usr/share/kodi when installed from a binary package (ie PPA, rpm, deb, etc). /usr/local/share/kodi when compiled (unless you specify an alternate prefix)		* '''special://xbmc''' - /usr/share/kodi when installed from a binary package (ie PPA, rpm, deb, etc). /usr/local/share/kodi when compiled (unless you specify an alternate prefix)
	* '''special://home''' - /home/''[username]''/.kodi		* '''special://home''' - /home/''[username]''/.kodi
	:: {{Note\|The '.', this directory is hidden so you may need to enable hidden files in your file manager to see it.}}		:: {{Note\|The '.', this directory is hidden so you may need to enable hidden files in your file manager to see it.}}

	=== Mac OS X ===		== Mac OS X ==
	* '''special://xbmc''' - /Applications/Kodi.app/Contents/Resources/Kodi		* '''special://xbmc''' - /Applications/Kodi.app/Contents/Resources/Kodi
	* '''special://home''' - /Users/''[username]''/Library/Application Support/Kodi		* '''special://home''' - /Users/''[username]''/Library/Application Support/Kodi
Line 158:		Line 158:
	:: {{Note\|The '.', this directory is hidden so you need to enable hidden files to see it.}}		:: {{Note\|The '.', this directory is hidden so you need to enable hidden files to see it.}}

	=== webOS ===		== webOS ==
	* '''special://xbmc''' - /media/developer/apps/usr/palm/applications/org.xbmc.kodi		* '''special://xbmc''' - /media/developer/apps/usr/palm/applications/org.xbmc.kodi
	* '''special://home''' - /media/developer/apps/usr/palm/applications/org.xbmc.kodi/.kodi		* '''special://home''' - /media/developer/apps/usr/palm/applications/org.xbmc.kodi/.kodi
	* '''special://temp''' - /media/developer/apps/usr/palm/applications/org.xbmc.kodi/.kodi/temp		* '''special://temp''' - /media/developer/apps/usr/palm/applications/org.xbmc.kodi/.kodi/temp

	=== Windows ===		== Windows ==
	This assumes your Windows install drive is C:. Replace as necessary.		This assumes your Windows install drive is C:. Replace as necessary.
	* '''special://xbmc''' - C:\Program Files\Kodi		* '''special://xbmc''' - C:\Program Files\Kodi
Line 169:		Line 169:
	* '''special://home''' - C:\Users\''[username]''\AppData\Roaming\Kodi		* '''special://home''' - C:\Users\''[username]''\AppData\Roaming\Kodi

	==== Portable Mode ====		=== Portable Mode ===
	In portable mode, Kodi is entirely self contained, so its install directory must be writable.		In portable mode, Kodi is entirely self contained, so its install directory must be writable.
	* '''special://xbmc''' - Where ever you installed Kodi (MUST be writable).		* '''special://xbmc''' - Where ever you installed Kodi (MUST be writable).