Add-on development

From XBMC
Revision as of 14:03, 24 January 2013 by Martijn (Talk)

Jump to: navigation, search

Template:DevsHeader

This page summarizes the new addons system introduced in the Dharma release (v10) of XBMC.

XBMC has introduced an addons system. This allows 3rd party developed enhancements to XBMC to be distributed to XBMC users direct from inside the XBMC interface.

The addons system is based on the plugin library c-pluff.


Contents

1 Anatomy of an addon

Each add-on is kept in it's own folder, and is described via an XML file named addon.xml. In addition, some other files can also come with the add-on, namely icon.png, changelog.txt, and fanart.jpg. These are all optional, though we encourage you to at least have icon.png. All of these reside in the "root" of the folder that contains the add-on. Additional data may be contained within a resources/ subfolder, such as language translations and descriptions of settings.


1.1 Directory Name

Your directory name should follow this convention2; <addonType>[.<mediaType>].<yourPluginName>

The name parts are case sensitive and must be in lower case. The dot character separates each name part – you can use further dot's to separate things in your plugin name if you wish, alternatively you may use a hyphen (-). No other non-alphanumeric characters should be used.

The addonType is one from the following list

Addon Type Name Description
repository A repository definition file that allows users to add new repositories to

the XBMC addon manager. Media type is not required.

plugin A plugin script or module that adds to the functionality of XBMC.

Plugins appear under the relevant media section of the main home menu.

script A runnable program file that will appear in the Program section of the

main home menu.

skin An XBMC skin definition and its supporting script files. Media type is not required.

The mediaType is not required in all cases. The following table describes the available mediaTypes for the available addon types. Your addon may provide more than one mediaType if you wish, whereby it will appear in more than one section. In most cases, however, a single media type will suffice, and it may be preferable to have multiple addons each providing a single media type rather than one addon that tries to do it all.


Addon Media Type Name Description
plugin audio A music addon that will appear in the main menu music
plugin video A video addon that will appear in the main menu video
plugin picture A picture addon that will appear in the main menu picture
plugin weather A weather addon that will appear in the main menu weather
script module A script plugin that will not appear under a category or

within the Addons manager, but provides support for other addons

script service A script that will be run at either login or startup


See section on addon.xml for further information

The plugin name is up to you, but beware that others haven't used it before you. So for instance, if you are creating an addon that integrates the Gpodder software with XBMC for audio podcasts you might name your directory; plugin.audio.gpodder-xbmc3 If you are creating a screen scraper to present tv shows from MyGreatTv.com. It might be; plugin.video.my-great-tv-com A script to ping all your friends on twitter to tell them you are home might be called; script.ping-twits-i-am-home Having settled on your name create the directory under the .xbmc/addons directory.

2 Directory structure

Your directory contains all the resources needed to operate your addon. The directory must be considered read-only and should not be used for storing intersession or transient data. Other mechanisms are available to do that (more later.) The directory must contain the follwing files and directories.

   addon.py
   addon.xml
   changelog.txt
   fanart.jpg
   icon.png
   LICENSE.txt
   /resources
       settings.xml
       /language/
       /lib/
       /media/

Other files may be required to run your addon, if your addon becomes more complex. It is also considered good practice to place various addon resources and support code modules in the /lib folder. If those libs are more commonly used by different addons consider them to add as a separate script.module.foo

i.e. everything that shouldn't be in the root of your directory is considered a resource and should be placed in that sub-directory or a sub-directory from /resources.


2.1 File contents

2.1.1 addon.py

This will contain your main addon python code. It may be named differently as you will define this python file in addon.xml as your main script file.

2.1.2 addon.xml

The addon.xml tells XBMC

  • what the addon provides
  • what the addon relies on to work
  • what script to run when it is fired up (if it is meant to be started.)

More information on formatting can be found here: addon.xml

2.1.3 changelog.txt

A text file that contains a description of each release change that you make to the system. This is displayed in the XBMC addon installation/update system. Recommended format is to have it sorted by version in descending order, with a simple description as to the major changes (new functionality, big fixes etc,) in each version. (In the author's opinion, too many addons skip this piece of information making it difficult for users to determine whether a particular problem that they may have been having has been fixed or not.) resources/settings.xml An XML file that contains the current configuration for the addon. If your addon has configurable items that are set by the user, put them here. This file drives what the user sees when they click on Addon settings for your addon in the various places in XBMC that it can appear. You need do no coding to utilise this functionality

2.1.4 icon.png

This used to to be displayed in various parts of XBMC. In order to keep a coherent look and give the skinner a good idea how the icons of the add-ons look, we have defined the following rules:

  • The icon size must be 256x256 pixels.
  • File format is PNG.
  • Background must be 100% solid. That doesn't mean one color, it also can be a gradient or a low contrast texture. Just make sure there is no transparency.
  • Keep the logo as simple a possible, no exaggerated 3D effects or high contrast textures.
  • Use a padding of at least 25px for your logo (not the background!). Excepted are large text logos (see icon for themoviedb.org).
  • Keep text to a minimum. However, a text logo along with the graphical logo is recommended in order to easily recognize the addon.
  • Don't mix logos with XBMC's logo, it's obvious that we're talking about XBMC here.
  • Don't add borders or any overlays, that's the skinner's job. However, if borders are an element of your logo, make sure there is enough padding.
  • It is suggested that a logo on a plain background (non-transparent) is best in many situations

(e.g. for addons that retrieve media from an online service, use that service's logo [as long as you are free to do so]).

2.1.5 fanart.jpg

This helps to keep XBMC graphically rich when browsing and using addons. Some simple guidelines:

  • It should be 16:9 aspect ratio
  • It is intended for the background, so should be simple and without text where reasonable.
  • We recommend a 1280x720 JPG image. It should certainly be no larger than 1920x1080.
  • We recommend keeping it as small as is reasonable with respect to file-size. Remember that hundreds of thousands of users are going to be downloading this.

2.1.6 /resources/settings.xml

This contains the settings that will be available for your add-on. This file should be located in

   /resources/settings.xml

See following link for all programmable options Addon_Settings

2.1.7 /resources/language/

LANGUAGE THINGS

Translation tools:

strings.po

Future.png strings.xml will be deprecated after the release of Frodo. Frodo will still be back worths compatible with .xml

2.1.8 /resources/lib/

Put any module definitions or third party software libraries into this directory resources/data.

Store any other static data structures your application requires here. Examples might be XLT/XSD files or static XML files that contain lookup tables etc.

2.1.9 /resources/media/

store any static media (picture, audio, video etc.) files in this directory Remember, the above is a recommended outline for your addon – if you need fewer or more directories to organise your work, just change it. Like sins are addons that will require more directories than this.

3 See also

Development:

Personal tools
Namespaces

Variants
Actions
Navigation
Wiki help
Toolbox