<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
<title>Plugin Manager 2</title>
<link rel="stylesheet" type="text/css" href="C.css">
<script type="text/javascript" src="jquery.js"></script><script type="text/javascript" src="jquery.syntax.js"></script><script type="text/javascript" src="yelp.js"></script>
</head>
<body><div class="page" role="main">
<div class="header"><div class="trails" role="navigation"><div class="trail">
<a class="trail" href="index.html" title="♪ Streamtuner2"><span class="media"><span class="media media-image"><img src="img/logo.png" class="media media-inline" alt="♪"></span></span> Streamtuner2 </a> › <a class="trail" href="index.html#extra" title="Additional features">Additional features</a> » </div></div></div>
<div class="body">
<div class="hgroup"><h1 class="title"><span class="title">Plugin Manager 2</span></h1></div>
<div class="region">
<div class="contents">
<p class="p">For updating or installing new plugins (extra channels or
features), there's a user plugin manager. It's available as
feature extension itself.</p>
<div class="steps"><div class="inner"><div class="region"><ol class="steps">
<li class="steps"><p class="p">See the <span class="key"><kbd>F12</kbd></span> config dialog <span class="key"><kbd>🔌 Feature</kbd></span> section.</p></li>
<li class="steps"><p class="p">Enable the <span class="key"><kbd>⨯</kbd></span> Plugin Manager (listed near the end).</p></li>
<li class="steps"><p class="p">Restart streamtuner2 one last time for this change to take effect.</p></li>
</ol></div></div></div>
<p class="p">Once activated it brings up a new <span class="key"><kbd>📦 Add</kbd></span> tab
in the configuration window.</p>
<p class="p"><span class="media"><span class="media media-image"><img src="img/pluginmanager2.png" class="media media-inline" alt="Install dialog for user plugins"></span></span></p>
<p class="p">You can scan for available/new plugins there. And have them
downloaded right away. New plugins are just downloaded, not
implictly enabled. Reopen the config dialog to see them in the
regular <span class="key"><kbd>📻 Channels</kbd></span> or <span class="key"><kbd>🔌 Feature</kbd></span> tabs, and
then enable them.</p>
<div class="note" title="Note"><div class="inner"><div class="region"><div class="contents"><p class="p">Updated plugin versions won't be instantiated right away
if they've been active already. That requires either a restart.
Or disabling + saving once, then reenabling them.</p></div></div></div></div>
<div class="links topiclinks"><div class="inner"><div class="region">
<div class="linkdiv "><a class="linkdiv" href="configuration.html#plugins" title="Channel and feature plugins and settings"><span class="title">Channel and feature plugins and settings</span></a></div>
<div class="linkdiv "><a class="linkdiv" href="contrib_channels.html" title="→ Contrib/Extra Channels"><span class="title">→ Contrib/Extra Channels</span><span class="linkdiv-dash"> — </span><span class="desc">Downloadable channel plugins</span></a></div>
<div class="linkdiv "><a class="linkdiv" href="contrib_features.html" title="→ Feature plugins"><span class="title">→ Feature plugins</span><span class="linkdiv-dash"> — </span><span class="desc">Additional feature plugins</span></a></div>
</div></div></div>
</div>
<div id="configuration" class="sect"><div class="inner">
<div class="hgroup"><h2 class="title"><span class="title">Configuration</span></h2></div>
<div class="region"><div class="contents"><div class="list"><div class="inner"><div class="region"><ul class="list">
<li class="list"><p class="p">Alternative download repositories may be configured. (Little
practical value at the moment.)</p></li>
<li class="list">
<p class="p">And you can let the plugin manager handle autoactivation
of changed plugin states.</p>
<div class="list"><div class="inner"><div class="region"><ul class="list">
<li class="list"><p class="p">After reconfiguring existing channel plugins, they get
automatically instantiated or disabled in the user interface.
(Which avoids the usual restart).</p></li>
<li class="list"><p class="p">This currently doesn't work with feature/core
plugins. Plugin deactivation is mostly visual, but does not undo
menu extensions or undefine callback hooks.</p></li>
</ul></div></div></div>
</li>
</ul></div></div></div></div></div>
</div></div>
<div id="configuration" class="sect"><div class="inner">
<div class="hgroup"><h2 class="title"><span class="title">User plugins</span></h2></div>
<div class="region"><div class="contents">
<p class="p">Downloaded plugins are stored in <span class="file">~/.config/streamtuner2/plugins</span>.
To remove them, delete the individual *.py files there manually. But
keep the <span class="file">__init__.py</span> stub.</p>
<div class="note note-bug" title="Bug"><div class="inner"><div class="region"><div class="contents">
<p class="p">Core plugins (those which are installed
system-wide) can often also be updated. The user-saved plugin will
take precedence after a restart. However the version number in
PluginManager2 still shows the system-installed/older version
regardless.</p>
<p class="p">So you'll have to take care to eventually refresh/delete outdated user plugins,
whenever you install a newer Streamtuner2 version.</p>
</div></div></div></div>
</div></div>
</div></div>
<div id="" class="sect"><div class="inner">
<div class="hgroup"><h3 class="subtitle"><span class="subtitle">Disable user plugin loading</span></h3></div>
<div class="region"><div class="contents">
<p class="p">Since this is still rather experimental, you may disable all
associated features by starting ST2 via:</p>
<div class="screen"><pre class="contents ">streamtuner2 -d <span class="input">pluginmanager2</span></pre></div>
<p class="p">Which inhibits loading this whole extension. (The <span class="code">-d</span>
flag also works for any other plugin name.)</p>
</div></div>
</div></div>
<div class="sect sect-links" role="navigation">
<div class="hgroup"></div>
<div class="contents"><div class="links guidelinks"><div class="inner">
<div class="title"><h2><span class="title">More Information</span></h2></div>
<div class="region"><ul><li class="links "><a href="index.html#extra" title="Additional features">Additional features</a></li></ul></div>
</div></div></div>
</div>
</div>
<div class="clear"></div>
</div>
<div class="footer"></div>
</div></body>
</html>