Official Kodi Wiki - User contributions [en]

Audio-video add-on tutorial

2016-01-10T09:35:42Z

SimpleKodi: Added a Video Tutorial

{{mininav|[[Development]]|[[Add-on development]]}}

This page will outline the basics of creating your first Python add-on for Kodi. It assumes you're at least familiar with the basics of Python (or at least, programming in general). If not, we recommend visiting the [http://docs.python.org/2/tutorial/ Python tutorial] first, and then returning here.

=Video Tutorial=
{{youtube|FtQgZ2bxFkk}}

[https://youtu.be/FtQgZ2bxFkk Video's Description.]

*This video will help you make a video add-on for Kodi. The video's steps might be different from the written tutorial below.

= Before we get started =
{{See also|Add-on structure}}

The first step to making an add-on is to put the basic structure in place. Make sure your directory is properly named, e.g. <code>plugin.video.my-addon</code>, and that you have a properly-constructed <code>[[addon.xml]]</code> file. Once these are done, you can get started writing the actual code for your add-on!

= Hello, World! =

The simplest form of Python add-on is one that gets run, adds some list items, and exits to let Kodi take over the navigation; people who have written server-side code for the web should be familiar with how this works. (More complex add-ons can process user input in real-time, but we'll discuss those later.) Let's start by looking at an extremely basic example script:

<syntaxhighlight lang="python" enclose="div">
import sys
import xbmcgui
import xbmcplugin

addon_handle = int(sys.argv[1])

xbmcplugin.setContent(addon_handle, 'movies')

url = 'http://localhost/some_video.mkv'
li = xbmcgui.ListItem('My First Video!', iconImage='DefaultVideo.png')
xbmcplugin.addDirectoryItem(handle=addon_handle, url=url, listitem=li)

xbmcplugin.endOfDirectory(addon_handle)
</syntaxhighlight>

While not particularly exciting, this shows the minimal amount of code you need to get an Kodi add-on up and running in Python. First, we get the add-on's process handle from <code>sys.argv[1]</code>. We need this to tell Kodi who we are. Next, we tell Kodi that we're going to show a list of <code>'movies'</code>. There are other options, like <code>'audio'</code> or <code>'episodes'</code>; these just change some details of how Kodi presents your add-on.

The most important part is that we create an <code>xbmcgui.ListItem</code> with the name and icon we want (<code>'DefaultVideo.png'</code> comes from the Kodi skin), set it to be a video item, and then add it to the directory. Once we're done adding items, we need to be sure to call <code>xbmcplugin.endOfDirectory</code> to let Kodi know we're done!

= Navigating between pages =

While the first example might be enough for extremely simple add-ons, most add-ons will want to have the ability to navigate between different pages. Most add-ons are designed to imitate a folder hierarchy where opening folder items shows a different list of items, and going "up" returns you to the parent folder.

== Retrieving arguments ==

As we saw in the first example, Kodi passes some arguments to us via <code>sys.argv</code>. This is important, since it's what will let us tailor the output on the add-on based on user input. Remember, much like a web site, each folder (or page) in an Kodi add-on is the result of a separate invocation of our script. The arguments available to us are:

{| class="prettytable"
! Index !! Description
|-
| 0 || The base URL of your add-on, e.g. <code>'plugin://plugin.video.myaddon/'</code>
|-
| 1 || The process handle for this add-on, as a numeric string
|-
| 2 || The query string passed to your add-on, e.g. <code>'?foo=bar&baz=quux'</code>
|}

Of particular interest is <code>sys.argv[2]</code>, which is what we'll generally use to show different things in the add-on.

=== Multiple content types ===
{{See also|Addon.xml#<provides> element}}

If your add-on provides multiple content types, e.g. <code>audio</code> and <code>video</code>, when the user invokes your add-on from the add-on list, Kodi will add a <code>content_type</code> parameter to your add-on's query string. For example: <code>'?content_type=audio'</code>. This will allow you to modify the output depending on what context your add-on was invoked in.

== Passing arguments ==

Now that we know how to retrieve the arguments passed to our add-on, we'll have to actually pass some along to it. Generally speaking, this involves creating a folder <code>ListItem</code> with a URL back to your add-on; then the next invocation of the add-on will parse those arguments and do something with them. Let's look at another brief example that adds some folders to let the user navigate between different pages of the add-on:

<syntaxhighlight lang="python" enclose="div">
import sys
import urllib
import urlparse
import xbmcgui
import xbmcplugin

base_url = sys.argv[0]
addon_handle = int(sys.argv[1])
args = urlparse.parse_qs(sys.argv[2][1:])

xbmcplugin.setContent(addon_handle, 'movies')

def build_url(query):
return base_url + '?' + urllib.urlencode(query)

mode = args.get('mode', None)

if mode is None:
url = build_url({'mode': 'folder', 'foldername': 'Folder One'})
li = xbmcgui.ListItem('Folder One', iconImage='DefaultFolder.png')
xbmcplugin.addDirectoryItem(handle=addon_handle, url=url,
listitem=li, isFolder=True)

url = build_url({'mode': 'folder', 'foldername': 'Folder Two'})
li = xbmcgui.ListItem('Folder Two', iconImage='DefaultFolder.png')
xbmcplugin.addDirectoryItem(handle=addon_handle, url=url,
listitem=li, isFolder=True)

xbmcplugin.endOfDirectory(addon_handle)

elif mode[0] == 'folder':
foldername = args['foldername'][0]
url = 'http://localhost/some_video.mkv'
li = xbmcgui.ListItem(foldername + ' Video', iconImage='DefaultVideo.png')
xbmcplugin.addDirectoryItem(handle=addon_handle, url=url, listitem=li)
xbmcplugin.endOfDirectory(addon_handle)
</syntaxhighlight>

As you can see, many parts of our code are very similar to the first example. There are a few important additions, however. First, we want to respond to the arguments supplied to our script, so we parse the query string with:

<syntaxhighlight lang="python" enclose="div">
urlparse.parse_qs(sys.argv[2][1:])
</syntaxhighlight>

We skip the first character, since it's always <code>'?'</code>. This will give us a <code>dict</code> of <code>list</code>s; for example, <code>'?foo=bar&foo=baz&quux=spam'</code> would be converted to <code>{'foo': ['bar', 'baz'], 'quux': ['spam']}</code>. With this information, we can tailor the output of our add-on to the supplied arguments.

We also need to be able to create links back to our add-on in order to display related pages (e.g. subfolders). We can do this by creating an <code>xbmc.ListItem</code>, passing <code>isFolder=True</code>, and setting the URL of the item to point back to our add-on. We create the URL in the helper function <code>build_url()</code>, which gives us a URL that looks something like:

plugin://plugin.video.myaddon/?mode=folder&foldername=Folder+One

= Working with user settings =
{{See also|Add-on settings}}

Your add-on may require some configurable options for the user (e.g. login credentials for a service). These can be stored as settings. To use settings with your add-on, you'll need to make a file defining the settings in <code>resources/settings.xml</code>. For example:

<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<settings>
<setting id="my_setting" type="bool" default="true" label="My Setting"/>
</settings>
</syntaxhighlight>

This will allow the user to open the settings for your add-on and modify this setting as needed. Then, in your add-on, you can retrieve or set this setting with the following code:

<syntaxhighlight lang="python" enclose="div">
my_addon = xbmcaddon.Addon()
my_setting = my_addon.getSetting('my_setting') # returns the string 'true' or 'false'
my_addon.setSetting('my_setting', 'false')
</syntaxhighlight>

= Showing additional metadata =

We've already seen how to show some basic metadata, like the icon image and the type of the item (<code>'video'</code> in our case). However, there are many more pieces of metadata that Kodi understands, and adding them can make life easier on your users. We'll take a look at some of the more important ones. You can also find a full list in the [http://mirrors.kodi.tv/docs/python-docs/ Python documentation] for <code>[http://mirrors.kodi.tv/docs/python-docs/16.x-jarvis/xbmcgui.html#ListItem xbmcgui.ListItem]</code>.

== Icons, thumbnails and artwork ==

Our previous examples already showed how to set an icon, but you can also set a thumbnail, fanart (full-screen background images) and other artwork. They can be set with the <code>ListItem.setArt</code> method:

<syntaxhighlight lang="python" enclose="div">
li = xbmcgui.ListItem(label='My video')
li.setIconImage('icon.png')
li.setArt({'thumb': 'thumbnail.jpg', 'poster': 'poster.jpg' 'fanart': 'fanart.jpg'})
</syntaxhighlight>

{{Note|In Kodi Isengard and earlier the 'icon' type is not available for setArt. You must use <code>ListItem.setIconImage(...)</code>}}

If you'd prefer to show the default fanart from your add-on, you can get the path to that image from the <code>[http://mirrors.kodi.tv/docs/python-docs/16.x-jarvis/xbmcaddon.html#Addon xbmcaddon.Addon]</code> object:

<syntaxhighlight lang="python" enclose="div">
my_addon = xbmcaddon.Addon('plugin.video.myaddon')
# ...
li.setArt({'fanart': my_addon.getAddonInfo('fanart')})
</syntaxhighlight>

== Info labels ==

Kodi also lets you add useful information about each list item, like the cast, episode number, play count, and duration. The specific fields available depend on whether your list item is video, audio, or a picture. In all cases though, the format is roughly the same. For example, to add info labels to a movie, you might do the following:

<syntaxhighlight lang="python" enclose="div">
info = {
'genre': 'Horror',
'year': 1979,
'title': 'Alien',
}
li.setInfo('video', info)
</syntaxhighlight>

For a full list of the available info labels, consult the documentation for <code>[http://mirrors.kodi.tv/docs/python-docs/16.x-jarvis/xbmcgui.html#ListItem-setInfo ListItem.setInfo]</code>.

== Stream info ==

In addition to metadata about the file's contents, you can add information about the audio/video streams themselves. For a video, you might do the following:

<syntaxhighlight lang="python" enclose="div">
video_info = {
'codec': 'h264',
'aspect': 1.78,
'width': 1280,
'height': 720,
}
li.addStreamInfo('video', video_info)
li.addStreamInfo('audio', {'codec': 'dts', 'language': 'en', 'channels': 2})
li.addStreamInfo('subtitle', {'language': 'en'})
</syntaxhighlight>

For complete documentation about this function, see <code>[http://mirrors.kodi.tv/docs/python-docs/16.x-jarvis/xbmcgui.html#ListItem-addStreamInfo ListItem.addStreamInfo]</code>.

= Adding context menus =

In addition to the default action for a list item (e.g. playing the video), your add-on can provide additional actions for an item in the context menu. Note that this only applies to list items in ''your'' add-on. Currently, you're not able to modify the context menu for movies in the user's library. To add a context menu item, you need to give it a label and a [[List of built-in functions|built-in function]] as a string:

<syntaxhighlight lang="python" enclose="div">
li.addContextMenuItems([ ('Refresh', 'Container.Refresh'),
('Go up', 'Action(ParentDir)') ])
</syntaxhighlight>

You can also elect to show ''only'' your context menu items:

<syntaxhighlight lang="python" enclose="div">
li.addContextMenuItems([ ('Refresh', 'Container.Refresh') ], replaceItems=True)
</syntaxhighlight>

[[Category:Add-on development|*]]

HOW-TO:Video addon

2016-01-10T09:32:33Z

SimpleKodi: Video Tutorial

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

=Video Tutorial=
{{youtube|FtQgZ2bxFkk}}

[https://youtu.be/FtQgZ2bxFkk Video's Description.]

*This video will help you make a video add-on for Kodi. The video's steps might be different from the written tutorial below.

=Introduction=
This tutorial will explain how to write your first Kodi/XBMC video plugin Add-on<br />

=Tools=
Assuming you have already followed the Hello World Add-on you will have a text editor already setup. Since we are dealing with videos this time its probably a good idea to have a video player setup. We recommend another great open source project for this

- VLC http://www.videolan.org/vlc/

=Installing=
For this example we will use 2 nice basic video Add-on tutorials You can find the source-code here:

https://github.com/romanvm/plugin.video.example

You can either download as a zip and install both of these inside the kodi GUI from the install from zip feature. Or extract the zip into your userdata/add-ons folder.

=Testing=
You can first give the add-on a test run by going to:
System >> Add-Ons >> Enabled Add-Ons >> Video Add-Ons >> Example Kodi video Plugin. You should now be able to watch some test videos hosted from an internet web server.

[[File:Videotutorial1.jpg]]

=Explanation=
So whats happening in this add-on?

Basically the Add-on is checking a website for the hosted videos. In this example we are directly linking to the videos, but there are possibilities for dynamic content and scraping of just about any online source

Once the video link is sent to Kodi, our video player takes over and buffers, then plays the video just like any other media.

=Structure=
main.py <-- This is the actual python code for your Add-On

addon.xml <-- This is the Add-Ons metadata

icon.png <-- A PNG icon for the add-on. It can be 256x256 or 512x512 pixels big. Try to make it look nice!

Readme.md <-- The readme text file with a description of the Add-on and install instructions. This shows on the front of the GitHub page and helps users to understand your Add-on before downloading.

=The Code=
So now we come to the actual Add-On code, this is where most of your Add-on is written and is a simple text file containing python code.

First we initialize the Add-on and import and bits we need

<syntaxhighlight lang="python" enclose="div">
import sys
from urlparse import parse_qsl
import xbmcgui
import xbmcplugin
</syntaxhighlight>

Now we do something else...

<syntaxhighlight lang="python" enclose="div">
# Get the plugin url in plugin:// notation.
__url__ = sys.argv[0]
# Get the plugin handle as an integer number.
__handle__ = int(sys.argv[1])
</syntaxhighlight>

Here we use a fixed set of properties simply for demonstrating purposes. In a "real life" plugin you will need to get info and links to video files/streams from some web-site or online service.

<syntaxhighlight lang="python" enclose="div">
VIDEOS = {'Animals': [{'name': 'Crab',
'thumb': 'http://www.vidsplay.com/vids/crab.jpg',
'video': 'http://www.vidsplay.com/vids/crab.mp4',
'genre': 'Animals'},
{'name': 'Alligator',
'thumb': 'http://www.vidsplay.com/vids/alligator.jpg',
'video': 'http://www.vidsplay.com/vids/alligator.mp4',
'genre': 'Animals'},
{'name': 'Turtle',
'thumb': 'http://www.vidsplay.com/vids/turtle.jpg',
'video': 'http://www.vidsplay.com/vids/turtle.mp4',
'genre': 'Animals'}
],
'Cars': [{'name': 'Postal Truck',
'thumb': 'http://www.vidsplay.com/vids/us_postal.jpg',
'video': 'http://www.vidsplay.com/vids/us_postal.mp4',
'genre': 'Cars'},
{'name': 'Traffic',
'thumb': 'http://www.vidsplay.com/vids/traffic1.jpg',
'video': 'http://www.vidsplay.com/vids/traffic1.avi',
'genre': 'Cars'},
{'name': 'Traffic Arrows',
'thumb': 'http://www.vidsplay.com/vids/traffic_arrows.jpg',
'video': 'http://www.vidsplay.com/vids/traffic_arrows.mp4',
'genre': 'Cars'}
],
'Food': [{'name': 'Chicken',
'thumb': 'http://www.vidsplay.com/vids/chicken.jpg',
'video': 'http://www.vidsplay.com/vids/bbqchicken.mp4',
'genre': 'Food'},
{'name': 'Hamburger',
'thumb': 'http://www.vidsplay.com/vids/hamburger.jpg',
'video': 'http://www.vidsplay.com/vids/hamburger.mp4',
'genre': 'Food'},
{'name': 'Pizza',
'thumb': 'http://www.vidsplay.com/vids/pizza.jpg',
'video': 'http://www.vidsplay.com/vids/pizza.mp4',
'genre': 'Food'}
]}
</syntaxhighlight>
And now we define something else...

<syntaxhighlight lang="python" enclose="div">
def get_categories():
"""
Get the list of video categories.
Here you can insert some parsing code that retrieves
the list of video categories (e.g. 'Movies', 'TV-shows', 'Documentaries' etc.)
from some site or server.
:return: list
"""
return VIDEOS.keys()
</syntaxhighlight>
And now we define something else...

<syntaxhighlight lang="python" enclose="div">
def get_videos(category):
"""
Get the list of videofiles/streams.
Here you can insert some parsing code that retrieves
the list of videostreams in a given category from some site or server.
:param category: str
:return: list
"""
return VIDEOS[category]
</syntaxhighlight>
And now we define the list of categories

<syntaxhighlight lang="python" enclose="div">
def list_categories():
"""
Create the list of video categories in the Kodi interface.
:return: None
"""
# Get video categories
categories = get_categories()
# Create a list for our items.
listing = []
# Iterate through categories
for category in categories:
# Create a list item with a text label and a thumbnail image.
list_item = xbmcgui.ListItem(label=category, thumbnailImage=VIDEOS[category][0]['thumb'])
# Set a fanart image for the list item.
# Here we use the same image as the thumbnail for simplicity's sake.
list_item.setProperty('fanart_image', VIDEOS[category][0]['thumb'])
# Set additional info for the list item.
# Here we use a category name for both properties for for simplicity's sake.
# setInfo allows to set various information for an item.
# For available properties see the following link:
# http://mirrors.xbmc.org/docs/python-docs/15.x-isengard/xbmcgui.html#ListItem-setInfo
list_item.setInfo('video', {'title': category, 'genre': category})
# Create a URL for the plugin recursive callback.
# Example: plugin://plugin.video.example/?action=listing&category=Animals
url = '{0}?action=listing&category={1}'.format(__url__, category)
# is_folder = True means that this item opens a sub-list of lower level items.
is_folder = True
# Add our item to the listing as a 3-element tuple.
listing.append((url, list_item, is_folder))
# Add our listing to Kodi.
# Large lists and/or slower systems benefit from adding all items at once via addDirectoryItems
# instead of adding one by ove via addDirectoryItem.
xbmcplugin.addDirectoryItems(__handle__, listing, len(listing))
# Add a sort method for the virtual folder items (alphabetically, ignore articles)
xbmcplugin.addSortMethod(__handle__, xbmcplugin.SORT_METHOD_LABEL_IGNORE_THE)
# Finish creating a virtual folder.
xbmcplugin.endOfDirectory(__handle__)
</syntaxhighlight>

And here we list the videos

<syntaxhighlight lang="python" enclose="div">
def list_videos(category):
"""
Create the list of playable videos in the Kodi interface.
:param category: str
:return: None
"""
# Get the list of videos in the category.
videos = get_videos(category)
# Create a list for our items.
listing = []
# Iterate through videos.
for video in videos:
# Create a list item with a text label and a thumbnail image.
list_item = xbmcgui.ListItem(label=video['name'], thumbnailImage=video['thumb'])
# Set a fanart image for the list item.
# Here we use the same image as the thumbnail for simplicity's sake.
list_item.setProperty('fanart_image', video['thumb'])
# Set additional info for the list item.
list_item.setInfo('video', {'title': video['name'], 'genre': video['genre']})
# Set 'IsPlayable' property to 'true'.
# This is mandatory for playable items!
list_item.setProperty('IsPlayable', 'true')
# Create a URL for the plugin recursive callback.
# Example: plugin://plugin.video.example/?action=play&video=http://www.vidsplay.com/vids/crab.mp4
url = '{0}?action=play&video={1}'.format(__url__, video['video'])
# Add the list item to a virtual Kodi folder.
# is_folder = False means that this item won't open any sub-list.
is_folder = False
# Add our item to the listing as a 3-element tuple.
listing.append((url, list_item, is_folder))
# Add our listing to Kodi.
# Large lists and/or slower systems benefit from adding all items at once via addDirectoryItems
# instead of adding one by ove via addDirectoryItem.
xbmcplugin.addDirectoryItems(__handle__, listing, len(listing))
# Add a sort method for the virtual folder items (alphabetically, ignore articles)
xbmcplugin.addSortMethod(__handle__, xbmcplugin.SORT_METHOD_LABEL_IGNORE_THE)
# Finish creating a virtual folder.
xbmcplugin.endOfDirectory(__handle__)
</syntaxhighlight>

Now we tell Kodi how to find the video path to play the videos

<syntaxhighlight lang="python" enclose="div">
def play_video(path):
"""
Play a video by the provided path.
:param path: str
:return: None
"""
# Create a playable item with a path to play.
play_item = xbmcgui.ListItem(path=path)
# Pass the item to the Kodi player.
xbmcplugin.setResolvedUrl(__handle__, True, listitem=play_item)
</syntaxhighlight>

This is the router function

<syntaxhighlight lang="python" enclose="div">
def router(paramstring):
"""
Router function that calls other functions
depending on the provided paramstring
:param paramstring:
:return:
"""
# Parse a URL-encoded paramstring to the dictionary of
# {<parameter>: <value>} elements
params = dict(parse_qsl(paramstring[1:]))
# Check the parameters passed to the plugin
if params:
if params['action'] == 'listing':
# Display the list of videos in a provided category.
list_videos(params['category'])
elif params['action'] == 'play':
# Play a video from a provided URL.
play_video(params['video'])
else:
# If the plugin is called from Kodi UI without any parameters,
# display the list of video categories
list_categories()
</syntaxhighlight>

Call the router function

<syntaxhighlight lang="python" enclose="div">
if __name__ == '__main__':
# Call the router function and pass the plugin call parameters to it.
router(sys.argv[2])
</syntaxhighlight>

=Changing the code=

Hopefully by now you have managed to run the Add-On, understand the structure and can see what the code can do. Now lets trying changing it a little!

Since we already have the Add-on installed we can go directly to the Kodi userdata folder and edit the python directly. You can also have Kodi open at this time ready to run the Add-on when required. Just switch between your text editor and Kodi any time.

Now open up the main.py file from your userdata folder and lets change what the text says.

'Cars': [{'name': 'Postal Truck',
'thumb': 'http://www.vidsplay.com/vids/us_postal.jpg',
'video': 'http://www.vidsplay.com/vids/us_postal.mp4',
'genre': 'Cars'},

Try changing some of the links to another jpeg file or hosted online video. Also try to change the genre and see how that effects the view in Kodi.

Click save on your text editor and now try running the Add-On inside Kodi. You should see the new video links and navigation right away.

Congratulations! you've just played an online video from your very own Video Add-on

=Final Thoughts=

Writing a Video Add-on is actually pretty simple once you get the basic structure correct. You can scrape most online sources with Regex, or host your own videos on the web. You can also play youtube clips or vevo videos using some additional easy to use modules.

If you have any questions about this tutorial, feel free to discuss it on our forums here: http://forum.kodi.tv/showthread.php?tid=248774

=Extra info=

Just a reminder...
IMPORTANT!!!!!!! Do not mix tabs and spaces in python

[[Category:Add-on development]]

HOW-TO:Create a RSS Feed

2016-01-03T06:36:42Z

SimpleKodi:

{{mininav| [[RSSFeeds.xml]] }}
<section begin="intro" />This is a HOW-TO on creating your own RSS Feed that you can use on Kodi.<section end="intro" />

This tutorial might work with Kodi only. Some RSS Feed readers might not recognize the RSS we will make.

Please keep in mind that this is a simple and easy way of doing it. I know it might not be the right way but it works.

== '''Video Tutorial''' ==
{{youtube|lE1hDN_xKPc}}

[https://youtu.be/lE1hDN_xKPc Video's Description.]

== '''Creating the XML file''' ==

The only type of RSS Feed that Kodi reads are .xml files

Start by creating a normal text file and rename it to '''RSSFeed.xml'''

Your first three lines should look like this:
<syntaxhighlight lang="xml" enclose="div">
<rss version="2.0">
<channel>
<title></title>
</syntaxhighlight>

Between <title></title> you're suppose to add your RSS Feed's name. Which will be in blue in Kodi.

After that you can start adding "items" which is basically what will be shown when the text starts moving.
<syntaxhighlight lang="xml" enclose="div">
<item>
<title></title>
</item>
</syntaxhighlight>
Again between <title></title> you should put in the text that you want to be shown.

Your XML file '''HAS''' to contain three or more "items". If not Kodi will not read your RSS Feed.

Finish the code by closing it.
<syntaxhighlight lang="xml" enclose="div">
</channel>
</rss>
</syntaxhighlight>

== '''Example''' ==
Below is an example of what your XML file should look like.
<syntaxhighlight lang="xml" enclose="div">
<rss version="2.0">
<channel>
<title>My RSS Feed</title>

<item>
<title>Hello everyone!</title>
</item>

<item>
<title>Updates are coming soon. Stay tuned!</title>
</item>

<item>
<title>Enjoy your day.</title>
</item>

</channel>
</rss>
</syntaxhighlight>
You can have many more "items" but make sure to have at lease three of them.

== '''Uploading your file''' ==
The final step is to upload your .xml file to a webhost. It can be any host but make sure your file's name has the extention .xml at the end of it's name.

Copy the link of you file and insert it into Kodi.

== '''See also''' ==
* [[RSSFeeds.xml]]
* [[RSS ticker]]

{{Isengard updated}}

'''[[User:SimpleKodi|SimpleKodi]] ([[User talk:SimpleKodi|talk]])'''
[[Category:Settings]]
[[Category:Manual]]
[[Category:How-to]]

HOW-TO:Create a RSS Feed

2016-01-03T06:34:57Z

SimpleKodi: How to create a RSS Feed for kodi

Archive:Create a repository for add-ons

2015-12-21T06:03:41Z

SimpleKodi:

{{mininav|[[Development]]|[[Add-on development]]|[[Add-on repositories]]}}

When you have created your repository, feel free to add it to the [[3rd party add-on repositories]] list.

==Video Tutorial==
{{youtube|zm1pvAt5uvU}}

[https://www.youtube.com/watch?v=zm1pvAt5uvU Video's Description.]
*This video will help you create a Repository for Kodi. The video's steps are different from the written tutorial.
* Helper Python script [https://github.com/virajkanwade/kodi-create-repo https://github.com/virajkanwade/kodi-create-repo]

== Things you will require ==
* Any HTTP server. A popular method is to use the svn or git source code servers of googlecode, gitorious and github.
- In your code project page, make sure you set up the correct version control system (source tab). Most skins use SVN.
- This will get you the right checkout address (link) and folder structure.
* A folder containing one or more add-on.
- Start by installing an svn program (like Tortoisesvn).
- Right click the empty folder, choose 'SVN Checkout' to let it build a folder structure inside.
- Make sure you get asked for authentication (!), the folders look like your source code server.
- If you don't get asked for authentication check your server settings and http vs https links.
- Make a test.txt file in the trunk, right click to mark it as 'add' and use and use 'SVN Commit' on top folder.
* Make the following two files using the python code below. These 2 files are made from the addon.xml files in the folders below (from the addons). Where you can have your addon unzipped (or zipped as long as there is an addon.xml file next to it, that is always up to date with the one in the zip).
- A master addon'''s'''.xml file. This file contains metadata about all available add-ons.
- A checksum of the above file (this file only contains a hash of addons.xml).
* A zipped repository add-on for distribution. This allows you to share your repository with others.
- Easiest way is to have a look at another repository file and change the name, info and links.
- You can also have a look at how other repos set up their folder structure.

You can use <tt>addons_xml_generator.py</tt>[https://raw.github.com/garbear/unqlocked/master/addons_xml_generator.py] to generate the master xml and the MD5. Put it in the folder with all your add-ons (it needs to see addon.xml files in a folder below) and run it from your Python interpreter. If using a source code server, you can now upload your add-on folder via svn or git to your repository. Every time you update an add-on run the addons_xml_generator.py before uploading the add-ons folder.

* For Windows users. Install the latest version of Python.msi (from their website) in it's default directory. Python (.py) files should now be associated with python.exe and can be run like a program.
* Make a new text file and name it <tt>addons_xml_generator.py</tt>. Open it with Notepad++ (or equivalent) and paste the following code inside.

addons_xml_generator.py
<source lang="python">
# *
# * Copyright (C) 2012-2013 Garrett Brown
# * Copyright (C) 2010 j48antialias
# *
# * This Program is free software; you can redistribute it and/or modify
# * it under the terms of the GNU General Public License as published by
# * the Free Software Foundation; either version 2, or (at your option)
# * any later version.
# *
# * This Program is distributed in the hope that it will be useful,
# * but WITHOUT ANY WARRANTY; without even the implied warranty of
# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# * GNU General Public License for more details.
# *
# * You should have received a copy of the GNU General Public License
# * along with XBMC; see the file COPYING. If not, write to
# * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
# * http://www.gnu.org/copyleft/gpl.html
# *
# * Based on code by j48antialias:
# * https://anarchintosh-projects.googlecode.com/files/addons_xml_generator.py

""" addons.xml generator """

import os
import sys

# Compatibility with 3.0, 3.1 and 3.2 not supporting u"" literals
if sys.version < '3':
import codecs
def u(x):
return codecs.unicode_escape_decode(x)[0]
else:
def u(x):
return x

class Generator:
"""
Generates a new addons.xml file from each addons addon.xml file
and a new addons.xml.md5 hash file. Must be run from the root of
the checked-out repo. Only handles single depth folder structure.
"""
def __init__( self ):
# generate files
self._generate_addons_file()
self._generate_md5_file()
# notify user
print("Finished updating addons xml and md5 files")

def _generate_addons_file( self ):
# addon list
addons = os.listdir( "." )
# final addons text
addons_xml = u("<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<addons>\n")
# loop thru and add each addons addon.xml file
for addon in addons:
try:
# skip any file or .svn folder or .git folder
if ( not os.path.isdir( addon ) or addon == ".svn" or addon == ".git" ): continue
# create path
_path = os.path.join( addon, "addon.xml" )
# split lines for stripping
xml_lines = open( _path, "r" , encoding="UTF-8").read().splitlines()
# new addon
addon_xml = ""
# loop thru cleaning each line
for line in xml_lines:
# skip encoding format line
if ( line.find( "<?xml" ) >= 0 ): continue
# add line
if sys.version < '3':
addon_xml += unicode( line.rstrip() + "\n", "UTF-8" )
else:
addon_xml += line.rstrip() + "\n"
# we succeeded so add to our final addons.xml text
addons_xml += addon_xml.rstrip() + "\n\n"
except Exception as e:
# missing or poorly formatted addon.xml
print("Excluding %s for %s" % ( _path, e ))
# clean and add closing tag
addons_xml = addons_xml.strip() + u("\n</addons>\n")
# save file
self._save_file( addons_xml.encode( "UTF-8" ), file="addons.xml" )

def _generate_md5_file( self ):
# create a new md5 hash
try:
import md5
m = md5.new( open( "addons.xml", "r" ).read() ).hexdigest()
except ImportError:
import hashlib
m = hashlib.md5( open( "addons.xml", "r", encoding="UTF-8" ).read().encode( "UTF-8" ) ).hexdigest()

# save file
try:
self._save_file( m.encode( "UTF-8" ), file="addons.xml.md5" )
except Exception as e:
# oops
print("An error occurred creating addons.xml.md5 file!\n%s" % e)

def _save_file( self, data, file ):
try:
# write data to the file (use b for Python 3)
open( file, "wb" ).write( data )
except Exception as e:
# oops
print("An error occurred saving %s file!\n%s" % ( file, e ))

if ( __name__ == "__main__" ):
# start
Generator()
</source>

== Repository Files ==
Repositories are distributed just like any other add-on. In order for you to browse one in XBMC, you'll need to [[Add-ons_for_XBMC_(Developement)|create an add-on]] and install it. The repository addon extends the xbmc.addon.repository extension point, so in addition to the general XML structure and icons required for an icon, you'll need an <extension> block specfically pointing to your repository.
Use the addon.xml of any of the [[3rd party add-on repositories]] as a template.
Online repositories should always have zip set to true, both for efficiency of download and for the protection that .zip offers by way of verifying the download (i.e. can we unzip it).

== Tips ==
=== Using your repo to host images ===
You may as a developer need to host images from time to time.
Something like photobucket or flickr may work, but you can also use your repo.
Commit an image to it, and then form the url to it as you would if you were accessing the image via git or svn (like below):

http://xbmc-adult.googlecode.com/svn/trunk/repository.xbmc-adult/icon.png

This can then be accessed easily from python code, or even embedded on the XBMC forums.

=== How to make an add-on self-updating without distributing a repository file ===
This is optional.
You still need a repository for this, you just distribute the actual zipped plugin or script, as opposed to the repository file.
First you need to have a working repository file.
Copy the equivalent of this code from the addon.xml of your repository file:
<source lang="xml">
<extension point="xbmc.addon.repository"
name="Official XBMC.org Add-on Repository">
<info compressed="true">http://mirrors.xbmc.org/addons/dharma-pre/addons.xml</info>
<checksum>http://mirrors.xbmc.org/addons/dharma-pre/addons.xml.md5</checksum>
<datadir zip="true">http://mirrors.xbmc.org/addons/dharma-pre</datadir>
</extension>
</source>
Then simply add it under the other <extension point> entries of your add-on's addon.xml
The name= part of this repository extension must never be the same as your add-on.

==More Video Tutorials==
===Update Your Repository===
{{youtube|tXzPUs9FaF8}}

[https://youtu.be/tXzPUs9FaF8 Video's Description.]

===Add more Add-ons to your Repository===
{{youtube|2OPjwdbBSkw}}

[https://youtu.be/2OPjwdbBSkw Video's Description.]

==See also==
* [[3rd party add-on repositories]]
'''Development:'''
* [[Add-on development]]
* [[Add-on repositories]]

[[Category:Add-on development]]
[[Category:Skin development]]
[[Category:Repositories]]

Add-on:YouTube

2015-12-13T21:26:27Z

SimpleKodi:

{{Addon
|Name=YouTube
|provider-name=bromix
|ID=plugin.video.youtube
|latest-version=5.1.12
|extension point=xbmc.python.pluginsource
|provides=video
|Summary=Plugin for YouTube
|Description=YouTube is a one of the biggest video-sharing websites of the world.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.kodi.tv/showthread.php?tid=200735
|Website=http://www.youtube.com
|Source=https://github.com/bromix/plugin.video.youtube
|Email=bromix at gmx dot net
|broken=
|icon url=http://mirrors.kodi.tv/addons/jarvis/plugin.video.youtube/icon.png}}

==Video Tutorial==
{{youtube|-ARBt2G7XWo}}

[https://youtu.be/-ARBt2G7XWo Video's Description.]
*This video will show you how to install the YouTube add-on on Kodi.

== Features ==

=== Integration with strm files ===
Youtube streams can be integrated into the video library with [[Strm|strm files]].

The syntax for a youtube-URL like <nowiki>https://www.youtube.com/watch?v=$VIDEOID</nowiki> or <nowiki>https://www.youtube.com/playlist?list=$PLAYLISTID</nowiki> in a strm file is<br />

<code>plugin://plugin.video.youtube/?path=/root/video&action=play_video&videoid=$VIDEOID</code>

<code>plugin://plugin.video.youtube/?path=/root/video&action=play_all&playlist=$PLAYLISTID</code>

== See also ==
=== Similar page names ===
{{#lst:YouTube|similar pages}}

[[Category:Social media]]
[[Category:Helix add-on repository]]
[[Category:Jarvis add-on repository]]

Archive:Create a repository for add-ons

2015-12-13T03:02:22Z

SimpleKodi:

{{mininav|[[Development]]|[[Add-on development]]|[[Add-on repositories]]}}

When you have created your repository, feel free to add it to the [[3rd party add-on repositories]] list.

==Video Tutorial==
{{youtube|zm1pvAt5uvU}}

[https://www.youtube.com/watch?v=zm1pvAt5uvU Video's Description.]
*This video will help you create a Repository for Kodi. The video's steps are different from the written tutorial.

== Things you will require ==
* Any HTTP server. A popular method is to use the svn or git source code servers of googlecode, gitorious and github.
- In your code project page, make sure you set up the correct version control system (source tab). Most skins use SVN.
- This will get you the right checkout address (link) and folder structure.
* A folder containing one or more add-on.
- Start by installing an svn program (like Tortoisesvn).
- Right click the empty folder, choose 'SVN Checkout' to let it build a folder structure inside.
- Make sure you get asked for authentication (!), the folders look like your source code server.
- If you don't get asked for authentication check your server settings and http vs https links.
- Make a test.txt file in the trunk, right click to mark it as 'add' and use and use 'SVN Commit' on top folder.
* Make the following two files using the python code below. These 2 files are made from the addon.xml files in the folders below (from the addons). Where you can have your addon unzipped (or zipped as long as there is an addon.xml file next to it, that is always up to date with the one in the zip).
- A master addon'''s'''.xml file. This file contains metadata about all available add-ons.
- A checksum of the above file (this file only contains a hash of addons.xml).
* A zipped repository add-on for distribution. This allows you to share your repository with others.
- Easiest way is to have a look at another repository file and change the name, info and links.
- You can also have a look at how other repos set up their folder structure.

You can use <tt>addons_xml_generator.py</tt>[https://raw.github.com/garbear/unqlocked/master/addons_xml_generator.py] to generate the master xml and the MD5. Put it in the folder with all your add-ons (it needs to see addon.xml files in a folder below) and run it from your Python interpreter. If using a source code server, you can now upload your add-on folder via svn or git to your repository. Every time you update an add-on run the addons_xml_generator.py before uploading the add-ons folder.

* For Windows users. Install the latest version of Python.msi (from their website) in it's default directory. Python (.py) files should now be associated with python.exe and can be run like a program.
* Make a new text file and name it <tt>addons_xml_generator.py</tt>. Open it with Notepad++ (or equivalent) and paste the following code inside.

addons_xml_generator.py
<source lang="python">
# *
# * Copyright (C) 2012-2013 Garrett Brown
# * Copyright (C) 2010 j48antialias
# *
# * This Program is free software; you can redistribute it and/or modify
# * it under the terms of the GNU General Public License as published by
# * the Free Software Foundation; either version 2, or (at your option)
# * any later version.
# *
# * This Program is distributed in the hope that it will be useful,
# * but WITHOUT ANY WARRANTY; without even the implied warranty of
# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# * GNU General Public License for more details.
# *
# * You should have received a copy of the GNU General Public License
# * along with XBMC; see the file COPYING. If not, write to
# * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
# * http://www.gnu.org/copyleft/gpl.html
# *
# * Based on code by j48antialias:
# * https://anarchintosh-projects.googlecode.com/files/addons_xml_generator.py

""" addons.xml generator """

import os
import sys

# Compatibility with 3.0, 3.1 and 3.2 not supporting u"" literals
if sys.version < '3':
import codecs
def u(x):
return codecs.unicode_escape_decode(x)[0]
else:
def u(x):
return x

class Generator:
"""
Generates a new addons.xml file from each addons addon.xml file
and a new addons.xml.md5 hash file. Must be run from the root of
the checked-out repo. Only handles single depth folder structure.
"""
def __init__( self ):
# generate files
self._generate_addons_file()
self._generate_md5_file()
# notify user
print("Finished updating addons xml and md5 files")

def _generate_addons_file( self ):
# addon list
addons = os.listdir( "." )
# final addons text
addons_xml = u("<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<addons>\n")
# loop thru and add each addons addon.xml file
for addon in addons:
try:
# skip any file or .svn folder or .git folder
if ( not os.path.isdir( addon ) or addon == ".svn" or addon == ".git" ): continue
# create path
_path = os.path.join( addon, "addon.xml" )
# split lines for stripping
xml_lines = open( _path, "r" , encoding="UTF-8").read().splitlines()
# new addon
addon_xml = ""
# loop thru cleaning each line
for line in xml_lines:
# skip encoding format line
if ( line.find( "<?xml" ) >= 0 ): continue
# add line
if sys.version < '3':
addon_xml += unicode( line.rstrip() + "\n", "UTF-8" )
else:
addon_xml += line.rstrip() + "\n"
# we succeeded so add to our final addons.xml text
addons_xml += addon_xml.rstrip() + "\n\n"
except Exception as e:
# missing or poorly formatted addon.xml
print("Excluding %s for %s" % ( _path, e ))
# clean and add closing tag
addons_xml = addons_xml.strip() + u("\n</addons>\n")
# save file
self._save_file( addons_xml.encode( "UTF-8" ), file="addons.xml" )

def _generate_md5_file( self ):
# create a new md5 hash
try:
import md5
m = md5.new( open( "addons.xml", "r" ).read() ).hexdigest()
except ImportError:
import hashlib
m = hashlib.md5( open( "addons.xml", "r", encoding="UTF-8" ).read().encode( "UTF-8" ) ).hexdigest()

# save file
try:
self._save_file( m.encode( "UTF-8" ), file="addons.xml.md5" )
except Exception as e:
# oops
print("An error occurred creating addons.xml.md5 file!\n%s" % e)

def _save_file( self, data, file ):
try:
# write data to the file (use b for Python 3)
open( file, "wb" ).write( data )
except Exception as e:
# oops
print("An error occurred saving %s file!\n%s" % ( file, e ))

if ( __name__ == "__main__" ):
# start
Generator()
</source>

== Repository Files ==
Repositories are distributed just like any other add-on. In order for you to browse one in XBMC, you'll need to [[Add-ons_for_XBMC_(Developement)|create an add-on]] and install it. The repository addon extends the xbmc.addon.repository extension point, so in addition to the general XML structure and icons required for an icon, you'll need an <extension> block specfically pointing to your repository.
Use the addon.xml of any of the [[3rd party add-on repositories]] as a template.
Online repositories should always have zip set to true, both for efficiency of download and for the protection that .zip offers by way of verifying the download (i.e. can we unzip it).

== Tips ==
=== Using your repo to host images ===
You may as a developer need to host images from time to time.
Something like photobucket or flickr may work, but you can also use your repo.
Commit an image to it, and then form the url to it as you would if you were accessing the image via git or svn (like below):

http://xbmc-adult.googlecode.com/svn/trunk/repository.xbmc-adult/icon.png

This can then be accessed easily from python code, or even embedded on the XBMC forums.

=== How to make an add-on self-updating without distributing a repository file ===
This is optional.
You still need a repository for this, you just distribute the actual zipped plugin or script, as opposed to the repository file.
First you need to have a working repository file.
Copy the equivalent of this code from the addon.xml of your repository file:
<source lang="xml">
<extension point="xbmc.addon.repository"
name="Official XBMC.org Add-on Repository">
<info compressed="true">http://mirrors.xbmc.org/addons/dharma-pre/addons.xml</info>
<checksum>http://mirrors.xbmc.org/addons/dharma-pre/addons.xml.md5</checksum>
<datadir zip="true">http://mirrors.xbmc.org/addons/dharma-pre</datadir>
</extension>
</source>
Then simply add it under the other <extension point> entries of your add-on's addon.xml
The name= part of this repository extension must never be the same as your add-on.

==See also==
* [[3rd party add-on repositories]]
'''Development:'''
* [[Add-on development]]
* [[Add-on repositories]]

[[Category:Add-on development]]
[[Category:Skin development]]
[[Category:Repositories]]

Archive:Create a repository for add-ons

2015-12-10T06:10:55Z

SimpleKodi:

{{mininav|[[Development]]|[[Add-on development]]|[[Add-on repositories]]}}

When you have created your repository, feel free to add it to the [[3rd party add-on repositories]] list.

==Video Tutorial==
{{youtube|A5scCJ3OnmM}}
*This video will help you create a Repository for Kodi. The video's steps are different from the written tutorial.

== Things you will require ==
* Any HTTP server. A popular method is to use the svn or git source code servers of googlecode, gitorious and github.
- In your code project page, make sure you set up the correct version control system (source tab). Most skins use SVN.
- This will get you the right checkout address (link) and folder structure.
* A folder containing one or more add-on.
- Start by installing an svn program (like Tortoisesvn).
- Right click the empty folder, choose 'SVN Checkout' to let it build a folder structure inside.
- Make sure you get asked for authentication (!), the folders look like your source code server.
- If you don't get asked for authentication check your server settings and http vs https links.
- Make a test.txt file in the trunk, right click to mark it as 'add' and use and use 'SVN Commit' on top folder.
* Make the following two files using the python code below. These 2 files are made from the addon.xml files in the folders below (from the addons). Where you can have your addon unzipped (or zipped as long as there is an addon.xml file next to it, that is always up to date with the one in the zip).
- A master addon'''s'''.xml file. This file contains metadata about all available add-ons.
- A checksum of the above file (this file only contains a hash of addons.xml).
* A zipped repository add-on for distribution. This allows you to share your repository with others.
- Easiest way is to have a look at another repository file and change the name, info and links.
- You can also have a look at how other repos set up their folder structure.

You can use <tt>addons_xml_generator.py</tt>[https://raw.github.com/garbear/unqlocked/master/addons_xml_generator.py] to generate the master xml and the MD5. Put it in the folder with all your add-ons (it needs to see addon.xml files in a folder below) and run it from your Python interpreter. If using a source code server, you can now upload your add-on folder via svn or git to your repository. Every time you update an add-on run the addons_xml_generator.py before uploading the add-ons folder.

* For Windows users. Install the latest version of Python.msi (from their website) in it's default directory. Python (.py) files should now be associated with python.exe and can be run like a program.
* Make a new text file and name it <tt>addons_xml_generator.py</tt>. Open it with Notepad++ (or equivalent) and paste the following code inside.

addons_xml_generator.py
<source lang="python">
# *
# * Copyright (C) 2012-2013 Garrett Brown
# * Copyright (C) 2010 j48antialias
# *
# * This Program is free software; you can redistribute it and/or modify
# * it under the terms of the GNU General Public License as published by
# * the Free Software Foundation; either version 2, or (at your option)
# * any later version.
# *
# * This Program is distributed in the hope that it will be useful,
# * but WITHOUT ANY WARRANTY; without even the implied warranty of
# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# * GNU General Public License for more details.
# *
# * You should have received a copy of the GNU General Public License
# * along with XBMC; see the file COPYING. If not, write to
# * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
# * http://www.gnu.org/copyleft/gpl.html
# *
# * Based on code by j48antialias:
# * https://anarchintosh-projects.googlecode.com/files/addons_xml_generator.py

""" addons.xml generator """

import os
import sys

# Compatibility with 3.0, 3.1 and 3.2 not supporting u"" literals
if sys.version < '3':
import codecs
def u(x):
return codecs.unicode_escape_decode(x)[0]
else:
def u(x):
return x

class Generator:
"""
Generates a new addons.xml file from each addons addon.xml file
and a new addons.xml.md5 hash file. Must be run from the root of
the checked-out repo. Only handles single depth folder structure.
"""
def __init__( self ):
# generate files
self._generate_addons_file()
self._generate_md5_file()
# notify user
print("Finished updating addons xml and md5 files")

def _generate_addons_file( self ):
# addon list
addons = os.listdir( "." )
# final addons text
addons_xml = u("<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<addons>\n")
# loop thru and add each addons addon.xml file
for addon in addons:
try:
# skip any file or .svn folder or .git folder
if ( not os.path.isdir( addon ) or addon == ".svn" or addon == ".git" ): continue
# create path
_path = os.path.join( addon, "addon.xml" )
# split lines for stripping
xml_lines = open( _path, "r" , encoding="UTF-8").read().splitlines()
# new addon
addon_xml = ""
# loop thru cleaning each line
for line in xml_lines:
# skip encoding format line
if ( line.find( "<?xml" ) >= 0 ): continue
# add line
if sys.version < '3':
addon_xml += unicode( line.rstrip() + "\n", "UTF-8" )
else:
addon_xml += line.rstrip() + "\n"
# we succeeded so add to our final addons.xml text
addons_xml += addon_xml.rstrip() + "\n\n"
except Exception as e:
# missing or poorly formatted addon.xml
print("Excluding %s for %s" % ( _path, e ))
# clean and add closing tag
addons_xml = addons_xml.strip() + u("\n</addons>\n")
# save file
self._save_file( addons_xml.encode( "UTF-8" ), file="addons.xml" )

def _generate_md5_file( self ):
# create a new md5 hash
try:
import md5
m = md5.new( open( "addons.xml", "r" ).read() ).hexdigest()
except ImportError:
import hashlib
m = hashlib.md5( open( "addons.xml", "r", encoding="UTF-8" ).read().encode( "UTF-8" ) ).hexdigest()

# save file
try:
self._save_file( m.encode( "UTF-8" ), file="addons.xml.md5" )
except Exception as e:
# oops
print("An error occurred creating addons.xml.md5 file!\n%s" % e)

def _save_file( self, data, file ):
try:
# write data to the file (use b for Python 3)
open( file, "wb" ).write( data )
except Exception as e:
# oops
print("An error occurred saving %s file!\n%s" % ( file, e ))

if ( __name__ == "__main__" ):
# start
Generator()
</source>

== Repository Files ==
Repositories are distributed just like any other add-on. In order for you to browse one in XBMC, you'll need to [[Add-ons_for_XBMC_(Developement)|create an add-on]] and install it. The repository addon extends the xbmc.addon.repository extension point, so in addition to the general XML structure and icons required for an icon, you'll need an <extension> block specfically pointing to your repository.
Use the addon.xml of any of the [[3rd party add-on repositories]] as a template.
Online repositories should always have zip set to true, both for efficiency of download and for the protection that .zip offers by way of verifying the download (i.e. can we unzip it).

== Tips ==
=== Using your repo to host images ===
You may as a developer need to host images from time to time.
Something like photobucket or flickr may work, but you can also use your repo.
Commit an image to it, and then form the url to it as you would if you were accessing the image via git or svn (like below):

http://xbmc-adult.googlecode.com/svn/trunk/repository.xbmc-adult/icon.png

This can then be accessed easily from python code, or even embedded on the XBMC forums.

=== How to make an add-on self-updating without distributing a repository file ===
This is optional.
You still need a repository for this, you just distribute the actual zipped plugin or script, as opposed to the repository file.
First you need to have a working repository file.
Copy the equivalent of this code from the addon.xml of your repository file:
<source lang="xml">
<extension point="xbmc.addon.repository"
name="Official XBMC.org Add-on Repository">
<info compressed="true">http://mirrors.xbmc.org/addons/dharma-pre/addons.xml</info>
<checksum>http://mirrors.xbmc.org/addons/dharma-pre/addons.xml.md5</checksum>
<datadir zip="true">http://mirrors.xbmc.org/addons/dharma-pre</datadir>
</extension>
</source>
Then simply add it under the other <extension point> entries of your add-on's addon.xml
The name= part of this repository extension must never be the same as your add-on.

==See also==
* [[3rd party add-on repositories]]
'''Development:'''
* [[Add-on development]]
* [[Add-on repositories]]

[[Category:Add-on development]]
[[Category:Skin development]]
[[Category:Repositories]]

Archive:Create a repository for add-ons

2015-12-10T06:08:49Z

SimpleKodi:

{{mininav|[[Development]]|[[Add-on development]]|[[Add-on repositories]]}}

When you have created your repository, feel free to add it to the [[3rd party add-on repositories]] list.

==Video Tutorial==
{{youtube|A5scCJ3OnmM}}

== Things you will require ==
* Any HTTP server. A popular method is to use the svn or git source code servers of googlecode, gitorious and github.
- In your code project page, make sure you set up the correct version control system (source tab). Most skins use SVN.
- This will get you the right checkout address (link) and folder structure.
* A folder containing one or more add-on.
- Start by installing an svn program (like Tortoisesvn).
- Right click the empty folder, choose 'SVN Checkout' to let it build a folder structure inside.
- Make sure you get asked for authentication (!), the folders look like your source code server.
- If you don't get asked for authentication check your server settings and http vs https links.
- Make a test.txt file in the trunk, right click to mark it as 'add' and use and use 'SVN Commit' on top folder.
* Make the following two files using the python code below. These 2 files are made from the addon.xml files in the folders below (from the addons). Where you can have your addon unzipped (or zipped as long as there is an addon.xml file next to it, that is always up to date with the one in the zip).
- A master addon'''s'''.xml file. This file contains metadata about all available add-ons.
- A checksum of the above file (this file only contains a hash of addons.xml).
* A zipped repository add-on for distribution. This allows you to share your repository with others.
- Easiest way is to have a look at another repository file and change the name, info and links.
- You can also have a look at how other repos set up their folder structure.

You can use <tt>addons_xml_generator.py</tt>[https://raw.github.com/garbear/unqlocked/master/addons_xml_generator.py] to generate the master xml and the MD5. Put it in the folder with all your add-ons (it needs to see addon.xml files in a folder below) and run it from your Python interpreter. If using a source code server, you can now upload your add-on folder via svn or git to your repository. Every time you update an add-on run the addons_xml_generator.py before uploading the add-ons folder.

* For Windows users. Install the latest version of Python.msi (from their website) in it's default directory. Python (.py) files should now be associated with python.exe and can be run like a program.
* Make a new text file and name it <tt>addons_xml_generator.py</tt>. Open it with Notepad++ (or equivalent) and paste the following code inside.

addons_xml_generator.py
<source lang="python">
# *
# * Copyright (C) 2012-2013 Garrett Brown
# * Copyright (C) 2010 j48antialias
# *
# * This Program is free software; you can redistribute it and/or modify
# * it under the terms of the GNU General Public License as published by
# * the Free Software Foundation; either version 2, or (at your option)
# * any later version.
# *
# * This Program is distributed in the hope that it will be useful,
# * but WITHOUT ANY WARRANTY; without even the implied warranty of
# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# * GNU General Public License for more details.
# *
# * You should have received a copy of the GNU General Public License
# * along with XBMC; see the file COPYING. If not, write to
# * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
# * http://www.gnu.org/copyleft/gpl.html
# *
# * Based on code by j48antialias:
# * https://anarchintosh-projects.googlecode.com/files/addons_xml_generator.py

""" addons.xml generator """

import os
import sys

# Compatibility with 3.0, 3.1 and 3.2 not supporting u"" literals
if sys.version < '3':
import codecs
def u(x):
return codecs.unicode_escape_decode(x)[0]
else:
def u(x):
return x

class Generator:
"""
Generates a new addons.xml file from each addons addon.xml file
and a new addons.xml.md5 hash file. Must be run from the root of
the checked-out repo. Only handles single depth folder structure.
"""
def __init__( self ):
# generate files
self._generate_addons_file()
self._generate_md5_file()
# notify user
print("Finished updating addons xml and md5 files")

def _generate_addons_file( self ):
# addon list
addons = os.listdir( "." )
# final addons text
addons_xml = u("<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<addons>\n")
# loop thru and add each addons addon.xml file
for addon in addons:
try:
# skip any file or .svn folder or .git folder
if ( not os.path.isdir( addon ) or addon == ".svn" or addon == ".git" ): continue
# create path
_path = os.path.join( addon, "addon.xml" )
# split lines for stripping
xml_lines = open( _path, "r" , encoding="UTF-8").read().splitlines()
# new addon
addon_xml = ""
# loop thru cleaning each line
for line in xml_lines:
# skip encoding format line
if ( line.find( "<?xml" ) >= 0 ): continue
# add line
if sys.version < '3':
addon_xml += unicode( line.rstrip() + "\n", "UTF-8" )
else:
addon_xml += line.rstrip() + "\n"
# we succeeded so add to our final addons.xml text
addons_xml += addon_xml.rstrip() + "\n\n"
except Exception as e:
# missing or poorly formatted addon.xml
print("Excluding %s for %s" % ( _path, e ))
# clean and add closing tag
addons_xml = addons_xml.strip() + u("\n</addons>\n")
# save file
self._save_file( addons_xml.encode( "UTF-8" ), file="addons.xml" )

def _generate_md5_file( self ):
# create a new md5 hash
try:
import md5
m = md5.new( open( "addons.xml", "r" ).read() ).hexdigest()
except ImportError:
import hashlib
m = hashlib.md5( open( "addons.xml", "r", encoding="UTF-8" ).read().encode( "UTF-8" ) ).hexdigest()

# save file
try:
self._save_file( m.encode( "UTF-8" ), file="addons.xml.md5" )
except Exception as e:
# oops
print("An error occurred creating addons.xml.md5 file!\n%s" % e)

def _save_file( self, data, file ):
try:
# write data to the file (use b for Python 3)
open( file, "wb" ).write( data )
except Exception as e:
# oops
print("An error occurred saving %s file!\n%s" % ( file, e ))

if ( __name__ == "__main__" ):
# start
Generator()
</source>

== Repository Files ==
Repositories are distributed just like any other add-on. In order for you to browse one in XBMC, you'll need to [[Add-ons_for_XBMC_(Developement)|create an add-on]] and install it. The repository addon extends the xbmc.addon.repository extension point, so in addition to the general XML structure and icons required for an icon, you'll need an <extension> block specfically pointing to your repository.
Use the addon.xml of any of the [[3rd party add-on repositories]] as a template.
Online repositories should always have zip set to true, both for efficiency of download and for the protection that .zip offers by way of verifying the download (i.e. can we unzip it).

== Tips ==
=== Using your repo to host images ===
You may as a developer need to host images from time to time.
Something like photobucket or flickr may work, but you can also use your repo.
Commit an image to it, and then form the url to it as you would if you were accessing the image via git or svn (like below):

http://xbmc-adult.googlecode.com/svn/trunk/repository.xbmc-adult/icon.png

This can then be accessed easily from python code, or even embedded on the XBMC forums.

=== How to make an add-on self-updating without distributing a repository file ===
This is optional.
You still need a repository for this, you just distribute the actual zipped plugin or script, as opposed to the repository file.
First you need to have a working repository file.
Copy the equivalent of this code from the addon.xml of your repository file:
<source lang="xml">
<extension point="xbmc.addon.repository"
name="Official XBMC.org Add-on Repository">
<info compressed="true">http://mirrors.xbmc.org/addons/dharma-pre/addons.xml</info>
<checksum>http://mirrors.xbmc.org/addons/dharma-pre/addons.xml.md5</checksum>
<datadir zip="true">http://mirrors.xbmc.org/addons/dharma-pre</datadir>
</extension>
</source>
Then simply add it under the other <extension point> entries of your add-on's addon.xml
The name= part of this repository extension must never be the same as your add-on.

==See also==
* [[3rd party add-on repositories]]
'''Development:'''
* [[Add-on development]]
* [[Add-on repositories]]

[[Category:Add-on development]]
[[Category:Skin development]]
[[Category:Repositories]]