Index: help/contrib_features.page ================================================================== --- help/contrib_features.page +++ help/contrib_features.page @@ -23,21 +23,21 @@ those out of station lists.</p> <list> <item><p>MP3 streams often start to sound okay at 96kbit/s.</p></item> <item><p>Whereas OGG Vorbis or AAC are sometimes acceptable at 64kbit/s already.</p></item> </list> -<note style="warning"><p>Note that you may end up with empty channel lists +<p>Note that you may end up with empty channel lists altogether if you set these options too high. Some channels provide all -their streams with 64kbit/s only.</p></note> +their streams with 64kbit/s only.</p> </section> <section> <title>Channel toolbar link</title> <p>Adds a toolbar entry which shows the current channel/directory service title and its homepage link. Such as:</p> -<code><span style="bold">Shoutcast</span> -<link href="http://shoutcast.com/">//shoutcast.com/</link> +<code><span style="bold"> ▶ ● 🏠 Shoutcast</span> +play rcrd hmpg <link href="http://shoutcast.com/">//shoutcast.com/</link> </code> <p>It depends on the "update window title" option being enabled.</p> </section> <section> @@ -69,30 +69,46 @@ <item><p> It's technically unneeded, as ST2 isn't stressful to directory websites and not blocked anywhere. </p></item> <item><p>It's only useful as additional privacy feature really, but shouldn't be used habitually. </p></item> </list> </section> +<section> + <title>Other feature plugins</title> + <list> + <item><p><link xref="dragndrop">Drag and Drop</link></p></item> + <item><p><link xref="favicon">Favicons</link></p></item> + <item><p><link xref="global_key">Global key shortcut</link></p></item> + <item><p><link xref="timer">Timer</link></p></item> + </list> + <p>The "<link xref="search">search</link>", + "<link xref="configuration">configwin</link>" and + "<link xref="edit">streamedit</link>" plugins are considered + built-ins and cannot be disabled.</p> +</section> -<section> +<section id="contrib"> <title>Downloadable contrib/ feature plugins</title> -<p>The <link xref="pluginmanager2">Plugin Manager</link> lists further -feature pluginsand in the <key>📦 Add</key> tab.</p> +<p>The <link xref="pluginmanager2">Plugin Manager</link> lists other +available feature plugins in the <key>📦 Add</key> tab.</p> <terms> <item> <title><p>Soundcloud streaming</p></title> <p>Enables playback of soundcloud.com links in the Reddit plugin. Homepage links are transformed into direct MP3 streaming addresses - on playback. This plugin registers a "audio/soundcloud" pseudo - type. Alternatively you could use <link - href="http://github.com/rekado/soundCLI">soundcli</link> of course.</p> + on playback.</p> + <note><p>Depends on python-soundcloud, which you can install per + <cmd>pip install soundcloud</cmd>.</p></note> + <p> Alternatively you could configure an external player like <link + href="http://github.com/rekado/soundCLI">soundcli</link> of course. + Use the pseudo type "audio/soundcloud" for the player settings table.</p> </item> <item> <title><p>dev_faulthandler</p></title> <p>This is a pure development plugin, meant to debug ST2 crashes.</p> </item> </terms> </section> </page> Index: help/technical.page ================================================================== --- help/technical.page +++ help/technical.page @@ -15,17 +15,19 @@ <title>Dependencies</title> <item><p><link action="install:python">Python 2.7 or 3.x</link></p></item> <item><p><link action="install:python-gtk2">PyGtk or PyGI</link></p></item> <item><p>Gtk2 or Gtk3</p></item> <item><p><link action="install:python-requests">Requests/urllib3</link></p></item> + <item><p><link action="install:python-imaging">PIL/Pillow</link></p></item> </terms> <terms> <title>Soft dependencies</title> <item><p><link action="install:python-lxml">Python-LXML</link></p></item> <item><p><link action="install:python-pyquery">Python-PyQuery</link></p></item> - <item><p>Python-Kronos</p></item> - <item><p>Audacious</p></item> + <item><p>Audacious/VLC or any other player</p></item> + <item><p>Streamripper or fIcy</p></item> + <item><p>youtube-dl</p></item> </terms> </section> <section id="config_files"> @@ -58,20 +60,24 @@ </item> <item> <title><file>~/.config/streamtuner2/icons/*.png</file></title> <p>Holds downloaded favicons for station homepages.</p> </item> + <item> + <title><file>~/.config/streamtuner2/plugins/*.py</file></title> + <p>Contain downloaded contrib/ plugins.</p> + </item> </terms> </section> <section id="install_dirs"> <title>Installation spread</title> <terms> <item> <title><file>/usr/bin/streamtuner2</file></title> - <p>Is the main binary.</p> + <p>Associates the main binary.</p> </item> <item> <title><file>/usr/share/streamtuner2/</file></title> <p>Contains the individual ST2 python modules, and plugins in channels/. Also packages in pyquery/, but which is only used if the according modules aren't installed by the distribution.</p> </item> @@ -86,10 +92,10 @@ <section id="license"> <title>Public Domain</title> <p>The majority of code distributed with ST2 is placed into the Public Domain; meaning no licensing requirement and all code can be copied, modified and distributed unrestrictively.</p> - <p>The bundled kronos.py and requests/ library are NOT however.</p> + <note><p>The bundled kronos.py and requests/ library are NOT however.</p></note> </section> </page>