Add-on manager: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
(more accurate tag)
>Pseudo7
No edit summary
Line 1: Line 1:
{{cleanup}}
{{editor note|This page needs to become more of a general "hub" for all the add-on pages. More advanced notes should be moved to [[Add-ons for XBMC (Development)]], and the rest should probably be merged with [[Add-on manager]].}}
:''See also: '''[[:Category:All add-ons]]'''''
{{XBMC faq toc Inline}}
'''Add-ons''' are packages that add features and functions not normally included with XBMC. Add-ons are are developed by persons on the XBMC-team and third-parties.
'''Add-ons''' are packages that add features and functions not normally included with XBMC. Add-ons are are developed by persons on the XBMC-team and third-parties.
Add-ons provide extra value and flexibility by making it easy for programmers to add new functions to the program.
Add-ons provide extra value and flexibility by making it easy for programmers to add new functions to the program.
Line 53: Line 49:
| style="background:#FFFFFF; text-align:center; width:500px;"|Click into the repository  you want to install from (see [[#How to add a repository|adding a Repository]] for more)
| style="background:#FFFFFF; text-align:center; width:500px;"|Click into the repository  you want to install from (see [[#How to add a repository|adding a Repository]] for more)
|}
|}


{| class="wikitable"
{| class="wikitable"
Line 73: Line 68:


= Repositories =
= Repositories =
Repositories are a place where add-ons can be retrieved from. XBMC comes with one repository installed by default, the [[Official Add-on Repository]]. However others can be added


== How to add a repository ==
== How to add a repository ==


To install a new repository you must first find the zip file to install the repository, a list of [[Unofficial add-on repositories]] is semi-maintained on the wiki - other repositories may exist.


In this example the ''hitcher'' repository is being installed, but the method is the same for other repositories. Download the repository zip file (xbmc-repo-hitcher.zip).


{| class="wikitable"
|-
! Step 1
! Step 2
|-
| style="background:#FFFFFF;"|[[File:installing-repo-1.png|500px]]
| style="background:#FFFFFF;"|[[File:installing-repo-2.png|500px]]
|-
| style="background:#FFFFFF; text-align:center; width:500px;"|Click '''Install from ZIP file'''
| style="background:#FFFFFF; text-align:center; width:500px;"|Navigate to the ZIP file (in this example it is in the desktop) and click on it.
|}


 
{| class="wikitable"
|-
! Step 3
! Step 4
|-
| style="background:#FFFFFF;"|[[File:installing-repo-3.png|500px]]
| style="background:#FFFFFF;"|[[File:installing-repo-4.png|500px]]
|-
| style="background:#FFFFFF; text-align:center; width:500px;"|In the bottom right, XBMC notifies when the add-on is installed and enabled. Click into '''Get Add-ons'''.
| style="background:#FFFFFF; text-align:center; width:500px;"|A new repository is listed.
|}




Line 92: Line 113:
You can find complete instructions on downloading and installing a plugin [[Plugins|here]].
You can find complete instructions on downloading and installing a plugin [[Plugins|here]].


== [[Scripts]] ==
[[Scripts]]. XBMC combines a Python interpreter with the [[Window Structure|WindowXML application framework]] (an XML-based widget toolkit for creating GUI windows), so that script developers can create new tools much like the Dashboard Widgets in Apple Mac OS X or the Microsoft Gadgets in Windows Sidebar.
Current python scripts for XBMC include applications like:
* Cinema guides
* TV guides (EPG)
* E-mail and Instant Messaging clients
* Train timetables
* Front-end controls for PVR software and hardware (like MediaPortal, MythTV, TiVo, ReplayTV, Dreambox/DBox2)
* Internet radio browsers (like SHOUTcast, Xm radio, Sirius Satellite Radio)
* P2P file-sharing downloaders (BitTorrent)
* IRC instant messaging chat
* Casual games (sometimes also referred to as mini-games or party-games) like Tetris, Snake, Space Invaders, Sudoku, and many more.
You can find complete instructions on downloading and installing a script [[Scripts|here]].
= [[Skins]] =
[[Skins]]. XBMC boasts a flexible and robust framework of its GUI (clearly demonstrated by the many other software projects copying it). This same flexibility makes theme-skinning and personal customization readily accessible. You can easily download and use third-parties skins in XBMC to customize your viewing experience. If you're interested, you could also create your own skin (or modify an existing skin) to share with others via public websites dedicated to Xbox skins trading.
Note: "Project Mayhem" is the official default skin for XBMC. "Project Mayhem" is now in its third version, commonly abbreviated as "PMIII." XBMC also includes a high-definition version of this skin called "PM3.HD."
In addition to the many third-party skins of original and unique design, you can also find skins that are near replicas of other popular multimedia software, including Apple TV and Front Row, Microsoft Windows Media Center Edition (MCE), MediaPortal, Meedio/MeediOS, HDeeTV, Kaleidescape, Xbox 360, PlayStation 3, and others. Each skin provides a totally different and unique user experience, showing just how flexible XBMC’s skinning engine really is.
You can find complete instructions on downloading and installing a custom skin [[Skins|here]].
= [[EventServer|EventClients]] =
[[EventServer|EventClients]]. XBMC acts as an [[EventServer]], allowing it to respond to software commands from any properly-configured EventClient. The most popular EventClients are programs that allow users to control XBMC with remotes or gamepad-controllers. However, EventClients can be configured for any process that needs to send software commands to XBMC.
To keep this communication as fast and plug-and-play as possible, we chose UDP. UDP is used in applications like network games because it is one of the lowest layers of network communication. This method grants low latencies and little overhead.
You can find complete instructions on configuring an EventServer and EventClient [[EventServer|here]].


[[Category:Add-ons]]
[[Category:Add-ons]]
[[Category:To-Do]]
[[Category:Python]]

Revision as of 17:02, 28 November 2011

Add-ons are packages that add features and functions not normally included with XBMC. Add-ons are are developed by persons on the XBMC-team and third-parties. Add-ons provide extra value and flexibility by making it easy for programmers to add new functions to the program. There are many XBMC add-ons including; plugins, scripts, skins, and EventClients.

(This page is intended as a guide for XBMC users. Details for Python Development, Skinning XBMC, or creating an EventClient.)

XBMC's Add-ons GUI

How to access Add-ons

Step 1 Step 2
Add-ons-accessing-1.png Add-ons-accessing-2.png
Scroll down to "Settings" and click it. Scroll down to "Add-ons" and click it.
Step 3
Add-ons-accessing-3.png
XBMC displays three options (explained underneath)


Enabled add-ons are add-ons that are currently enabled. XBMC comes with certain add-ons already installed and enabled (such as movie scrapers, screen-savers and visualisation)
Get add-ons allows the user to install new add-ons from the repositories installed. XBMC comes with one repository pre-installed (the official repository) others can be added adding a Repository.
Install from Zip file allows the installation of an add-on from a zip file


How to install Add-ons

For this example a skin is being installed, the same method is used for other add-ons.

Step 1 Step 2
Add-ons-accessing-3.png Add-ons-accessing-4.png
Click "Get add-ons" Click into the repository you want to install from (see adding a Repository for more)
Step 3 Step 4
Add-ons-accessing-5-1.png Add-ons-accessing-5-1.png
Scroll down to "skins" and click it Click the skin you want to install (in this example it is "Night")


When the add-on has finished downloading XBMC will enable it and depending on the add-on ask if you want to start using it. Add-ons will then appear in their appropriate section (e.g. skins in the appearance section of settings, movie scrapers in the options of scrapers when adding a new movie source)

Repositories

Repositories are a place where add-ons can be retrieved from. XBMC comes with one repository installed by default, the Official Add-on Repository. However others can be added


How to add a repository

To install a new repository you must first find the zip file to install the repository, a list of Unofficial add-on repositories is semi-maintained on the wiki - other repositories may exist.

In this example the hitcher repository is being installed, but the method is the same for other repositories. Download the repository zip file (xbmc-repo-hitcher.zip).

Step 1 Step 2
Installing-repo-1.png Installing-repo-2.png
Click Install from ZIP file Navigate to the ZIP file (in this example it is in the desktop) and click on it.
Step 3 Step 4
Installing-repo-3.png Installing-repo-4.png
In the bottom right, XBMC notifies when the add-on is installed and enabled. Click into Get Add-ons. A new repository is listed.


Understanding the Difference between Plugins and Scripts

It can be easy to confuse "Plugins" made for XBMC with "Scripts" made for XBMC. While the distinction can be subtle, scripts are applications launched directly by the user. A plugin, on the other hand, builds a list of menu items when the user browses into its virtual folder. Even though both are Python files ("*.py"), if you try to run a plugin file from the scripts window, you will only get an error message. Plugins can only be accessed as virtual folders in the regular menu structure.

From a design perspective, plugins, unlike scripts, do not really provide new functionality to XBMC. Instead, they provide an easy way to display content listings in XBMC through the native GUI interface.

Plugins

Plugins. Plugins provide an easy way for third-party developers to present content listings in XBMC through the native GUI interface. This content is usually gathered from online sources like Internet audio and video streams, (i.e. Internet TV channels, radio stations, or Podcasts), or pictures from websites such as Flickr and Picasa Web.

You can find complete instructions on downloading and installing a plugin here.