Overview

How to install, configure and access 3rd party plugins (extensions) in MediaPortal.

Introduction

Many plugins are available for MediaPortal and the TV-Server. Some are included, many are 3rd party extensions. These extensions vary massively in complexity and function.

See  Plugins: a world of imagination for an overview of how plugins work in MediaPorta l.

If you have problems, run MediaPortal in Debug mode via the Windows Start Menu. This disables all plugins to help you identify the source of your issue. See WatchDog for further info.

MediaPortal Plugins

3rd Party Extensions

Extensions are seamlessly integrated in MediaPortal and can be configured and used the same as the included plugins.

The main difference is how you install Extensions.  In additon, documentation and support are provided by the Extension developer.

All plugins are required to provide skin files for the MediaPortal Default skins so you can use any plugin with the Default skins. However, if you use another skin, you must check to see which plugins are supported.

Finding Plugins

To find plugins that offer the features you want:

• Extensions > Plugins
  • listings on the MP website with screenshots, details, latest updates, links to documentation and forum for support - See Downloads Repository for more info about how to display the most popular or top rated extensions.
• MP Extensions Installer (MPEI)
  • browse by category,display screenshots, details, versions, as well as install and update plugins
• Extensions plugin - offers the same functions as MPEI within MP GUI

For Plugins in development, or new versions available for testing, see the Plugins Forum

Installing Extensions

Installing an extension is very easy, you can either:

1. Run the .mpe1 installer you have downloaded
2. Use the MPEInstaller via the desktop shortcut 

Some plugins and tools that work outside MediaPortal provide their own installers. See the plugin documentation for details.

Compatibility

If a plugin is not compatible with your current version of MediaPortal, the first time you load MediaPortal with incompatible plugins present, you will receive a warning notice after MediaPortal is fully loaded but before showing the home screen:

Incompatible Plugins will also be listed in a separate section in Configuration (after Process Plugins)

Configuring Plugins

Once you have installed a plugin, depending upon the complexity of the plugin and the function, you may need to configure it. Plugins are configured using either the Configuration Tools for MediaPortal or TV-Server

MediaPortal (Client) Plugins

1. Run the MediaPortal Configuration shortcut on your desktop.
2. Click on the Plugin menu.
3. Find the plugin you wish to configure in the list of installed plugins and click once on it to highlight it. 
4. Click on the appropriate button at the bottom of the list of plugins to Enable/Disable the plugin
5. Click Config to display the specific configuration window for that plugin - each one is different
6. Click In Home to display the plugin on the Classic Home screen or click Plugins to displayed it on the Plugins menu .

Note: You can also right click on a plugin to show the same options, as shown in the image below:

TV-Server Plugins

1. Run the TV Server Configuration shortcut on the desktop.
2. Click on the Plugin menu to display a list of the TV Server plugins installed on your system with a tick box next to each of them.
3. To enable the plugin put a tick in the appropriate box.
4. Now, when you look at the Plugin menu, you will see that it is possible to expand the menu to a lower level using the "+" symbol. When you do this you will see the newly enabled plugin.
5. Click on the plugin to display the configuration options for that plugin on the right hand side.
6. To disable a particular plugin, simply remove the tick from the box associated with that plugin.

Plugin Support

Some plugins provide extensive documentation, often in the Extensions > Plugins section of our wiki Some plugins include documentation in their download package, others provide online documentation via their own web servers or wiki..

Further Information

• Using MediaPortal > Plugins
• Configuration
  • MediaPortal > Plugins
  • TV-Server > Plugins
• References > Plugins - to understand the different types of plugins in MediaPortal
• Creating a plugin:
  • Contribute > Plugins 
  • Plugin Related Changes
  • Strings Changes  

 2013-01-30T05:17:11Z