Official Kodi Wiki - User contributions [en]

Userdata

2024-01-20T07:40:14Z

Kambala: fix name of macOS

{{mininav|[[Settings]]|[[Kodi data folder]]}}

= Introduction =
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" />
The Userdata folder is a subfolder of the '''''[[Kodi data folder|Kodi Data Folder]]''''' and is located as shown in the table below.
{| class="prettytable"
! scope="row" ! style="width:150px; background-color:#dbdf26; | Operating system
! scope="row" ! style="width:700px; background-color:#dbdf26; | Userdata Folder
|-
| '''Android''' || {{userdata|Android}}
|-
| '''iOS''' || {{userdata|iOS}}
|-
| '''LibreELEC''' || {{userdata|LibreELEC}}
|-
| '''Linux''' || {{userdata|Linux}}
|-
| '''macOS''' || {{userdata|Mac}}
|-
| ''' Nvidia Shield (SMB) || {{userdata|Nvidia Shield (SMB)}}
|-
| '''OSMC''' || {{userdata|OSMC}}
|-
| '''tvOS''' || {{userdata|iOS}}
|-
| '''Windows''' || {{userdata|Windows}}
|-
| '''Windows Portable''' || <''Install location chosen by you''>\portable_data\userdata\
|-
| '''Windows via Microsoft Store''' || {{userdata|Windows UWP}}
|-
| '''Windows Xbox''' || {{userdata|Windows UWP}}
|}
:'''Note:''' In some Android setups the path may be slightly different to the one stated above.
<section end="location all" />

= Folders =
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}}

{{top}}

{{updated|20}}
[[Category:Karellen]]
[[Category:Settings]]

Kodi data folder

2024-01-20T07:39:29Z

Kambala: fix name of macOS

{{mininav||[[Settings]]}}

= Introduction =
<section begin="KodiDataFolder" />Once {{Kodi}} is installed, all subsequent changes and usage data are saved in the [[Kodi data folder]] which is the parent folder of the '''[[Userdata]]''' folder. When you install a new skin or an add-on it is installed in this folder. Playlists and edits to Nodes are stored here, and the library databases are created here along with the artwork cache and any other changes you make during your travels with {{kodi}}.

Basically anything you add or modify, after installation, occurs in this folder and sub-folders.<section end="KodiDataFolder" />

:{{see also|Backup}}

= Location =
The location of this folder varies between operating systems and the table below lists their locations.
<section begin="KodiDataFolderLocation" />
{| class="prettytable"
! scope="row" ! style="width:150px; background-color:#a1f5e4; | Operating system
! scope="row" ! style="width:700px; background-color:#a1f5e4; | Kodi Data folder path
|-
| '''Android''' || Android/data/org.xbmc.kodi/files/.kodi
|-
| '''iOS''' || /private/var/mobile/Library/Preferences/Kodi
|-
| '''LibreELEC''' || /storage/.kodi
|-
| '''Linux''' || ~/.kodi
|-
| '''macOS''' || /Users/<your_user_name>/Library/Application Support/Kodi
|-
| '''Nvidia Shield (SMB)''' || smb://<nvidiashieldurl>/internal/Android/data/org.xbmc.kodi/files/.kodi
|-
| '''OSMC''' || /home/osmc/.kodi
|-
| '''tvOS''' || /private/var/mobile/Library/Preferences/Kodi
|-
| '''WebOS''' || /media/developer/apps/usr/palm/applications/org.xbmc.kodi/.kodi
|-
| '''Windows''' || C:\Users\<''YourUsername''>\AppData\Roaming\Kodi
|-
| '''Windows Portable''' || <''Install location chosen by you''>\portable_data
|-
| '''Windows Xbox''' || %LOCALAPPDATA%\Packages\XBMCFoundation.Kodi_4n2hpmxwrvr6p\LocalCache\Roaming\Kodi\
|}

:'''Note:''' In some Android setups the path may be slightly different to the one stated above.
<section end="KodiDataFolderLocation" />

= Folders =
The following are the sub-folders in the Kodi Data folder. Forks of {{kodi}} may have additional folders not covered here.

== addons ==
Any add-on installed in {{kodi}} is installed in this folder along with any subsequent updates.

Many add-ons have an additional folder located in '''\userdata\addon_data'''. This folder contains data created due to user preference or usage. eg, changed settings, channel line-up, etc

{{kodi}} comes pre-installed with a series of default add-ons that are required for basic functioning, such as language add-ons, scrapers, default skins etc. These pre-installed add-ons are located in the Programs folder along with the remainder of the Kodi program files. When these pre-installed add-ons receive a subsequent update, the update is saved in this folder and the original add-on remains but is ignored.

{{see|Add-ons}}

== cache ==
The cache folder and its subfolders are used as temporary storage for some {{kodi}} functions. They can be used by:
* Scrapers to cache results and reduce API calls to remote sites.
* Caching navigation nodes that are slow to load in larger libraries
* File view of non-library items that entails tag reading which can be slow

This folder is self-cleaning with items generally kept for 3 hours for the python Pickle cache, and 24 hours or more for scraper caches.

== media ==
The media folder may contain other sub-folders that may need to be created manually.

=== Fonts ===
The ''Fonts'' sub-folder, can be used to add additionals subtitle fonts, which can be used as alternative to the default Kodi font.
We strongly suggest to avoid adding more than 100 fonts in this folder, otherwise you may experience of playback slowdowns and system instability.

If your intent is to provide a big library of fonts as support to subtitles format type like ASS/SSA,
we suggest you to install these fonts in your operative system and avoid to use this folder to store them,
some Kodi distributions could provide a special folder, where you can place your own font library.

{{note|On Kodi 20 - At each startup Kodi will check if files have been added and/or removed in this folder, and then rebuilds the font cache if necessary.
When the font cache has been builded will be saved a <code>fontcache.xml</code> file in this folder. To optimise Kodi startup, please do not delete this file.}}

== system ==
Not used.

== userdata ==
{{see|Userdata}}

= Files =
For {{kodi}} installations on Windows, the log files are saved in this folder. (For location of log files in other platforms, see: ''[[Template:LogfilePath|Log file Paths]]'')

; \kodi.log
; \kodi.old.log

{{#lst:Log_file|WhichLog}}

:See '''[[Log_file|Debug Log]]'''

{{top}}
{{updated|20}}

[[Category:Karellen]]
[[Category:Settings]]

Keymap

2024-01-20T07:38:28Z

Kambala: fix path to XBMC_keytable.cpp

{{mininav| [[Remote controls]] }}
<section begin="intro" />Keymaps are XML base files that define the mappings of keys (keyboard keys, mouse/remote/joysticks buttons and more) to Kodi actions.<section end="intro" />

== Customizing keymaps through the GUI ==
{{main|Add-on:Keymap Editor}}
Users can customize keymaps for remotes in GUI by using the community [[Add-on:Keymap Editor|Keymap Editor]] add-on.

== Location of keymaps ==
User modified keymap files must be stored in the "'''keymaps'''" folder in the [[userdata]] folder:
{{#lst:userdata|location all}}

=== Defaults ===
Default keymaps are included when Kodi is installed, but users should not edit those install files directly. Instead, place user modified keymaps in the [[userdata]]/keymaps/ directory.

Kodi can process multiple keymap files and does so like this:

* All *.xml files from the default install settings and userdata/keymaps/ folders are applied as keymaps.
* All *.xml files are processed in alphabetical order.
* Keymaps defined in an .xml file add to or override mappings in previous .xml file.
* Keymaps defined in the userdata folder add to or override mappings in the global keymap.

By default there will be no files in these locations, so grab one from the link below to make a new one/over-ride:

* ''' https://github.com/xbmc/xbmc/tree/master/system/keymaps '''
* ''' https://github.com/kodi-game/peripheral.joystick/tree/master/peripheral.joystick/resources/buttonmaps/xml '''

== Structure ==

There is one '''global''' keymap and several '''window'''-specific keymaps.<br />
Kodi falls back to the global map when the window-specific map hasn't bound the key being pressed.

The format of keymapping files is as follows:

<syntaxhighlight lang=xml enclose="div">
<keymap>
<global>
<gamepad>
<A>Select</A>
[...]
</gamepad>

<remote>
<select>Select</select>
[...]
</remote>

<keyboard>
<enter>Select</enter>
[...]
</keyboard>

<mouse>
<leftclick>Select</leftclick>
[...]
</mouse>

<universalremote>
<obc25>ActivateWindow(MyMusic)</obc25>
[...]
</universalremote>

<joystick name="PLAYSTATION(R)3 Controller (00:1B:FB:F6:E0:F2)">
<button id="15">Select</button>
[...]
</joystick>
</global>

<Home>
[...]
</Home>

[...]

</keymap>
</syntaxhighlight>

As you can see, it's divided into a <global> section, and a number of window sections (such as <Home>).<br />
A list of the available window names can be seen [[Window IDs|here]]. The WINDOW can also be a custom window formatted as <windowId#> (e. g. <window1113>). <br />
Each of these sections can contain Gamepad, Remote, Keyboard, Universal Remote, and custom Joystick sections.

The format for mapping a particular key under one of these device types is as follows:
<syntaxhighlight lang=xml enclose="div">
<keyname>action</keyname>
</syntaxhighlight>

== Keynames ==
Depending on your device you will need to use a specific "keyname".
=== Gamepads ===
An up to date list of the available actions can be found in the source code of Kodi in [https://github.com/xbmc/xbmc/blob/master/xbmc/input/ButtonTranslator.cpp ButtonTranslator.cpp] where the ''TranslateGamepadString()'' function does the work.

'''Example:'''
<syntaxhighlight lang=xml enclose="div">
<gamepad>
<A>Select</A>
</gamepad>
</syntaxhighlight>

=== Remotes ===
An up to date list of IR-remote button names can be found in the source code of Kodi [https://github.com/xbmc/xbmc/blob/master/xbmc/input/IRTranslator.cpp IRTranslator.cpp]. See the method TranslateString().

The available actions are discussed in section [[Keymap#Actions|Actions]].

{{Note|Some remotes (e.g. FLIRC) are actually seen as "keyboards". Those will need to use the <keyboard> tag instead.}}

'''Example:'''
<syntaxhighlight lang=xml enclose="div">
<remote>
<play>Play</play>
</remote>
</syntaxhighlight>

=== Universal Remotes ===
To map Universal Remote buttons using the RCA infrared protocol, you may add '''<universalremote>''' sections to keymap.xml.<br />
In this case, the tags used are <obc#> where # is the original button code (OBC) of the button.<br />
You would put it inside a <universalremote> section in the <window> or <global> sections.

'''Example:'''
<syntaxhighlight lang=xml enclose="div">
<universalremote>
<obc148>Stop</obc148>
</universalremote>
</syntaxhighlight>

:Will map ''Stop Playback'' to the RCA DVD repeat button <obc148>, which is not used by Kodi by default.

* '''Note:''' ensure that the <universalremote> section is '''NOT''' added 'within' the <remote> section - it can appear before or after. Otherwise it will not be recognised and produces errors in the logfile.

Remote keys can be observed in the kodi.log file ('''~/.kodi/temp/kodi.log''' on Linux) when debugging is enabled in the GUI (Settings -> debugging ). The list of pre-defined OBC codes can be found at [https://github.com/xbmc/xbmc/blob/master/xbmc/input/XBIRRemote.h XBIRRemote.h].

=== Keyboards ===
Valid keyboard keymap syntax includes <keyname>, <key id="">, and <keyname mod="">.

Mapping for arbitrary key codes can be configured using the following syntax:
<syntaxhighlight lang=xml enclose="div">
<key id="123">
</syntaxhighlight>
where "123" is replaced by the key code.

A full list of valid keynames can be found in
* the [https://github.com/xbmc/xbmc/blob/master/xbmc/input/keyboard/XBMC_keytable.cpp XBMC_keytable.cpp] source code file
* or in [[List_of_keynames]].<br />

'''Example:'''
<syntaxhighlight lang=xml enclose="div">
<keyboard>
<key id="123">action</key> -- id is the keys keycode. >
<a mod="shift,alt">action</a> -- corresponds to shift-alt-a, the mod="" syntax is enabled since build 26407. >
<space>action</space> -- for a complete list of valid keynames, see ButtonTranslator.cpp or List of Kodi keynames above. >
</keyboard>
</syntaxhighlight>

;Modifiers
* shift
* alt
* ctrl

=== Mouse ===

As this highly depends on the mouse you are using and which kind of buttons are available, we only mention the most common buttons on a mouse:
<syntaxhighlight lang=xml enclose="div">
<keymap>
<mouse>
<global>
<leftclick>...</leftclick>
<middleclick>...</middleclick>
<rightclick>...</rightclick>
<wheelup>...</wheelup>
<wheeldown>...</wheeldown>
</global>
</mouse>
</keymap>
</syntaxhighlight>

'''''Example for changing the volume while on MusicOSD (On Screen Display) window using the mouse wheel'''''

<syntaxhighlight lang=xml enclose="div">
<keymap>
<MusicOSD>
<mouse>
<wheeldown>VolumeDown</wheeldown>
<wheelup>VolumeUp</wheelup>
</mouse>
</MusicOSD>
</keymap>
</syntaxhighlight>

=== Custom Joystick Configuration ===
See [[HOW-TO:Modify_joystick.xml]].

== Long-press ==
{{note| Longpress seems to only be working on keyboard keymaps at the moment }}
Depending on the device, many remotes, keyboards, and gamepads can use the long-press modifier. This allows a button to do a separate action when held for a short period of time. The syntax for this is as follows:

<pre><button mod="longpress">action</button></pre>

Not all devices will correctly work with the longpress action, but most should.

{{Note|Long-press will disable keyrepeat for that key/window.}}

=== Removing a long-press action from a default keymap ===
If you want to simply remove a long-press action, rather than override it, you can place an empty long-press tag in a keymap. This also has the effect of re-enabling keyrepeat for the short-press action.

For example, this will remove the context menu action from the default keyboard.xml keymap:

<pre>
<keymap>
<global>
<keyboard>
<return mod="longpress"></return>
<enter mod="longpress"></enter>
</keyboard>
</global>
</keymap>
</pre>

== Commands ==
The most recent available actions can be found in [https://github.com/xbmc/xbmc/blob/master/xbmc/input/actions/ActionIDs.h ActionIDs.h].

For those debugging integer action codes from the debug log, the mapping of action codes to constants is in [https://github.com/xbmc/xbmc/blob/master/xbmc/input/Key.h Key.h]

In addition to the following actions, you can also use '''[[Built-in scripting]]''' in Kodi.

=== Actions ===
{{Main|Action IDs}}
{{#lst:Action IDs|Action IDs}}

=== Functions ===
{{main|List of built-in functions|Built-in scripting}}
{{#lst:List of built-in functions|functions}}

== Windows ==
{{main|Window IDs}}
{{#lst:Window IDs|main content}}

== Additional keys ==
Other keys that can be mapped to actions.

=== Media keyboards/remotes ===
* browser_back
* browser_forward
* browser_refresh
* browser_stop
* browser_search
* browser_favorites
* browser_home
* volume_mute
* volume_down
* volume_up
* next_track
* prev_track
* stop
* play_pause
* launch_mail
* launch_media_select
* launch_app1
* launch_app2
* play
* pause
* fastforward
* rewind
* channelup
* channeldown

=== Mouse actions ===
* leftclick
* rightclick
* middleclick
* doubleclick
* wheelup
* wheeldown
* mousemove
* mousedrag
* mousedragstart
* mousedragend
* mouserdrag - right button drag
* mouserdragstart - start of right button drag
* mouserdragend - end of right button drag

== Examples and pre-made keymaps ==
{{see|:Category:Remotes}}

== See also ==
* [[Remote controls]]
* [[Keyboard controls]]
* [[Add-on development]]
* [[Python development]]
* [[Skinning]]

{{Updated|16}}

[[Category:Remotes]]
[[Category:Settings]]

HOW-TO:Install Kodi on Apple TV 4 and 5 (HD and 4K)

2023-06-18T10:29:13Z

Kambala: /* Install on a jailbroken Apple TV */

{{mininav|[[IOS]]|page={{FULLPAGENAME}} }}

== Install from Windows (only for Apple TV 4) ==

=== What about the Apple TV 4K? ===

{{warning|Unfortunately the Apple TV 4K does not have a USB-C. If you are not jailbroken the only official way to sideload Kodi on your device is to use Xcode on macOS with a wireless connection.
To get macOS on you computer you can use a virtual machine or check for building an [[w:Hackintosh|hackintosh]], but we will not discuss this here.}}

=== Prerequisites ===

{{warning|Cydia Impactor is still a work-in-progress, There might be some bugs that you face while installing Kodi. It is not for the faint of heart.
This method also requires that Kodi be re-installed every '''7 days''' if you are using a free Apple developer account.}}

* [http://cydiaimpactor.com/ Cydia Impactor]
* Windows 7 or higher
* Latest version of iTunes is needed to be installed.
* Kodi .deb file for tvOS: [http://mirrors.kodi.tv/test-builds/darwin/tvos/kodi-20180227-4a25e62-yab-tvos.deb Kodi 17.6 from Memphiz YAB branch (old but stable)] '''OR''' [http://mirrors.kodi.tv/nightlies/darwin/tvos/ latest Kodi 19 nightly build (it's an alpha version...)]
* A USB-C cable, without that, you can't connect your Apple TV with computer

=== Converting deb into ipa ===

Before beginning the installation, you have to convert .deb file of Kodi into .ipa. That is because Cydia Impactor only accepts .ipa files and not .deb files. If you already know how to convert .deb into .ipa, you can skip to the installation below.

*You will need to [http://www.7-zip.org/download.html/ Download 7-zip] and install it in your PC

'''Follow the steps given below and you will be able to convert .deb file into .ipa file.'''

<gallery widths="225px">
File:Convert-.deb-file-into-.ipa-file-on-windows-pc1.jpg|'''Step 1:''' Right Click on .deb file of Kodi that you downloaded on your PC and Select 7-zip > Extract files. Click OK in the next Window.
File:Convert-.deb-file-into-.ipa-file-on-windows-pc3.jpg|'''Step 2:''' Open the resulting Folder and you will find data.tar file inside. Simply extract data.tar file with Right Click > 7-zip > Extract Files.
File:Convert-.deb-file-into-.ipa-file-on-windows-pc4.jpg|'''Step 3:''' Now you should have data folder and data.tar file in the folder.
File:Convert-.deb-file-into-.ipa-file-on-windows-pc5.jpg|'''Step 4:''' Go inside the data folder and open Applications folder. Here you will find a folder named Kodi.app.
File:Convert-.deb-file-into-.ipa-file-on-windows-pc6.jpg|'''Step 5:''' Here create a new folder and name it “Payload” without quotes. Now you should have 2 folders. Payload and Kodi.app folder. Make sure that the P is capital in Payload.
File:Convert-.deb-file-into-.ipa-file-on-windows-pc7.jpg|'''Step 6:''' Now simply drag the Kodi.app folder and drop it on top of the Payload folder. In other words, copy kodi.app and paste it inside Payload folder.
File:Convert-.deb-file-into-.ipa-file-on-windows-pc8.jpg|'''Step 7:''' Next you have to Right-click the Payload folder and Click 7-zip > Add to archive option.
File:Convert-.deb-file-into-.ipa-file-on-windows-pc9.jpg|'''Step 8:''' A new window will pop up. Here you have to make sure that the Archive format is set to zip and name the archive ending with .ipa . Something like Kodi.ipa. After that click OK. <br> Now you should have your kodi.ipa file ready for installation.
</gallery>[https://www.drgeeky.com/convert-deb-file-into-ipa-file-for-sideloading-cydia-apps/ Source]

=== Install Kodi on your Apple TV ===

'''Connect your Apple TV 4 with power and make sure that it is turned ON before proceeding.'''

<gallery widths="225px">
File:1-USB-C-on-Apple-TV-4.jpg|'''Step 1:''' Connect your Apple TV4 with your computer, and make sure that it is turned ON. If iTunes or some other program pops up then close that first.
File:install-kodi-on-iPhone-without-jailbreak-and-XCode1.jpg|'''Step 2:''' Extract the Impactor zip file somewhere in your computer and Open Impactor.exe. Don’t select “Run as Administrator” for Cydia Impactor.
File:install-kodi-on-iPhone-without-jailbreak-windows2.jpg|'''Step 3:''' Make sure that your Apple TV is detected by Cydia Impactor. After that Drag and drop the Kodi.ipa file in Cydia Impactor.
File:install-kodi-on-iPhone-without-jailbreak-windows3.jpg|'''Step 4:''' Cydia Impactor will ask you to Enter your Apple ID. Enter a Valid Apple ID here and click OK Cydia Impactor will start installing Kodi on your Apple TV.
File:Kodi-Apple-TV-1024x570.jpg|'''Step 5:''' Wait for the installation to complete. Once done, simply look for Kodi icon on your Apple TV 4 main screen and Now you can open it.
</gallery>
{{notice|If you are using a free Apple developper account you will need to do this step every 7 days, so keep your IPA file on your computer}}
[https://www.drgeeky.com/install-kodi-apple-tv-without-mac-using-windows/ Source]

== Install from Mac ==

=== Prerequisites ===

* [http://dantheman827.github.io/ios-app-signer/ iOS App Signer]
* An iCloud account (required to download Xcode and to obtain your signing certificate and the provisioning profile)
* Xcode (you can download it directly from your Mac App Store)
* Kodi .deb file for tvOS: [http://mirrors.kodi.tv/test-builds/darwin/tvos/kodi-20180227-4a25e62-yab-tvos.deb Kodi 17.6 from Memphiz YAB branch (old but stable)] '''OR''' [http://mirrors.kodi.tv/nightlies/darwin/tvos/ latest Kodi 19 nightly build (it's an alpha version...)]
* (optional) A USB-C cable if you have the Apple TV 4 (but just like the Apple TV 4K, the Apple TV 4 can also communicates wirelessly)

=== Connect your device ===

If you have an Apple TV 4 and a USB-C cable you can power on your device and plug in with your Mac.
Else if you have an Apple TV 4K or an Apple TV 4 without a USB-C cable you will need to pair your device wirelessly with Xcode.
You can follow the step-by-step guide below.

<gallery widths="225px">
File:Pair atv4 1bis.png|'''Step 1:''' On your Apple TV open "Settings".
File:Pair atv4 2.png|'''Step 2:''' Open "Remotes and Devices".
File:Pair atv4 3.png|'''Step 3:''' Open "Remote App and Devices".
File:Pair atv4 4.png|'''Step 4:''' Now keep your Apple TV at this screen and take your Mac.
File:Pair atv4 5.png|'''Step 5:''' Launch Xcode and then navigate to "Window" --> "Devices and Simulators" from the menu bar on top.
File:Pair atv4 6.png|'''Step 6:''' Select your Apple TV on the left panel and click "Pair".
File:Pair atv4 7.png|'''Step 7:''' Fill the verification code that appear on your Apple TV screen and click on "Connect". Your device is now paired with Xcode!
</gallery>

=== Connect your Apple account in Xcode ===

Follow the step-by-step guide below in order to connect your iCloud/Apple account in Xcode.

<gallery widths="225px">
File:Connect icloud account 1.png|'''Step 1:''' Launch Xcode and open "Preferences" from the menu bar on top.
File:Connect icloud account 2.png|'''Step 2:''' Open the "Accounts" tab and add an account with the "+" button.
File:Connect icloud account 3.png|'''Step 3:''' Choose "Apple ID" then click "Continue".
File:Connect icloud account 4.png|'''Step 4:''' Fill in your Apple account credentials then click "Next".
File:Connect icloud account 5.png|'''Step 5:''' Now your Apple account is linked with Xcode!
</gallery>

=== Generate Kodi IPA file from deb file ===

'''If you have a free Apple developper account (this is usually the case if you are a "lambda" user) please follow the section [[#.28option_A.29_FREE_Apple_dev_account|FREE Apple dev account]], else if you have a paid developper account (99$/year) please follow the [[#.28option_B.29_PAID_Apple_dev_account|PAID Apple dev account]] section.'''

==== (option A) FREE Apple dev account without [https://streambuzz.net/apple-tv-top-shelf/ Top Shelf] ====

{{notice|If you are using a free Apple developper account you will need to re-sign and re-install Kodi every 7 days and the [https://streambuzz.net/apple-tv-top-shelf/ Top Shelf] feature will not work}}

Follow the step-by-step guide below in order to (i) obtain a valid signing certificate and provisioning profile for your Kodi app and (ii) pack and sign Kodi ''.deb'' file in an ''.ipa'' file

<gallery widths="225px">
File:Generata ipa atv free 1.png|'''Step 1:''' Open Xcode and click on "Create a new Xcode project".
File:Generata ipa atv free 2.png|'''Step 2:''' Choose "tvOS" and "Single View App" then click on "Next".
File:Generata ipa atv free 3.png|'''Step 3:''' Fill the "Product Name" with "kodi", choose your Apple account name for the team, choose your name for the "Organization Name" and "com.yourusername" (without any space) for your "Organization identifier". Then click on "Next".
File:Generata ipa atv free 4.png|'''Step 4:''' Finally choose a location for the Xcode project then click on "Create".
File:Generata ipa atv free 5.png|'''Step 5:''' Your Xcode project is now alive, open the devices list by clicking on the target device on the top left.
File:Generata ipa atv free 6.png|'''Step 6:''' Choose your your "real" connected Apple TV. Also, check for a "Fix issue" button on the signing panel, if this button is present click on it. Now you can close your Xcode window.
File:Generata ipa atv free 7.png|'''Step 7:''' Now open iOS App Signer, click on "Browse" and choose the Kodi DEB file, select the signing certificate corresponding to your Apple account, select the provisioning profile corresponding to the organization identifier that you have previously chosen, then click on "Start".
File:Generata ipa atv free 8.png|'''Step 8:''' Click on "Save" and wait until the Kodi IPA file appears in the same folder as the DEB file.
</gallery>

==== (option B) PAID Apple dev account with [https://streambuzz.net/apple-tv-top-shelf/ Top Shelf] ====

During the step-by-step guide below you will need to extract the <code>.deb</code> file and also a <code>.tar.xz</code> file, to do that you can use an extractor app like [https://theunarchiver.com The Unarchiver], or also a Terminal with the command:
* <code>ar -p kodi-tvos.deb data.tar.xz | tar -xf -</code>, new directory '''Applications''' will appear where you can find Kodi.app

<gallery widths="225px">
File:Generata ipa atv paid 1.png|'''Step 1:''' Open Xcode and click on "Create a new Xcode project".
File:Generata ipa atv paid 2.png|'''Step 2:''' Choose "tvOS" and "Single View App" then click on "Next".
File:Generata ipa atv paid 3.png|'''Step 3:''' Fill the "Product Name" with "kodi", choose your Apple account name for the team, choose your name for the "Organization Name" and "com.yourusername" (without any space) for your "Organization identifier". Then click on "Next".
File:Generata ipa atv paid 4.png|'''Step 4:''' Finally choose a location for the Xcode project then click on "Create".
File:Generata ipa atv paid 5.png|'''Step 5:''' Your Xcode project is now alive, open the devices list by clicking on the target device on the top left.
File:Generata ipa atv paid 6.png|'''Step 6:''' Choose your your "real" connected Apple TV. Also, check for a "Fix issue" button on the signing panel, if this button is present click on it. Now you can close your Xcode window.
File:Generata ipa atv paid 6bis.png|'''Step 7:''' Click on "Capabilities", then enable "App Groups", click on the "+" button and create a new group group.com.yourusername.kodi, and finally enable this group.
File:Generata ipa atv paid 7.png|'''Step 8:''' Click on "File" --> "New" --> "Target.."
File:Generata ipa atv paid 8.png|'''Step 9:''' Choose "tvOS", "TV Services Extension" then click on "Next".
File:Generata ipa atv paid 9.png|'''Step 10:''' Fill the "Product Name" with "kodi topshelf", choose your Apple account name for the team and choose your name for the "Organization Name", then click on "Finish".
File:Generata ipa atv paid 10.png|'''Step 11:''' Click on "Activate".
File:Generata ipa atv paid 11.png|'''Step 12:''' Click on "Capabilities", then enable "App Groups" and enable the group previously created.
File:Generata ipa atv paid 12.png|'''Step 13:''' Now close Xcode and open the folder that contains your Kodi DEB file, then right click on it and open it with your unarchiver app. You will obtain 3 files.
File:Generata ipa atv paid 13.png|'''Step 14:''' Right click on "data.tar.lzma" and open it with your unarchiver app. You will obtain a folder named "data". Open "data" and all other folders until you find the "Kodi.app" file. Right click on it and choose "Show Package Contents" then open the "PlugIns" folder.
File:Generata ipa atv paid 14.png|'''Step 15:''' Open iOS App Signer, drag and drop "TVOSTopShelf.appex" in the "Input File" field, select the signing certificate corresponding to your Apple account, select the provisioning profile "com.yourusername.kodi.kodi-topshelf", then click on "Start". When the process has finished close iOS App Signer.
File:Generata ipa atv paid 15.png|'''Step 16:''' In your Finder window go back until you see the "Kodi.app" file. Open iOS App Signer, drag and drop "Kodi.ipa" in the "Input File" field, select the signing certificate corresponding to your Apple account, select the provisioning profile "com.yourusername.kodi", '''check "ignore PlugIns folder"''', then click on "Start". Click on "Save" and wait until the Kodi IPA file appears in the same folder as the "Kodi.app" file.
</gallery>

=== Install Kodi on your Apple TV ===

Finally you have to install your freshly created IPA file to your device. To do that follow the step-by-step guide below.

<gallery widths="225px">
File:Pair atv4 5.png|'''Step 1:''' Start your Apple TV and stay on the main menu screen. Launch Xcode and then navigate to "Window" --> "Devices and Simulators" from the menu bar on top.
File:Sideload atv 1.png|'''Step 2:''' Select your device on the left panel and click on the "+" button.
File:Sideload atv 2.png|'''Step 3:''' Select your freshly generated IPA file then click on "Open", finally wait until Kodi appear on your Apple TV main menu screen.
</gallery>

== Install on a jailbroken Apple TV ==

It is simple to get Kodi working on your [[w:iOS jailbreaking|jailbroken]] Apple TV. Here you can find the current tvOS versions with an available jailbreak for the Apple TV 4 and 4K:
* '''10.2.2 to 11.1:''' [https://wiki.awkwardtv.org/wiki/Backr00m backr00m]
* '''11.0 to 11.4.1:''' [https://coolstar.org/electra/ electraTV]
* '''12.0 to 12.1.1:''' [https://chimera.sh chimeraTV]
* '''13.4.5 and below''' [https://unc0ver.dev/tvos/ unc0verTV]
* '''All versions''' [https://checkra.in Checkra1n]

Once your Apple TV is jailbroken:
# Download the Kodi .deb file for tvOS: [http://mirrors.kodi.tv/nightlies/darwin/tvos/ latest Kodi nightly build] '''OR''' [http://mirrors.kodi.tv/test-builds/darwin/tvos/kodi-20180227-4a25e62-yab-tvos.deb Kodi 17.6 from Memphiz YAB branch (old)] and put it on your Desktop.
# Open a terminal window on your computer.
# Move to your desktop with <code>cd ~/Desktop</code>.
# Send the deb file to your Apple TV with <code>scp DEB_FILE root@IP_ADDRESS:/var/root/'</code> (adapt with your case, for example <code>scp kodi-20180227-4a25e62-yab-tvos.deb root@192.168.1.3:/var/root/</code>), the default password is <code>alpine</code>.
# Connect to your Apple TV with <code>ssh root@IP_ADDRESS</code>, default password is <code>alpine</code>.
# Install Kodi with <code>dpkg -i /var/root/kodi-20180227-4a25e62-yab-tvos.deb</code>.
# Refresh icons cache with <code>uicache</code>.
# Kodi should be on your main Apple TV screen.

[https://wiki.awkwardtv.org/wiki/Installing_Deb_Files Source]

[[Category:Manual]]
[[Category:Apple]]
[[Category:How-to|IOS]]
[[Category:Installation|IOS]]

HOW-TO:Install Kodi on Apple TV 4 and 5 (HD and 4K)

2023-06-18T10:27:44Z

Kambala: /* (option B) PAID Apple dev account with Top Shelf */

{{mininav|[[IOS]]|page={{FULLPAGENAME}} }}

== Install from Windows (only for Apple TV 4) ==

=== What about the Apple TV 4K? ===

{{warning|Unfortunately the Apple TV 4K does not have a USB-C. If you are not jailbroken the only official way to sideload Kodi on your device is to use Xcode on macOS with a wireless connection.
To get macOS on you computer you can use a virtual machine or check for building an [[w:Hackintosh|hackintosh]], but we will not discuss this here.}}

=== Prerequisites ===

{{warning|Cydia Impactor is still a work-in-progress, There might be some bugs that you face while installing Kodi. It is not for the faint of heart.
This method also requires that Kodi be re-installed every '''7 days''' if you are using a free Apple developer account.}}

* [http://cydiaimpactor.com/ Cydia Impactor]
* Windows 7 or higher
* Latest version of iTunes is needed to be installed.
* Kodi .deb file for tvOS: [http://mirrors.kodi.tv/test-builds/darwin/tvos/kodi-20180227-4a25e62-yab-tvos.deb Kodi 17.6 from Memphiz YAB branch (old but stable)] '''OR''' [http://mirrors.kodi.tv/nightlies/darwin/tvos/ latest Kodi 19 nightly build (it's an alpha version...)]
* A USB-C cable, without that, you can't connect your Apple TV with computer

=== Converting deb into ipa ===

Before beginning the installation, you have to convert .deb file of Kodi into .ipa. That is because Cydia Impactor only accepts .ipa files and not .deb files. If you already know how to convert .deb into .ipa, you can skip to the installation below.

*You will need to [http://www.7-zip.org/download.html/ Download 7-zip] and install it in your PC

'''Follow the steps given below and you will be able to convert .deb file into .ipa file.'''

<gallery widths="225px">
File:Convert-.deb-file-into-.ipa-file-on-windows-pc1.jpg|'''Step 1:''' Right Click on .deb file of Kodi that you downloaded on your PC and Select 7-zip > Extract files. Click OK in the next Window.
File:Convert-.deb-file-into-.ipa-file-on-windows-pc3.jpg|'''Step 2:''' Open the resulting Folder and you will find data.tar file inside. Simply extract data.tar file with Right Click > 7-zip > Extract Files.
File:Convert-.deb-file-into-.ipa-file-on-windows-pc4.jpg|'''Step 3:''' Now you should have data folder and data.tar file in the folder.
File:Convert-.deb-file-into-.ipa-file-on-windows-pc5.jpg|'''Step 4:''' Go inside the data folder and open Applications folder. Here you will find a folder named Kodi.app.
File:Convert-.deb-file-into-.ipa-file-on-windows-pc6.jpg|'''Step 5:''' Here create a new folder and name it “Payload” without quotes. Now you should have 2 folders. Payload and Kodi.app folder. Make sure that the P is capital in Payload.
File:Convert-.deb-file-into-.ipa-file-on-windows-pc7.jpg|'''Step 6:''' Now simply drag the Kodi.app folder and drop it on top of the Payload folder. In other words, copy kodi.app and paste it inside Payload folder.
File:Convert-.deb-file-into-.ipa-file-on-windows-pc8.jpg|'''Step 7:''' Next you have to Right-click the Payload folder and Click 7-zip > Add to archive option.
File:Convert-.deb-file-into-.ipa-file-on-windows-pc9.jpg|'''Step 8:''' A new window will pop up. Here you have to make sure that the Archive format is set to zip and name the archive ending with .ipa . Something like Kodi.ipa. After that click OK. <br> Now you should have your kodi.ipa file ready for installation.
</gallery>[https://www.drgeeky.com/convert-deb-file-into-ipa-file-for-sideloading-cydia-apps/ Source]

=== Install Kodi on your Apple TV ===

'''Connect your Apple TV 4 with power and make sure that it is turned ON before proceeding.'''

<gallery widths="225px">
File:1-USB-C-on-Apple-TV-4.jpg|'''Step 1:''' Connect your Apple TV4 with your computer, and make sure that it is turned ON. If iTunes or some other program pops up then close that first.
File:install-kodi-on-iPhone-without-jailbreak-and-XCode1.jpg|'''Step 2:''' Extract the Impactor zip file somewhere in your computer and Open Impactor.exe. Don’t select “Run as Administrator” for Cydia Impactor.
File:install-kodi-on-iPhone-without-jailbreak-windows2.jpg|'''Step 3:''' Make sure that your Apple TV is detected by Cydia Impactor. After that Drag and drop the Kodi.ipa file in Cydia Impactor.
File:install-kodi-on-iPhone-without-jailbreak-windows3.jpg|'''Step 4:''' Cydia Impactor will ask you to Enter your Apple ID. Enter a Valid Apple ID here and click OK Cydia Impactor will start installing Kodi on your Apple TV.
File:Kodi-Apple-TV-1024x570.jpg|'''Step 5:''' Wait for the installation to complete. Once done, simply look for Kodi icon on your Apple TV 4 main screen and Now you can open it.
</gallery>
{{notice|If you are using a free Apple developper account you will need to do this step every 7 days, so keep your IPA file on your computer}}
[https://www.drgeeky.com/install-kodi-apple-tv-without-mac-using-windows/ Source]

== Install from Mac ==

=== Prerequisites ===

* [http://dantheman827.github.io/ios-app-signer/ iOS App Signer]
* An iCloud account (required to download Xcode and to obtain your signing certificate and the provisioning profile)
* Xcode (you can download it directly from your Mac App Store)
* Kodi .deb file for tvOS: [http://mirrors.kodi.tv/test-builds/darwin/tvos/kodi-20180227-4a25e62-yab-tvos.deb Kodi 17.6 from Memphiz YAB branch (old but stable)] '''OR''' [http://mirrors.kodi.tv/nightlies/darwin/tvos/ latest Kodi 19 nightly build (it's an alpha version...)]
* (optional) A USB-C cable if you have the Apple TV 4 (but just like the Apple TV 4K, the Apple TV 4 can also communicates wirelessly)

=== Connect your device ===

If you have an Apple TV 4 and a USB-C cable you can power on your device and plug in with your Mac.
Else if you have an Apple TV 4K or an Apple TV 4 without a USB-C cable you will need to pair your device wirelessly with Xcode.
You can follow the step-by-step guide below.

<gallery widths="225px">
File:Pair atv4 1bis.png|'''Step 1:''' On your Apple TV open "Settings".
File:Pair atv4 2.png|'''Step 2:''' Open "Remotes and Devices".
File:Pair atv4 3.png|'''Step 3:''' Open "Remote App and Devices".
File:Pair atv4 4.png|'''Step 4:''' Now keep your Apple TV at this screen and take your Mac.
File:Pair atv4 5.png|'''Step 5:''' Launch Xcode and then navigate to "Window" --> "Devices and Simulators" from the menu bar on top.
File:Pair atv4 6.png|'''Step 6:''' Select your Apple TV on the left panel and click "Pair".
File:Pair atv4 7.png|'''Step 7:''' Fill the verification code that appear on your Apple TV screen and click on "Connect". Your device is now paired with Xcode!
</gallery>

=== Connect your Apple account in Xcode ===

Follow the step-by-step guide below in order to connect your iCloud/Apple account in Xcode.

<gallery widths="225px">
File:Connect icloud account 1.png|'''Step 1:''' Launch Xcode and open "Preferences" from the menu bar on top.
File:Connect icloud account 2.png|'''Step 2:''' Open the "Accounts" tab and add an account with the "+" button.
File:Connect icloud account 3.png|'''Step 3:''' Choose "Apple ID" then click "Continue".
File:Connect icloud account 4.png|'''Step 4:''' Fill in your Apple account credentials then click "Next".
File:Connect icloud account 5.png|'''Step 5:''' Now your Apple account is linked with Xcode!
</gallery>

=== Generate Kodi IPA file from deb file ===

'''If you have a free Apple developper account (this is usually the case if you are a "lambda" user) please follow the section [[#.28option_A.29_FREE_Apple_dev_account|FREE Apple dev account]], else if you have a paid developper account (99$/year) please follow the [[#.28option_B.29_PAID_Apple_dev_account|PAID Apple dev account]] section.'''

==== (option A) FREE Apple dev account without [https://streambuzz.net/apple-tv-top-shelf/ Top Shelf] ====

{{notice|If you are using a free Apple developper account you will need to re-sign and re-install Kodi every 7 days and the [https://streambuzz.net/apple-tv-top-shelf/ Top Shelf] feature will not work}}

Follow the step-by-step guide below in order to (i) obtain a valid signing certificate and provisioning profile for your Kodi app and (ii) pack and sign Kodi ''.deb'' file in an ''.ipa'' file

<gallery widths="225px">
File:Generata ipa atv free 1.png|'''Step 1:''' Open Xcode and click on "Create a new Xcode project".
File:Generata ipa atv free 2.png|'''Step 2:''' Choose "tvOS" and "Single View App" then click on "Next".
File:Generata ipa atv free 3.png|'''Step 3:''' Fill the "Product Name" with "kodi", choose your Apple account name for the team, choose your name for the "Organization Name" and "com.yourusername" (without any space) for your "Organization identifier". Then click on "Next".
File:Generata ipa atv free 4.png|'''Step 4:''' Finally choose a location for the Xcode project then click on "Create".
File:Generata ipa atv free 5.png|'''Step 5:''' Your Xcode project is now alive, open the devices list by clicking on the target device on the top left.
File:Generata ipa atv free 6.png|'''Step 6:''' Choose your your "real" connected Apple TV. Also, check for a "Fix issue" button on the signing panel, if this button is present click on it. Now you can close your Xcode window.
File:Generata ipa atv free 7.png|'''Step 7:''' Now open iOS App Signer, click on "Browse" and choose the Kodi DEB file, select the signing certificate corresponding to your Apple account, select the provisioning profile corresponding to the organization identifier that you have previously chosen, then click on "Start".
File:Generata ipa atv free 8.png|'''Step 8:''' Click on "Save" and wait until the Kodi IPA file appears in the same folder as the DEB file.
</gallery>

==== (option B) PAID Apple dev account with [https://streambuzz.net/apple-tv-top-shelf/ Top Shelf] ====

During the step-by-step guide below you will need to extract the <code>.deb</code> file and also a <code>.tar.xz</code> file, to do that you can use an extractor app like [https://theunarchiver.com The Unarchiver], or also a Terminal with the command:
* <code>ar -p kodi-tvos.deb data.tar.xz | tar -xf -</code>, new directory '''Applications''' will appear where you can find Kodi.app

<gallery widths="225px">
File:Generata ipa atv paid 1.png|'''Step 1:''' Open Xcode and click on "Create a new Xcode project".
File:Generata ipa atv paid 2.png|'''Step 2:''' Choose "tvOS" and "Single View App" then click on "Next".
File:Generata ipa atv paid 3.png|'''Step 3:''' Fill the "Product Name" with "kodi", choose your Apple account name for the team, choose your name for the "Organization Name" and "com.yourusername" (without any space) for your "Organization identifier". Then click on "Next".
File:Generata ipa atv paid 4.png|'''Step 4:''' Finally choose a location for the Xcode project then click on "Create".
File:Generata ipa atv paid 5.png|'''Step 5:''' Your Xcode project is now alive, open the devices list by clicking on the target device on the top left.
File:Generata ipa atv paid 6.png|'''Step 6:''' Choose your your "real" connected Apple TV. Also, check for a "Fix issue" button on the signing panel, if this button is present click on it. Now you can close your Xcode window.
File:Generata ipa atv paid 6bis.png|'''Step 7:''' Click on "Capabilities", then enable "App Groups", click on the "+" button and create a new group group.com.yourusername.kodi, and finally enable this group.
File:Generata ipa atv paid 7.png|'''Step 8:''' Click on "File" --> "New" --> "Target.."
File:Generata ipa atv paid 8.png|'''Step 9:''' Choose "tvOS", "TV Services Extension" then click on "Next".
File:Generata ipa atv paid 9.png|'''Step 10:''' Fill the "Product Name" with "kodi topshelf", choose your Apple account name for the team and choose your name for the "Organization Name", then click on "Finish".
File:Generata ipa atv paid 10.png|'''Step 11:''' Click on "Activate".
File:Generata ipa atv paid 11.png|'''Step 12:''' Click on "Capabilities", then enable "App Groups" and enable the group previously created.
File:Generata ipa atv paid 12.png|'''Step 13:''' Now close Xcode and open the folder that contains your Kodi DEB file, then right click on it and open it with your unarchiver app. You will obtain 3 files.
File:Generata ipa atv paid 13.png|'''Step 14:''' Right click on "data.tar.lzma" and open it with your unarchiver app. You will obtain a folder named "data". Open "data" and all other folders until you find the "Kodi.app" file. Right click on it and choose "Show Package Contents" then open the "PlugIns" folder.
File:Generata ipa atv paid 14.png|'''Step 15:''' Open iOS App Signer, drag and drop "TVOSTopShelf.appex" in the "Input File" field, select the signing certificate corresponding to your Apple account, select the provisioning profile "com.yourusername.kodi.kodi-topshelf", then click on "Start". When the process has finished close iOS App Signer.
File:Generata ipa atv paid 15.png|'''Step 16:''' In your Finder window go back until you see the "Kodi.app" file. Open iOS App Signer, drag and drop "Kodi.ipa" in the "Input File" field, select the signing certificate corresponding to your Apple account, select the provisioning profile "com.yourusername.kodi", '''check "ignore PlugIns folder"''', then click on "Start". Click on "Save" and wait until the Kodi IPA file appears in the same folder as the "Kodi.app" file.
</gallery>

=== Install Kodi on your Apple TV ===

Finally you have to install your freshly created IPA file to your device. To do that follow the step-by-step guide below.

<gallery widths="225px">
File:Pair atv4 5.png|'''Step 1:''' Start your Apple TV and stay on the main menu screen. Launch Xcode and then navigate to "Window" --> "Devices and Simulators" from the menu bar on top.
File:Sideload atv 1.png|'''Step 2:''' Select your device on the left panel and click on the "+" button.
File:Sideload atv 2.png|'''Step 3:''' Select your freshly generated IPA file then click on "Open", finally wait until Kodi appear on your Apple TV main menu screen.
</gallery>

== Install on a jailbroken Apple TV ==

It is simple to get Kodi working on your [[w:iOS jailbreaking|jailbroken]] Apple TV. Here you can find the current tvOS versions with an available jailbreak for the Apple TV 4 and 4K:
* '''10.2.2 to 11.1:''' [https://wiki.awkwardtv.org/wiki/Backr00m backr00m]
* '''11.0 to 11.4.1:''' [https://coolstar.org/electra/ electraTV]
* '''12.0 to 12.1.1:''' [https://chimera.sh chimeraTV]
* '''13.4.5 and below''' [https://unc0ver.dev/tvos/ unc0verTV]
* '''All versions''' [https://checkra.in Checkra1n]

Once your Apple TV is jailbroken:
# Download the Kodi .deb file for tvOS: [http://mirrors.kodi.tv/test-builds/darwin/tvos/kodi-20180227-4a25e62-yab-tvos.deb Kodi 17.6 from Memphiz YAB branch (old but stable)] '''OR''' [http://mirrors.kodi.tv/nightlies/darwin/tvos/ latest Kodi 19 nightly build (it's an alpha version...)] and put it on your Desktop.
# Open a terminal window on your computer.
# Move to your desktop with <code>cd ~/Desktop</code>.
# Send the deb file to your Apple TV with <code>scp DEB_FILE root@IP_ADDRESS:/var/root/'</code> (adapt with your case, for example <code>scp kodi-20180227-4a25e62-yab-tvos.deb root@192.168.1.3:/var/root/</code>), the default password is <code>alpine</code>.
# Connect to your Apple TV with <code>ssh root@IP_ADDRESS</code>, default password is <code>alpine</code>.
# Install Kodi with <code>dpkg -i /var/root/kodi-20180227-4a25e62-yab-tvos.deb</code>.
# Refresh icons cache with <code>uicache</code>.
# Kodi should be on your main Apple TV screen.

[https://wiki.awkwardtv.org/wiki/Installing_Deb_Files Source]

[[Category:Manual]]
[[Category:Apple]]
[[Category:How-to|IOS]]
[[Category:Installation|IOS]]

HOW-TO:Install Kodi on Apple TV 4 and 5 (HD and 4K)

2023-06-18T10:27:18Z

Kambala: improved extraction terminal command

{{mininav|[[IOS]]|page={{FULLPAGENAME}} }}

== Install from Windows (only for Apple TV 4) ==

=== What about the Apple TV 4K? ===

{{warning|Unfortunately the Apple TV 4K does not have a USB-C. If you are not jailbroken the only official way to sideload Kodi on your device is to use Xcode on macOS with a wireless connection.
To get macOS on you computer you can use a virtual machine or check for building an [[w:Hackintosh|hackintosh]], but we will not discuss this here.}}

=== Prerequisites ===

{{warning|Cydia Impactor is still a work-in-progress, There might be some bugs that you face while installing Kodi. It is not for the faint of heart.
This method also requires that Kodi be re-installed every '''7 days''' if you are using a free Apple developer account.}}

* [http://cydiaimpactor.com/ Cydia Impactor]
* Windows 7 or higher
* Latest version of iTunes is needed to be installed.
* Kodi .deb file for tvOS: [http://mirrors.kodi.tv/test-builds/darwin/tvos/kodi-20180227-4a25e62-yab-tvos.deb Kodi 17.6 from Memphiz YAB branch (old but stable)] '''OR''' [http://mirrors.kodi.tv/nightlies/darwin/tvos/ latest Kodi 19 nightly build (it's an alpha version...)]
* A USB-C cable, without that, you can't connect your Apple TV with computer

=== Converting deb into ipa ===

Before beginning the installation, you have to convert .deb file of Kodi into .ipa. That is because Cydia Impactor only accepts .ipa files and not .deb files. If you already know how to convert .deb into .ipa, you can skip to the installation below.

*You will need to [http://www.7-zip.org/download.html/ Download 7-zip] and install it in your PC

'''Follow the steps given below and you will be able to convert .deb file into .ipa file.'''

<gallery widths="225px">
File:Convert-.deb-file-into-.ipa-file-on-windows-pc1.jpg|'''Step 1:''' Right Click on .deb file of Kodi that you downloaded on your PC and Select 7-zip > Extract files. Click OK in the next Window.
File:Convert-.deb-file-into-.ipa-file-on-windows-pc3.jpg|'''Step 2:''' Open the resulting Folder and you will find data.tar file inside. Simply extract data.tar file with Right Click > 7-zip > Extract Files.
File:Convert-.deb-file-into-.ipa-file-on-windows-pc4.jpg|'''Step 3:''' Now you should have data folder and data.tar file in the folder.
File:Convert-.deb-file-into-.ipa-file-on-windows-pc5.jpg|'''Step 4:''' Go inside the data folder and open Applications folder. Here you will find a folder named Kodi.app.
File:Convert-.deb-file-into-.ipa-file-on-windows-pc6.jpg|'''Step 5:''' Here create a new folder and name it “Payload” without quotes. Now you should have 2 folders. Payload and Kodi.app folder. Make sure that the P is capital in Payload.
File:Convert-.deb-file-into-.ipa-file-on-windows-pc7.jpg|'''Step 6:''' Now simply drag the Kodi.app folder and drop it on top of the Payload folder. In other words, copy kodi.app and paste it inside Payload folder.
File:Convert-.deb-file-into-.ipa-file-on-windows-pc8.jpg|'''Step 7:''' Next you have to Right-click the Payload folder and Click 7-zip > Add to archive option.
File:Convert-.deb-file-into-.ipa-file-on-windows-pc9.jpg|'''Step 8:''' A new window will pop up. Here you have to make sure that the Archive format is set to zip and name the archive ending with .ipa . Something like Kodi.ipa. After that click OK. <br> Now you should have your kodi.ipa file ready for installation.
</gallery>[https://www.drgeeky.com/convert-deb-file-into-ipa-file-for-sideloading-cydia-apps/ Source]

=== Install Kodi on your Apple TV ===

'''Connect your Apple TV 4 with power and make sure that it is turned ON before proceeding.'''

<gallery widths="225px">
File:1-USB-C-on-Apple-TV-4.jpg|'''Step 1:''' Connect your Apple TV4 with your computer, and make sure that it is turned ON. If iTunes or some other program pops up then close that first.
File:install-kodi-on-iPhone-without-jailbreak-and-XCode1.jpg|'''Step 2:''' Extract the Impactor zip file somewhere in your computer and Open Impactor.exe. Don’t select “Run as Administrator” for Cydia Impactor.
File:install-kodi-on-iPhone-without-jailbreak-windows2.jpg|'''Step 3:''' Make sure that your Apple TV is detected by Cydia Impactor. After that Drag and drop the Kodi.ipa file in Cydia Impactor.
File:install-kodi-on-iPhone-without-jailbreak-windows3.jpg|'''Step 4:''' Cydia Impactor will ask you to Enter your Apple ID. Enter a Valid Apple ID here and click OK Cydia Impactor will start installing Kodi on your Apple TV.
File:Kodi-Apple-TV-1024x570.jpg|'''Step 5:''' Wait for the installation to complete. Once done, simply look for Kodi icon on your Apple TV 4 main screen and Now you can open it.
</gallery>
{{notice|If you are using a free Apple developper account you will need to do this step every 7 days, so keep your IPA file on your computer}}
[https://www.drgeeky.com/install-kodi-apple-tv-without-mac-using-windows/ Source]

== Install from Mac ==

=== Prerequisites ===

* [http://dantheman827.github.io/ios-app-signer/ iOS App Signer]
* An iCloud account (required to download Xcode and to obtain your signing certificate and the provisioning profile)
* Xcode (you can download it directly from your Mac App Store)
* Kodi .deb file for tvOS: [http://mirrors.kodi.tv/test-builds/darwin/tvos/kodi-20180227-4a25e62-yab-tvos.deb Kodi 17.6 from Memphiz YAB branch (old but stable)] '''OR''' [http://mirrors.kodi.tv/nightlies/darwin/tvos/ latest Kodi 19 nightly build (it's an alpha version...)]
* (optional) A USB-C cable if you have the Apple TV 4 (but just like the Apple TV 4K, the Apple TV 4 can also communicates wirelessly)

=== Connect your device ===

If you have an Apple TV 4 and a USB-C cable you can power on your device and plug in with your Mac.
Else if you have an Apple TV 4K or an Apple TV 4 without a USB-C cable you will need to pair your device wirelessly with Xcode.
You can follow the step-by-step guide below.

<gallery widths="225px">
File:Pair atv4 1bis.png|'''Step 1:''' On your Apple TV open "Settings".
File:Pair atv4 2.png|'''Step 2:''' Open "Remotes and Devices".
File:Pair atv4 3.png|'''Step 3:''' Open "Remote App and Devices".
File:Pair atv4 4.png|'''Step 4:''' Now keep your Apple TV at this screen and take your Mac.
File:Pair atv4 5.png|'''Step 5:''' Launch Xcode and then navigate to "Window" --> "Devices and Simulators" from the menu bar on top.
File:Pair atv4 6.png|'''Step 6:''' Select your Apple TV on the left panel and click "Pair".
File:Pair atv4 7.png|'''Step 7:''' Fill the verification code that appear on your Apple TV screen and click on "Connect". Your device is now paired with Xcode!
</gallery>

=== Connect your Apple account in Xcode ===

Follow the step-by-step guide below in order to connect your iCloud/Apple account in Xcode.

<gallery widths="225px">
File:Connect icloud account 1.png|'''Step 1:''' Launch Xcode and open "Preferences" from the menu bar on top.
File:Connect icloud account 2.png|'''Step 2:''' Open the "Accounts" tab and add an account with the "+" button.
File:Connect icloud account 3.png|'''Step 3:''' Choose "Apple ID" then click "Continue".
File:Connect icloud account 4.png|'''Step 4:''' Fill in your Apple account credentials then click "Next".
File:Connect icloud account 5.png|'''Step 5:''' Now your Apple account is linked with Xcode!
</gallery>

=== Generate Kodi IPA file from deb file ===

'''If you have a free Apple developper account (this is usually the case if you are a "lambda" user) please follow the section [[#.28option_A.29_FREE_Apple_dev_account|FREE Apple dev account]], else if you have a paid developper account (99$/year) please follow the [[#.28option_B.29_PAID_Apple_dev_account|PAID Apple dev account]] section.'''

==== (option A) FREE Apple dev account without [https://streambuzz.net/apple-tv-top-shelf/ Top Shelf] ====

{{notice|If you are using a free Apple developper account you will need to re-sign and re-install Kodi every 7 days and the [https://streambuzz.net/apple-tv-top-shelf/ Top Shelf] feature will not work}}

Follow the step-by-step guide below in order to (i) obtain a valid signing certificate and provisioning profile for your Kodi app and (ii) pack and sign Kodi ''.deb'' file in an ''.ipa'' file

<gallery widths="225px">
File:Generata ipa atv free 1.png|'''Step 1:''' Open Xcode and click on "Create a new Xcode project".
File:Generata ipa atv free 2.png|'''Step 2:''' Choose "tvOS" and "Single View App" then click on "Next".
File:Generata ipa atv free 3.png|'''Step 3:''' Fill the "Product Name" with "kodi", choose your Apple account name for the team, choose your name for the "Organization Name" and "com.yourusername" (without any space) for your "Organization identifier". Then click on "Next".
File:Generata ipa atv free 4.png|'''Step 4:''' Finally choose a location for the Xcode project then click on "Create".
File:Generata ipa atv free 5.png|'''Step 5:''' Your Xcode project is now alive, open the devices list by clicking on the target device on the top left.
File:Generata ipa atv free 6.png|'''Step 6:''' Choose your your "real" connected Apple TV. Also, check for a "Fix issue" button on the signing panel, if this button is present click on it. Now you can close your Xcode window.
File:Generata ipa atv free 7.png|'''Step 7:''' Now open iOS App Signer, click on "Browse" and choose the Kodi DEB file, select the signing certificate corresponding to your Apple account, select the provisioning profile corresponding to the organization identifier that you have previously chosen, then click on "Start".
File:Generata ipa atv free 8.png|'''Step 8:''' Click on "Save" and wait until the Kodi IPA file appears in the same folder as the DEB file.
</gallery>

==== (option B) PAID Apple dev account with [https://streambuzz.net/apple-tv-top-shelf/ Top Shelf] ====

During the step-by-step guide below you will need to extract the <code>.deb</code> file and also a <code>.tar.xz</code> file, to do that you can use an extractor app like [https://theunarchiver.com The Unarchiver], or also a Terminal with the command:
* <code>ar -p kodi-tvos.deb | tar -xf -</code>, new directory '''Applications''' will appear where you can find Kodi.app

<gallery widths="225px">
File:Generata ipa atv paid 1.png|'''Step 1:''' Open Xcode and click on "Create a new Xcode project".
File:Generata ipa atv paid 2.png|'''Step 2:''' Choose "tvOS" and "Single View App" then click on "Next".
File:Generata ipa atv paid 3.png|'''Step 3:''' Fill the "Product Name" with "kodi", choose your Apple account name for the team, choose your name for the "Organization Name" and "com.yourusername" (without any space) for your "Organization identifier". Then click on "Next".
File:Generata ipa atv paid 4.png|'''Step 4:''' Finally choose a location for the Xcode project then click on "Create".
File:Generata ipa atv paid 5.png|'''Step 5:''' Your Xcode project is now alive, open the devices list by clicking on the target device on the top left.
File:Generata ipa atv paid 6.png|'''Step 6:''' Choose your your "real" connected Apple TV. Also, check for a "Fix issue" button on the signing panel, if this button is present click on it. Now you can close your Xcode window.
File:Generata ipa atv paid 6bis.png|'''Step 7:''' Click on "Capabilities", then enable "App Groups", click on the "+" button and create a new group group.com.yourusername.kodi, and finally enable this group.
File:Generata ipa atv paid 7.png|'''Step 8:''' Click on "File" --> "New" --> "Target.."
File:Generata ipa atv paid 8.png|'''Step 9:''' Choose "tvOS", "TV Services Extension" then click on "Next".
File:Generata ipa atv paid 9.png|'''Step 10:''' Fill the "Product Name" with "kodi topshelf", choose your Apple account name for the team and choose your name for the "Organization Name", then click on "Finish".
File:Generata ipa atv paid 10.png|'''Step 11:''' Click on "Activate".
File:Generata ipa atv paid 11.png|'''Step 12:''' Click on "Capabilities", then enable "App Groups" and enable the group previously created.
File:Generata ipa atv paid 12.png|'''Step 13:''' Now close Xcode and open the folder that contains your Kodi DEB file, then right click on it and open it with your unarchiver app. You will obtain 3 files.
File:Generata ipa atv paid 13.png|'''Step 14:''' Right click on "data.tar.lzma" and open it with your unarchiver app. You will obtain a folder named "data". Open "data" and all other folders until you find the "Kodi.app" file. Right click on it and choose "Show Package Contents" then open the "PlugIns" folder.
File:Generata ipa atv paid 14.png|'''Step 15:''' Open iOS App Signer, drag and drop "TVOSTopShelf.appex" in the "Input File" field, select the signing certificate corresponding to your Apple account, select the provisioning profile "com.yourusername.kodi.kodi-topshelf", then click on "Start". When the process has finished close iOS App Signer.
File:Generata ipa atv paid 15.png|'''Step 16:''' In your Finder window go back until you see the "Kodi.app" file. Open iOS App Signer, drag and drop "Kodi.ipa" in the "Input File" field, select the signing certificate corresponding to your Apple account, select the provisioning profile "com.yourusername.kodi", '''check "ignore PlugIns folder"''', then click on "Start". Click on "Save" and wait until the Kodi IPA file appears in the same folder as the "Kodi.app" file.
</gallery>

=== Install Kodi on your Apple TV ===

Finally you have to install your freshly created IPA file to your device. To do that follow the step-by-step guide below.

<gallery widths="225px">
File:Pair atv4 5.png|'''Step 1:''' Start your Apple TV and stay on the main menu screen. Launch Xcode and then navigate to "Window" --> "Devices and Simulators" from the menu bar on top.
File:Sideload atv 1.png|'''Step 2:''' Select your device on the left panel and click on the "+" button.
File:Sideload atv 2.png|'''Step 3:''' Select your freshly generated IPA file then click on "Open", finally wait until Kodi appear on your Apple TV main menu screen.
</gallery>

== Install on a jailbroken Apple TV ==

It is simple to get Kodi working on your [[w:iOS jailbreaking|jailbroken]] Apple TV. Here you can find the current tvOS versions with an available jailbreak for the Apple TV 4 and 4K:
* '''10.2.2 to 11.1:''' [https://wiki.awkwardtv.org/wiki/Backr00m backr00m]
* '''11.0 to 11.4.1:''' [https://coolstar.org/electra/ electraTV]
* '''12.0 to 12.1.1:''' [https://chimera.sh chimeraTV]
* '''13.4.5 and below''' [https://unc0ver.dev/tvos/ unc0verTV]
* '''All versions''' [https://checkra.in Checkra1n]

Once your Apple TV is jailbroken:
# Download the Kodi .deb file for tvOS: [http://mirrors.kodi.tv/test-builds/darwin/tvos/kodi-20180227-4a25e62-yab-tvos.deb Kodi 17.6 from Memphiz YAB branch (old but stable)] '''OR''' [http://mirrors.kodi.tv/nightlies/darwin/tvos/ latest Kodi 19 nightly build (it's an alpha version...)] and put it on your Desktop.
# Open a terminal window on your computer.
# Move to your desktop with <code>cd ~/Desktop</code>.
# Send the deb file to your Apple TV with <code>scp DEB_FILE root@IP_ADDRESS:/var/root/'</code> (adapt with your case, for example <code>scp kodi-20180227-4a25e62-yab-tvos.deb root@192.168.1.3:/var/root/</code>), the default password is <code>alpine</code>.
# Connect to your Apple TV with <code>ssh root@IP_ADDRESS</code>, default password is <code>alpine</code>.
# Install Kodi with <code>dpkg -i /var/root/kodi-20180227-4a25e62-yab-tvos.deb</code>.
# Refresh icons cache with <code>uicache</code>.
# Kodi should be on your main Apple TV screen.

[https://wiki.awkwardtv.org/wiki/Installing_Deb_Files Source]

[[Category:Manual]]
[[Category:Apple]]
[[Category:How-to|IOS]]
[[Category:Installation|IOS]]

MySQL/Setting up Kodi

2023-04-20T16:45:30Z

Kambala: fixed redv element

{{:MySQL/Contents}}
{{mininav| [[MySQL]] }}
Each device that will be sharing a library will need an [[Advancedsettings.xml|advancedsetting.xml]] file.

__TOC__
{{-}}
==Make files accessible over the network==
If you haven't already done so, you will need to make your media files accessible to all your Kodi devices by sharing them on the network through file sharing. Kodi itself or the MySQL server will not share the actual files for this setup. Most operating systems have built-in methods for sharing files to the network, or a NAS device can be used.

{{note|
*If you use passwords on your network shares then you will need to copy (or [[MySQL/Sync other parts of Kodi|sync]]) your passwords.xml file from the userdata folder to each Kodi device.
*Do not use mapped drives on the OS-level, as Kodi will see those as local drives.
*If you use smb:// paths, you may want to use static IP addresses rather than NetBIOS names, as not all your devices may be able to resolve the latter.
*'''Even if the media is on the same computer as one of the Kodi instances, you MUST use a network share path. You cannot use a local file path with MySQL.'''}}

See [[:Category:File sharing]] for some of the file sharing methods that work with Kodi.

==Exporting==
{{see also|Backup|Import-export library}}

{{note|You only need to do the exporting steps if you are migrating an existing local library to a MySQL database. The MySQL setup creates an entirely new library on the MySQL server, so this step allows you to preserve your old library and restore it once MySQL is used in Kodi.}}

{{redv|'''Warning:''' |This will create individual ".nfo" and image files along side your video files. This is considered the safest way to backup and/or migrate a library (MySQL or otherwise), but some users might not want the file clutter.}}

#Open Kodi on the computer that has the library you want to share
##Export the Video Library by doing the following:
###Go to '''Settings/Media/Library/Video Library''' and select '''Export library'''
###Select '''Multiple files'''

##Export the Music Library by doing the following:
###Go to ''''Settings/Media/Library/Music Library''' and select '''Export library'''
###Select '''Multiple files'''

==MySQL and advancedsettings.xml==
{| class=infobox
| advancedsettings.xml:
|-
|
<syntaxhighlight lang=xml>
<advancedsettings>
<videodatabase>
<type>mysql</type>
<host>***.***.***.***</host>
<port>3306</port>
<user>kodi</user>
<pass>kodi</pass>
</videodatabase>
<musicdatabase>
<type>mysql</type>
<host>***.***.***.***</host>
<port>3306</port>
<user>kodi</user>
<pass>kodi</pass>
</musicdatabase>
<videolibrary>
<importwatchedstate>true</importwatchedstate>
<importresumepoint>true</importresumepoint>
</videolibrary>
</advancedsettings>
</syntaxhighlight>
<small>''See also this note about using the <name> tag: [[#Name tag]]<br/><importwatchedstate> is only needed when you're importing a previous library from exported files.</small>
|}
#Create (or add to, if you already have one) an [[Advancedsettings.xml#.3Cmusicdatabase.3E.2F.3Cvideodatabase.3E|advancedsettings.xml]] file:
##Open up a plain text editor
##Copy and paste the text from the right-hand box into a new text document
##Replace the two instances of <code>***.***.***.***</code> with local network IP address of your MySQL server. If you installed MySQL on a Windows machine, do not use its NetBIOS name, as not all devices may be able to resolve them.
##Save the file as '''advancedsettings.xml'''
#Copy this ''advancedsettings.xml'' file you just created to the '''[[Userdata]]''' of every Kodi install you want to sync with.
{{-}}

{{note|Sometimes it takes your dhcp too long before an ip-address is assigned to the local machine and the [https://github.com/samnazarko/osmc/issues/131 mysql driver are therefore not loaded]. In this case the library will appear empty and will not show resumepoints and watchedstates. In that case run <code>sudo systemctl enable connman-wait-for-network.service</code> on the shell or look for the option "wait for a network connection before loading" in the network options}}

==Importing==
At this point Kodi is using the MySQL server for the database, which means it has a new blank library. Now we can either import an old library (see below) or simply start a new library (see [[HOW-TO:Create_Video_Library]]). From this point on, Kodi behaves exactly like it would as if it had a local database, except that database is on the MySQL server and multiple installs can access that single database.

# Open any of your installs and re-import your library data, ''or'' simply set up a new library if you are starting fresh.
# Add (or just "set content" on) the networked video source to Kodi and scan it in as if you were setting up your library for the first time (see [[HOW-TO:Create_Video_Library|adding videos to the library]]). However, Kodi will read the exported nfo files and images and use those instead of rebuilding the library from scratch. The end result will be an identical library, and your watched status for videos will be preserved.
#:{{Note|You must add a network source using Kodi's standard formatting. For example, use "smb://192.168.1.20/Videos/" and not "\\BOBPC\Videos\". Try to use static IP addresses over NetBIOS names if using SMB.}}
# Import the Music Library by doing the following: Same idea as videos, but using the steps for [[HOW-TO:Create_Music_Library|adding music to the library]]. You'll end up with an identical library.
You can now add files and update the library from any of your devices and the library for all of them will stay in sync.

== Adding new Kodi devices to the MySQL setup ==
Since the database has now been set up on the MySQL server, all you need to do for any additional Kodi devices, is to copy a small number of files/folders.
* Copy the MySQL connections section for video and/or music databases into the '''advancedsettings.xml''' file on the other Kodi client(s). If you have identical Kodi devices, simply copy the whole advancedsettings.xml file from the initially setup Kodi device.
* Copy from the same userdata root folder the files, such as "'''favourites.xml'''", "'''sources.xml'''", "'''mediasources.xml'''", "'''passwords.xml'''" (if present).

To have the other Kodi client(s) also benefit from the already downloaded/cached art thumbnails:
* Copy the '''Textures13.db''' file from the '''userdata/Database folder''' to the other Kodi client(s).
* Copy the full '''Thumbnails''' subfolder from the userdata folder to other Kodi client(s). (This subfolder may contain several megabytes of small files when dealing with large video/music collections)

You don't need to do any of the other steps, such as rescanning or reimporting. Any fanart not already cached will be downloaded shortly after. If this method works on one device, it should work on all of them, as they are basically sharing the same "brain" for the video/music metadata.

If you however used a metadata collector add-on ([[Scrapers|scraper]]) that does not ship by default with new installations, such as the [[Add-on:Universal Movie Scraper|Universal Movie Scraper]] you will not be able to display the [[Basic_controls|media information screen]] on the new Kodi device. To fix that, you need to install the same metadata collector add-on on the new device.

==Name tag==
<section begin="name tag" />
An additional <code><name></code> tag can be used for both the <code><videodatabase></code> and <code><musicdatabase></code> entries in advancedsettings.xml file, if you want to change the name of the database. The <code><name></code> tag is not required. Kodi will use "MyVideos" and "MyMusic" as database names if the <code><name></code> tag is not specified.

You may want to do this if you want to have multiple separate libraries (with different content) on the same MySQL server. For example, if you want to create multiple profiles, each with their own shared library, so that each Kodi device can "log-into" that library. (a kids library, a guest library, etc)

{{note|Don't try to merge the video and music databases! You need to use different values in the <code><name></code> tag or you'll end up confusing Kodi leading to the library functionality not working at all. In other words, don't use <code><name>Kids</name></code> for both music and videos, but instead use something like <code><name>Kids-music</name></code> and <code><name>Kids-video</name></code>.}}

{{Krypton updated}}

Official Kodi Remote/iOS

2021-04-03T11:56:28Z

Kambala: update URL to Github repo

{{mininav|[[Main_Page]]|[[Remote_controls]]|[[Smartphone/tablet_remotes|Phones/tablets]]|[[Official Kodi Remote|Official]] }}
{{Infobox information appliance
| name = Official Kodi Remote
| logo = [[File:IOS_remote_icon.png]]
| image =
| caption =
| developer = Team Kodi
| os = iOS 5 and above
| website =
}}

The '''Official Kodi Remote''' for iOS is a full-featured, open source remote control for Kodi Media Center. It features library browsing, now playing informations and a direct remote control.
It's freely available on [http://itunes.apple.com/us/app/unofficial-official-xbmc-remote/id520480364?ls=1&mt=8 AppStore]

Please note: Supported Kodi version is v11 (Eden) or higher.

== Features ==
=== General ===
* Remote control
* Control Kodi's volume
* Manage multiple Kodi instances
* Live view of currently playing playlist
* Setting that prevents your phone locking the screen.
* Swipe left and right gesture recognizer for an easy navigation
=== Music Library ===
* Cover art is shown where available
* Now playing screen allows skipping, seeking, stop and pause
* Browse by album, artist, genre
* List all albums and songs of an artist
* Browse files directly
* Play and queue albums, songs, genre selections and much more directly without having to turn on your TV.
* Listing of current playlist with options to jump to another song or remove a song with Music Party mode support
=== Movie Library ===
* Browse by title, actors, genre.
* Displays movie poster and actor thumbs where available.
=== TV Shows Library ===
* Browse by show, season, episode.
* Dynamic thumb rendering with wide banner support
* Displays episode and show details

== iPhone/iPod Screenshots (app version 1.2.x) ==
<gallery>
File:1 three screens mainmenu.png
File:2 three screens now playing.png
File:3 three screens remote.png
File:4 two screens music album.png
File:5 two screens tvshow seasons.png
File:6 three screens clearlogo.png
File:Official XBMC Remote 1.2 a.png
File:Official XBMC Remote 1.2 b.png
File:Official XBMC Remote 1.2 c.png
File:Official XBMC Remote 1.2 d.png
File:Official XBMC Remote 1.2 e.png
File:Official XBMC Remote 1.2 f.png
</gallery>

== iPad Screenshots (app version 1.2.x) ==
<gallery>
File:A1.png
File:iOS-A2.png
File:A3.png
File:A4.png
File:Official XBMC Remote 1.2 g.png
File:Official XBMC Remote 1.2 h.png
File:Official XBMC Remote 1.2 i.png
File:Official XBMC Remote 1.2 l.png
File:Official XBMC Remote 1.2 m.png
</gallery>

== old iPhone/iPod Screenshots (app version 1.0.x - 1.1.x) ==
<gallery>
File:Fest small.png
File:Old_iOS_remote_logo
File:Unofficial official xbmc remote 1.png
File:Unofficial official xbmc remote 2.png
File:Unofficial official xbmc remote 3.png
File:Unofficial official xbmc remote 4.png
File:Unofficial official xbmc remote 5.png
File:Unofficial official xbmc remote 6.png
File:Unofficial official xbmc remote 7.png
File:Unofficial official xbmc remote 8.png
File:Unofficial official xbmc remote 9.png
File:Unofficial official xbmc remote 10.png
File:Unofficial official xbmc remote 11.png
File:Unofficial official xbmc remote 12.png
File:Unofficial official xbmc remote 13.png
File:Unofficial official xbmc remote 14.png
File:Official XBMC remote 1.png
File:Official XBMC remote 2.png
File:Unofficial official xbmc remote 16.png
File:Unofficial official xbmc remote 17.png
File:Unofficial official xbmc remote 18.png
File:Unofficial official xbmc remote 19.png
File:Unofficial official xbmc remote 20.png
File:Unofficial official xbmc remote 21.png
File:Unofficial official xbmc remote 22.png
File:Unoffical Official XBMC Remote for iOS.png
File:Official_xbmc_remote_forum_announcement.jpg‎
File:XBMC jeans pocket.png
File:Remote Control Quick Help.png
</gallery>

== old iPad Screenshots (app version 1.0.x - 1.1.x) ==
<gallery>
File:Old_iOS_remote_logo.png
File:Official xbmc remote 1.png
File:Official xbmc remote 2.png
File:Official xbmc remote 3.png
File:Official xbmc remote 4.png
File:Official xbmc remote 5.png
File:Official xbmc remote 5b.png
File:Official xbmc remote 5c.png
File:Official xbmc remote 5d.png
File:Official xbmc remote 6.png
File:Official xbmc remote 7.png
File:Official xbmc remote 8.png
File:Official xbmc remote 9.png
File:Official xbmc remote 9b.png
File:Official xbmc remote 11.png
File:Official xbmc remote 11b.png
File:Official xbmc remote 12.png
File:Official xbmc remote 14.png
File:Remote Control Quick Help.png
</gallery>

== old iPhone Video demo (app version 1.0.x - 1.1.x) ==
{{youtube|eAaKlgbD7_U}}

== old iPad Video demo (app version 1.0.x - 1.1.x) ==
{{youtube|uP8P9gSm8lE}}

== Support Forum ==
* [https://forum.kodi.tv/forumdisplay.php?fid=193 Kodi Remote for iOS Official Forum]

== GitHub Project ==
* [https://github.com/xbmc/Official-Kodi-Remote-iOS "Official Kodi Remote" GitHub project]

[[Category:Remotes]]
[[Category:Apple]]
[[Category:Manual]]

Add-on settings

2020-01-05T10:14:39Z

Kambala: fixed first setting name

{{note|Deprecated - Addons submitted to the Kodi 19 Matrix (and up) can use the new setting format. see [[Add-on_settings_conversion]]}}

{{mininav|[[Development]]|[[Add-on development]]}}<br />

{{see also|Python development}}

== Description ==

settings.xml is a XML file that contains the current configuration for the addon and should be placed in the resources direcory (my.addon.id/resources/settings.xml). If your addon has
configurable items that are set by the user, put them here. This file defines what the user sees
when they click on Addon settings for your addon. You don't need to do any coding to utilise this functionality.
The format for the settings file is relatively straightforward as can be seen in the following example:

Example code:
<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<settings>
<category label="32001">
<setting label="32011" type="text" id="username" default=""/>
<setting label="32012" type="text" id="password" option="hidden" enable="!eq(-1,)" default=""/>
<setting label="32053" type="slider" id="limit" subsetting="true" default="20" range="5,5,100" option="int" />
<setting type="sep"/>
<setting id="debug" type="bool" label="32013" default="false"/>
</category>
<category label="32010">
<setting label="32032" type="action" action="RunScript(my.addon.id, downloadreport)"/>
</category>
</settings>
</syntaxhighlight>

You need to supply at least one category element.
The label attribute of both categories and settings should be the id of a language string in your language files or the one of the main Kodi language file.

There are some functionality not cover by this wiki page. See C++ source:
https://github.com/xbmc/xbmc/tree/master/xbmc/addons/settings/GUIDialogAddonSettings.cpp

== Elements ==

=== Separators ===
Separators are purely user-interface elements that do not allow user input and therefore have no meaningful value as a setting.

==== type="sep" ====
A line separator, it adds a horizontal line that is useful to separate groups of settings.

Example code:
<syntaxhighlight lang="xml" enclose="div">
<setting type="sep"/>
</syntaxhighlight>

==== type="lsep" ====
A label separator, it adds a heading text that can be used to display on top of a group of settings.

Attributes:
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.

Example code:
<syntaxhighlight lang="xml" enclose="div">
<setting label="32032" type="lsep"/>
</syntaxhighlight>

=== Text input ===
Text input elements allow a user to input text in various formats. The "label" attribute must contain an id from the language file that indicates which text to display for the input field.

==== type="text" ====
Allow a user to enter one line of text.

Attributes:
* '''id="''string''"''' (required) - the name of the setting.
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* option="hidden"|"urlencoded" (optional)
:if set to "hidden", each characters entered by the user will be obfuscated with an asterisks ("*"), as is usual for entering passwords.
:if set to "urlencoded", each non-alphanumeric characters entered by the user will be "escaped" using %XX encoding.
* default="''value''" (optional) - the default value.

Example code:
<syntaxhighlight lang="xml" enclose="div">
<setting label="32033" type="text" id="username" />
</syntaxhighlight>

The value entered by the user is saved as a string value on disk:
<syntaxhighlight lang="xml" enclose="div">
<setting id="username" value="john.doe" />
</syntaxhighlight>
{{Note|Security consideration: when using <nowiki>option="hidden"</nowiki>, the value entered by the user is still saved as an unencrypted string value on disk.}}

==== type="ipaddress" ====
Allow a user to enter an ip address as text.

Attributes:
* '''id="''string''"''' (required) - the name of the setting.
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* default="''value''" (optional) - the default value.

Example code:
<syntaxhighlight lang="xml" enclose="div">
<setting label="32035" type="ipaddress" id="ipaddress"/>
</syntaxhighlight>

The value entered by the user is saved as a string value on disk:
<syntaxhighlight lang="xml" enclose="div">
<setting id="ipaddress" value="127.0.0.1" />
</syntaxhighlight>

=== Numeric input ===
Numeric input elements allow a user to enter a number. The "label" attribute must contain an id from the language file that indicates which text to display for the input field.

==== type="number" ====
Allows the user to enter an integer using up/down buttons.

Attributes:
* '''id="''string''"''' (required) - the name of the setting.
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* default="''value''" (optional) - the default value.

Example code:
<syntaxhighlight lang="xml" enclose="div">
<setting label="32036" type="number" id="code"/>
</syntaxhighlight>

The value entered by the user is saved as a string value on disk:
<syntaxhighlight lang="xml" enclose="div">
<setting id="code" value="127000" />
</syntaxhighlight>

{{Note|In Python, calling xbmcplugin.getSetting will return the number as a string value, which must be converted to an integer value if needed}}

=== Date and time input ===
==== type="date" ====
Attributes:
* '''id="''string''"''' (required) - the name of the setting
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display or string
* default="2015-03-12" (optional) - the default value.

Example code:
<syntaxhighlight lang="xml" enclose="div">
<setting id="record_date" type="date" label="32030" default="2015-03-12"/>
</syntaxhighlight>

==== type="time" ====
Attributes:
* '''id="''string''"''' (required) - the name of the setting
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display or string
* default="13:13" (optional) - the default value.

Example code:
<syntaxhighlight lang="xml" enclose="div">
<setting id="record_time" type="time" label="32031" default="13:13"/>
</syntaxhighlight>

=== Boolean ===
Boolean input elements allow a user to switch a setting on or off.

==== type="bool" ====
Attributes:
* '''id="''string''"''' (required) - the name of the setting
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* default="true"|"false" (optional) - the default value.

Example code:
<syntaxhighlight lang="xml" enclose="div">
<setting label="32033" type="bool" id="background" default="false"/>
</syntaxhighlight>

{{Note|"true" and "false" are case sensitive!}}

The value entered by the user is saved as a string "true" or "false":
<syntaxhighlight lang="xml" enclose="div">
<setting id="background" value="false" />
</syntaxhighlight>

{{Note|In Python, calling xbmcplugin.getSetting will return a string "true" or "false", which must be converted to a boolean value if needed}}

=== Select dialog ===
Will open separate selection window

==== type="select" ====
* '''id="''string''"''' (required) - the name of the setting
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* '''values="''value1''[|''value2''[...]]" - or -
* '''lvalues="''id1''[|''id2''[...]]" (required): A list of values or language file ids from which the user can choose.
<syntaxhighlight lang="xml" enclose="div">
<setting id="id_select" type="select" label="32000" lvalues="32001|32002|32003|32004" />
</syntaxhighlight>

==== type="addon" ====
* '''id="''string''"''' (required) - the name of the setting
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* '''addontype="''xbmc.metadata.scraper.movies''"''' (required) - type of addon.
* multiselect="''true|false''" (optional) - allows to select several addons
<syntaxhighlight lang="xml" enclose="div">
<setting id="id_addon" type="addon" label="32111" default="" addontype="xbmc.metadata.scraper.movies" multiselect="true" />
</syntaxhighlight>

=== Spinner ===
A rotary selector allows the user to selected from a list of predefined values.

==== type="enum" or "labelenum" ====
Both element types work the same except that the "enum" type will use the index of the chosen value, wheras the "labelenum" will use the actual value.

Arguments:
* '''id="''string''"''' (required) - the name of the setting
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* '''values="''value1''[|''value2''[...]]" - or -
* '''lvalues="''id1''[|''id2''[...]]" (required):
: A list of values or language file ids from which the user can choose.
* values="$HOURS" is special case to select hour
* sort="yes" - sorts labels ( works only for type="labelenum" )

Example code:
<syntaxhighlight lang="xml" enclose="div">
<setting label="32018" type="enum" id="service1" lvalues="32021|32022|32023|32024"/>
<setting label="32020" type="labelenum" id="service3" lvalues="32021|32022|32023|32024"/>
<setting label="32022" type="enum" id="default_enumhours" values="$HOURS" />
</syntaxhighlight>

* Selecting the value "One" will return the int value "0", selecting the value "Two" will return the int value "1", etc.

The value entered by the user is saved as a string. For "enum"-type settings the index of the value is saved, starting at 0 for the first value. For "labelenum"-type settings the value is saved or, in case the lvalues attribute is used, the label translated in the language of the user.
<syntaxhighlight lang="xml" enclose="div">
<setting id="service1" value="0" />
<setting id="service3" value="SomethingTranslated" />
</syntaxhighlight>

=== Slider ===
Will display a slider control
==== type="slider" ====
Allows the user to select a numberic value using a horizontal sliding bar.

Example:
<syntaxhighlight lang="xml" enclose="div">
<setting label="32053" type="slider" id="limit" default="20" range="5,5,100" option="int" />
<setting label="32053" type="slider" id="limit" default="20" range="0,100"/>
</syntaxhighlight>

Attributes:
* '''id="''string''"''' (required) - the name of the setting.
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* '''range="''min''[,''step''],''max''"''' (required) - specify the range of valid values.
* '''option="int"|"float"|"percent"''' (required) - specifies whether to allow the user to choose between integers, floating point numbers or a percentage.
* default="''value''" (optional) - the default value.

The value entered by the user is saved as a string representation of a floating point value on disk:
<syntaxhighlight lang="xml" enclose="div">
<setting id="limit" value="5.000000" />
</syntaxhighlight>

{{Note|In Python, calling xbmcplugin.getSetting will return a string, which must be converted to an int, float or percentage value if needed}}

=== Browser dialog ===
File and folder browsing elements allow a user to select a file or folder by browsing the local disks or network. You can specify a media type to show only files of the chosen type to the user. The "label" attribute must contain an id from the language file that indicates which text to display for the input field.

==== type="file", "audio", "video", "image" or "executable" ====
Allow the user to browse for and select a file. When using type="audio", "video", "image" or "executable", only files of those types are displayed to the user.

Attributes:
* '''id="''string''"''' (required) - the name of the setting
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* default="''value''" (optional) - the default value.

Example code:
<syntaxhighlight lang="xml" enclose="div">
<setting label="32033" type="file" id="file" default="path_to_files"/>
</syntaxhighlight>

The full path to the file selected by the user is saved as a string value on disk:
<syntaxhighlight lang="xml" enclose="div">
<setting id="file" value="smb://path_to_files/file.ext" />
</syntaxhighlight>

==== type="folder" ====
Allow the user to browse for and select a folder.

* '''id="''string''"''' (required) - the name of the setting
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* source="video", "music", "pictures", "programs", "files", "local" or blank - will show the respective folders from sources.xml in the browse dialog. source="" will list both local drives and network shares.
* default="''value''" (optional, default="") - the default value.
* option="writeable" (optional, default="") - the user can be allowed to create and select new folders by setting this argument.

Example code:
<syntaxhighlight lang="xml" enclose="div">
<setting label="32033" type="folder" id="folder" source="auto" option="writeable"/>
</syntaxhighlight>

The full path to the folder selected by the user is saved as a string value on disk:
<syntaxhighlight lang="xml" enclose="div">
<setting id="folder" value="smb://path_to_files/"/>
</syntaxhighlight>

==== type="fileenum" ====
Display files in a folder as an enum selector.

Example: List sub-folders of the 'resources' folder for this add-on in the settings.

<syntaxhighlight lang="xml" enclose="div">
<setting label="32000" id="myenum" type="fileenum" values="resources" mask="/" />
</syntaxhighlight>

==== Extra attributes ====

* mask="''value''" - filter selectable files. Examples: "/" - display only folders. "*.txt" - display only .txt files.
* option="hideext" - hide file extensions.

=== Action execution ===
==== type = "action" ====

Adds line to configuration windows which allow to execute action

Example code:
<syntaxhighlight lang="xml" enclose="div">
<setting label="32032" type="action" action="RunScript(my.addon.id, downloadreport)"/>
</syntaxhighlight>

List of actions that can be used:
* [[List of built-in functions]]

Attributes:
* option="close" (close the settings dialog before executing the action)

== Conditions ==

'''Settings can optionally have a visible and/or enable attribute:'''
{| class="prettytable" border="0"
|-
| visible="" || "true", "false" or conditional.<br />Determines if the setting is displayed in the settings dialog (default = 'true')"<br />
|-
| enable="" || "true", "false" or conditional.<br />Allows you to determine whether this setting should be shown as greyed-out and unable to be changed.
|-
| conditions || 3 comparators are available to allow a setting to be made visible or enabled based on other settings:
* eq() Equal to
* gt() Greater than
* lt() Less than

One can AND the comparators using the + symbol, and OR the comparators using the | symbol. A combination of AND and OR is not currently supported.

One can negate a comparator using the ! symbol (e.g. !eq() ).

Each comparator takes 2 operands:
* Relative position of setting to compare
* Value to compare against

Thus if we place settings in our file in this order:
: myFirstSetting
: mySecondSetting
: myThirdSetting

for the third setting we might add the option:<br />
enable="gt(-2,3) + lt(-2,8)"<br /><br />
You can also use a conditional statement: enable="System.HasAddon(plugin.video.youtube)"

Comparisons CANNOT be made across category/page boundaries. If one needs to compare to a setting on a different page, a copy of the setting with the same id can be placed on the page where the comparison is to take place and then hidden by setting visible to 'false'. The value is automatically updated when the setting on the other page is updated.
|}

==Subsettings==

You can create a subsetting by adding '''subsetting="true"''' to a setting.
This will add dash in front of the setting.

[[Category:Add-ons|*]]
[[Category:Settings]]
[[Category:Add-on development]]
[[Category:Skin development]]
[[Category:Development]]

Add-on settings

2019-12-29T09:39:55Z

Kambala: fixed URL to C++ source

{{note|Deprecated - Addons submitted to the Kodi 19 Matrix (and up) can use the new setting format. see [[Add-on_settings_conversion]]}}

{{mininav|[[Development]]|[[Add-on development]]}}<br />

{{see also|Python development}}

== Description ==

settings.xml is a XML file that contains the current configuration for the addon and should be placed in the resources direcory (my.addon.id/resources/settings.xml). If your addon has
configurable items that are set by the user, put them here. This file defines what the user sees
when they click on Addon settings for your addon. You don't need to do any coding to utilise this functionality.
The format for the settings file is relatively straightforward as can be seen in the following example:

Example code:
<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<settings>
<category label="32001">
<setting label="32011" type="text" id="username" default=""/>
<setting label="32012" type="text" id="password" option="hidden" enable="!eq(-1,)" default=""/>
<setting label="32053" type="slider" id="limit" subsetting="true" default="20" range="5,5,100" option="int" />
<setting type="sep"/>
<setting id="debug" type="bool" label="32013" default="false"/>
</category>
<category label="32010">
<setting label="32032" type="action" action="RunScript(my.addon.id, downloadreport)"/>
</category>
</settings>
</syntaxhighlight>

You need to supply at least one category element.
The label attribute of both categories and settings should be the id of a language string in your language files or the one of the main Kodi language file.

There are some functionality not cover by this wiki page. See C++ source:
https://github.com/xbmc/xbmc/tree/master/xbmc/addons/settings/GUIDialogAddonSettings.cpp

== Elements ==

=== Separators ===
Separators are purely user-interface elements that do not allow user input and therefore have no meaningful value as a setting.

==== type="sep" ====
A line separator, it adds a horizontal line that is useful to separate groups of settings.

Example code:
<syntaxhighlight lang="xml" enclose="div">
<setting type="sep"/>
</syntaxhighlight>

==== type="lsep" ====
A label separator, it adds a heading text that can be used to display on top of a group of settings.

Attributes:
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.

Example code:
<syntaxhighlight lang="xml" enclose="div">
<setting label="32032" type="lsep"/>
</syntaxhighlight>

=== Text input ===
Text input elements allow a user to input text in various formats. The "label" attribute must contain an id from the language file that indicates which text to display for the input field.

==== type="text" ====
Allow a user to enter one line of text.

Attributes:
* '''id="''string''"''' (required) - the name of the setting.
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* option="hidden"|"urlencoded" (optional)
:if set to "hidden", each characters entered by the user will be obfuscated with an asterisks ("*"), as is usual for entering passwords.
:if set to "urlencoded", each non-alphanumeric characters entered by the user will be "escaped" using %XX encoding.
* default="''value''" (optional) - the default value.

Example code:
<syntaxhighlight lang="xml" enclose="div">
<setting label="32033" type="text" id="username" />
</syntaxhighlight>

The value entered by the user is saved as a string value on disk:
<syntaxhighlight lang="xml" enclose="div">
<setting id="username" value="john.doe" />
</syntaxhighlight>
{{Note|Security consideration: when using <nowiki>option="hidden"</nowiki>, the value entered by the user is still saved as an unencrypted string value on disk.}}

==== type="ipaddress" ====
Allow a user to enter an ip address as text.

Attributes:
* '''id="''string''"''' (required) - the name of the setting.
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* default="''value''" (optional) - the default value.

Example code:
<syntaxhighlight lang="xml" enclose="div">
<setting label="32035" type="ipaddress" id="ipaddress"/>
</syntaxhighlight>

The value entered by the user is saved as a string value on disk:
<syntaxhighlight lang="xml" enclose="div">
<setting id="ipaddress" value="127.0.0.1" />
</syntaxhighlight>

=== Numeric input ===
Numeric input elements allow a user to enter a number. The "label" attribute must contain an id from the language file that indicates which text to display for the input field.

==== type="number" ====
Allows the user to enter an integer using up/down buttons.

Attributes:
* '''id="''string''"''' (required) - the name of the setting.
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* default="''value''" (optional) - the default value.

Example code:
<syntaxhighlight lang="xml" enclose="div">
<setting label="32036" type="number" id="code"/>
</syntaxhighlight>

The value entered by the user is saved as a string value on disk:
<syntaxhighlight lang="xml" enclose="div">
<setting id="code" value="127000" />
</syntaxhighlight>

{{Note|In Python, calling xbmcplugin.getSetting will return the number as a string value, which must be converted to an integer value if needed}}

=== Date and time input ===
==== type="date" ====
Attributes:
* '''id="''string''"''' (required) - the name of the setting
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display or string
* default="2015-03-12" (optional) - the default value.

Example code:
<syntaxhighlight lang="xml" enclose="div">
<setting id="record_date" type="date" label="32030" default="2015-03-12"/>
</syntaxhighlight>

==== type="time" ====
Attributes:
* '''id="''string''"''' (required) - the name of the setting
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display or string
* default="13:13" (optional) - the default value.

Example code:
<syntaxhighlight lang="xml" enclose="div">
<setting id="record_time" type="time" label="32031" default="13:13"/>
</syntaxhighlight>

=== Boolean ===
Boolean input elements allow a user to switch a setting on or off.

==== type="bool" ====
Attributes:
* '''id="''string''"''' (required) - the name of the setting
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* default="true"|"false" (optional) - the default value.

Example code:
<syntaxhighlight lang="xml" enclose="div">
<setting label="32033" type="bool" id="background" default="false"/>
</syntaxhighlight>

{{Note|"true" and "false" are case sensitive!}}

The value entered by the user is saved as a string "true" or "false":
<syntaxhighlight lang="xml" enclose="div">
<setting id="background" value="false" />
</syntaxhighlight>

{{Note|In Python, calling xbmcplugin.getSetting will return a string "true" or "false", which must be converted to a boolean value if needed}}

=== Select dialog ===
Will open separate selection window

==== type="select" ====
* '''id="''string''"''' (required) - the name of the setting
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* '''values="''value1''[|''value2''[...]]" - or -
* '''lvalues="''id1''[|''id2''[...]]" (required): A list of values or language file ids from which the user can choose.
<syntaxhighlight lang="xml" enclose="div">
<setting id="id_select" type="select" label="32000" lvalues="32001|32002|32003|32004" />
</syntaxhighlight>

==== type="addon" ====
* '''id="''string''"''' (required) - the name of the setting
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* '''addontype="''xbmc.metadata.scraper.movies''"''' (required) - type of addon.
* multiselect="''true|false''" (optional) - allows to select several addons
<syntaxhighlight lang="xml" enclose="div">
<setting id="id_addon" type="addon" label="32111" default="" addontype="xbmc.metadata.scraper.movies" multiselect="true" />
</syntaxhighlight>

=== Spinner ===
A rotary selector allows the user to selected from a list of predefined values.

==== type="enum" or "labelenum" ====
Both element types work the same except that the "enum" type will use the index of the chosen value, wheras the "labelenum" will use the actual value.

Arguments:
* '''id="''string''"''' (required) - the name of the setting
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* '''values="''value1''[|''value2''[...]]" - or -
* '''lvalues="''id1''[|''id2''[...]]" (required):
: A list of values or language file ids from which the user can choose.
* values="$HOURS" is special case to select hour
* sort="yes" - sorts labels ( works only for type="labelenum" )

Example code:
<syntaxhighlight lang="xml" enclose="div">
<setting label="32018" type="enum" id="service1" lvalues="32021|32022|32023|32024"/>
<setting label="32020" type="labelenum" id="service3" lvalues="32021|32022|32023|32024"/>
<setting label="32022" type="enum" id="default_enumhours" values="$HOURS" />
</syntaxhighlight>

* Selecting the value "One" will return the int value "0", selecting the value "Two" will return the int value "1", etc.

The value entered by the user is saved as a string. For "enum"-type settings the index of the value is saved, starting at 0 for the first value. For "labelenum"-type settings the value is saved or, in case the lvalues attribute is used, the label translated in the language of the user.
<syntaxhighlight lang="xml" enclose="div">
<setting id="service1" value="0" />
<setting id="service3" value="SomethingTranslated" />
</syntaxhighlight>

=== Slider ===
Will display a slider control
==== type="slider" ====
Allows the user to select a numberic value using a horizontal sliding bar.

Example:
<syntaxhighlight lang="xml" enclose="div">
<setting label="32053" type="slider" id="limit" default="20" range="5,5,100" option="int" />
<setting label="32053" type="slider" id="limit" default="20" range="0,100"/>
</syntaxhighlight>

Attributes:
* '''id="''string''"''' (required) - the name of the setting.
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* '''range="''min''[,''step''],''max''"''' (required) - specify the range of valid values.
* '''option="int"|"float"|"percent"''' (required) - specifies whether to allow the user to choose between integers, floating point numbers or a percentage.
* default="''value''" (optional) - the default value.

The value entered by the user is saved as a string representation of a floating point value on disk:
<syntaxhighlight lang="xml" enclose="div">
<setting id="limit" value="5.000000" />
</syntaxhighlight>

{{Note|In Python, calling xbmcplugin.getSetting will return a string, which must be converted to an int, float or percentage value if needed}}

=== Browser dialog ===
File and folder browsing elements allow a user to select a file or folder by browsing the local disks or network. You can specify a media type to show only files of the chosen type to the user. The "label" attribute must contain an id from the language file that indicates which text to display for the input field.

==== type="file", "audio", "video", "image" or "executable" ====
Allow the user to browse for and select a file. When using type="audio", "video", "image" or "executable", only files of those types are displayed to the user.

Attributes:
* '''id="''string''"''' (required) - the name of the setting
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* default="''value''" (optional) - the default value.

Example code:
<syntaxhighlight lang="xml" enclose="div">
<setting label="32033" type="file" id="file" default="path_to_files"/>
</syntaxhighlight>

The full path to the file selected by the user is saved as a string value on disk:
<syntaxhighlight lang="xml" enclose="div">
<setting id="file" value="smb://path_to_files/file.ext" />
</syntaxhighlight>

==== type="folder" ====
Allow the user to browse for and select a folder.

* '''id="''string''"''' (required) - the name of the setting
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* source="video", "music", "pictures", "programs", "files", "local" or blank - will show the respective folders from sources.xml in the browse dialog. source="" will list both local drives and network shares.
* default="''value''" (optional, default="") - the default value.
* option="writeable" (optional, default="") - the user can be allowed to create and select new folders by setting this argument.

Example code:
<syntaxhighlight lang="xml" enclose="div">
<setting label="32033" type="folder" id="folder" source="auto" option="writeable"/>
</syntaxhighlight>

The full path to the folder selected by the user is saved as a string value on disk:
<syntaxhighlight lang="xml" enclose="div">
<setting id="folder" value="smb://path_to_files/"/>
</syntaxhighlight>

==== type="fileenum" ====
Display files in a folder as an enum selector.

Example: List sub-folders of the 'resources' folder for this add-on in the settings.

<syntaxhighlight lang="xml" enclose="div">
<setting label="32000" id="myenum" type="fileenum" values="resources" mask="/" />
</syntaxhighlight>

==== Extra attributes ====

* mask="''value''" - filter selectable files. Examples: "/" - display only folders. "*.txt" - display only .txt files.
* option="hideext" - hide file extensions.

=== Action execution ===
==== type = "action" ====

Adds line to configuration windows which allow to execute action

Example code:
<syntaxhighlight lang="xml" enclose="div">
<setting label="32032" type="action" action="RunScript(my.addon.id, downloadreport)"/>
</syntaxhighlight>

List of actions that can be used:
* [[List of built-in functions]]

Attributes:
* option="close" (close the settings dialog before executing the action)

== Conditions ==

'''Settings can optionally have a visible and/or enable attribute:'''
{| class="prettytable" border="0"
|-
| visible="" || "true", "false" or conditional.<br />Determines if the setting is displayed in the settings dialog (default = 'true')"<br />
|-
| enable="" || "true", "false" or conditional.<br />Allows you to determine whether this setting should be shown as greyed-out and unable to be changed.
|-
| conditions || 3 comparators are available to allow a setting to be made visible or enabled based on other settings:
* eq() Equal to
* gt() Greater than
* lt() Less than

One can AND the comparators using the + symbol, and OR the comparators using the | symbol. A combination of AND and OR is not currently supported.

One can negate a comparator using the ! symbol (e.g. !eq() ).

Each comparator takes 2 operands:
* Relative position of setting to compare
* Value to compare against

Thus if we place settings in our file in this order:
: myFirst setting
: mySecondSetting
: myThirdSetting

for the third setting we might add the option:<br />
enable="gt(-2,3) + lt(-2,8)"<br /><br />
You can also use a conditional statement: enable="System.HasAddon(plugin.video.youtube)"

Comparisons CANNOT be made across category/page boundaries. If one needs to compare to a setting on a different page, a copy of the setting with the same id can be placed on the page where the comparison is to take place and then hidden by setting visible to 'false'. The value is automatically updated when the setting on the other page is updated.
|}

==Subsettings==

You can create a subsetting by adding '''subsetting="true"''' to a setting.
This will add dash in front of the setting.

[[Category:Add-ons|*]]
[[Category:Settings]]
[[Category:Add-on development]]
[[Category:Skin development]]
[[Category:Development]]

Log file/iOS native sharing

2019-10-11T19:39:03Z

Kambala: Created page with "{{Warning |Available only since Kodi '''v19'''!}} == Introduction == This page describes another method to access the '''''log file''''' using the native iOS sharing shee..."

{{Warning |Available only since Kodi '''v19'''!}}

== Introduction ==
This page describes another method to access the '''''[[log file]]''''' using the native iOS sharing sheet. It's shared as an ordinary file, so, for example, it will be an email attachment.

== Steps ==
# Navigate to Logging settings located at '''''[[Settings/System/Logging#Debug|Settings > System Settings > Logging]]'''''.
# Tap last entry in the first section: '''Share debug log'''.
# Native sharing sheet is presented, select the sharing method you like.

[[File:logging-settings.png]]

File:Logging-settings.png

2019-10-11T19:19:01Z

Kambala: File uploaded with MsUpload

File uploaded with MsUpload