README

<!--header--> <table> <tr><td colspan="2"><a href="/README.md#-plugins">← Back to plugins index</a></td></tr> <tr><th colspan="2"><h3>🎼 Music activity and suggestions</h3></th></tr> <tr><td colspan="2" align="center"><p>This plugin can display top and recently listened music tracks or titles from a random playlist.</p> <p>Different music providers are supported.</p> </td></tr> <tr><th>⚠️ Disclaimer</th><td><p>This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with any of the supported provider. All product and company names are trademarks™ or registered® trademarks of their respective holders.</p> </td></tr> <tr> <th rowspan="3">Supported features _{<a href="metadata.yml">→ Full specification</a>}</th> <td><a href="/source/templates/classic/README.md"><code>📗 Classic template</code></a></td> </tr> <tr> <td><code>👤 Users</code> <code>👥 Organizations</code></td> </tr> <tr> <td><code>🗝️ plugin_music_token</code></td> </tr> <tr> <td colspan="2" align="center"> <details open><summary>Random tracks from a playlist</summary></img></details> <details open><summary>Recently listened</summary></img></details> </tr> </table> <!--/header-->

➡️ Available options

<!--options--> <table> <tr> <td align="center" nowrap="nowrap">Option</i></td><td align="center" nowrap="nowrap">Description</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_music</code></h4></td> <td rowspan="2"><p>Enable music plugin</p> </td> </tr> <tr> <td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code>: <ul> <li><i>metrics.run.puppeteer.scrapping</i></li> </ul> <b>type:</b> <code>boolean</code>

<b>default:</b> no

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_music_provider</code></h4></td> <td rowspan="2"><p>Music provider</p> <ul> <li><code>apple</code>: Apple Music</li> <li><code>spotify</code>: Spotify</li> <li><code>lastfm</code>: Last.fm</li> <li><code>youtube</code>: YouTube Music</li> </ul> <p>This setting is optional when using <a href="/source/plugins/music/README.md#plugin_music_mode"><code>plugin_music_mode: playlist</code></a> (provider will be auto-detected from <a href="/source/plugins/music/README.md#plugin_music_playlist"><code>plugin_music_playlist</code></a> URL)</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>string</code>

<b>allowed values:</b><ul><li>apple</li><li>spotify</li><li>lastfm</li><li>youtube</li></ul></td>

</tr> <tr> <td nowrap="nowrap"><h4><code>plugin_music_token</code></h4></td> <td rowspan="2"><p>Music provider token</p> <p>Below is the expected token format for each provider:</p> <ul> <li><code>apple</code>: <em>(not supported)</em></li> <li><code>spotify</code>: &quot;client_id, client_secret, refresh_token&quot;</li> <li><code>lastfm</code>: &quot;api_key&quot;</li> <li><code>youtube</code>: &quot;cookie&quot;</li> </ul> </td> </tr> <tr> <td nowrap="nowrap">🔐 Token

🌐 Web instances must configure <code>settings.json</code>:

<ul> <li><i>metrics.api.music.any</i></li> </ul> <b>type:</b> <code>token</code> </td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_music_user</code></h4></td> <td rowspan="2"><p>Music provider username</p> </td> </tr> <tr> <td nowrap="nowrap">⏯️ Cannot be preset

<b>type:</b> <code>string</code>

<b>default:</b> <code>→ User login</code>

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_music_mode</code></h4></td> <td rowspan="2"><p>Display mode</p> <ul> <li><code>playlist</code>: display random tracks from an URL playlist</li> <li><code>recent</code>: display recently listened tracks</li> <li><code>top</code>: display top listened artists/tracks</li> </ul> <p>If <a href="/source/plugins/music/README.md#plugin_music_playlist"><code>plugin_music_playlist</code></a> is specified, the default value is <code>playlist</code>, else it is <code>recent</code></p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>string</code>

<b>allowed values:</b><ul><li>playlist</li><li>recent</li><li>top</li></ul></td>

</tr> <tr> <td nowrap="nowrap"><h4><code>plugin_music_playlist</code></h4></td> <td rowspan="2"><p>Playlist URL</p> <p>It must be from an &quot;embed url&quot; (i.e. music player iframes that can be integrated in other websites)</p> </td> </tr> <tr> <td nowrap="nowrap">⏯️ Cannot be preset

<b>type:</b> <code>string</code>

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_music_limit</code></h4></td> <td rowspan="2"><p>Display limit</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>number</code> <i>(1 ≤ 𝑥 ≤ 100)</i>

<b>default:</b> 4

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_music_played_at</code></h4></td> <td rowspan="2"><p>Recently played - Last played timestamp</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>boolean</code>

<b>default:</b> no

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_music_time_range</code></h4></td> <td rowspan="2"><p>Top tracks - Time range</p> <ul> <li><code>short</code>: 4 weeks</li> <li><code>medium</code>: 6 months</li> <li><code>long</code>: several years</li> </ul> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>string</code>

<b>default:</b> short

<b>allowed values:</b><ul><li>short</li><li>medium</li><li>long</li></ul></td>

</tr> <tr> <td nowrap="nowrap"><h4><code>plugin_music_top_type</code></h4></td> <td rowspan="2"><p>Top tracks - Display type</p> <ul> <li><code>tracks</code>: display track</li> <li><code>artists</code>: display artists</li> </ul> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>string</code>

<b>default:</b> tracks

<b>allowed values:</b><ul><li>tracks</li><li>artists</li></ul></td>

</tr> </table> <!--/options-->

🎺 Configuring music provider

Select a music provider below for additional instructions.

🎙️ Spotify

🗝️ Obtaining a token

Spotify does not have personal tokens, so it makes the process a bit longer because it is required to follow the authorization workflow... Follow the instructions below for a TL;DR to obtain a refresh_token.

Sign in to the developer dashboard and create a new app. Keep your client_id and client_secret and let this tab open for now.

Open the settings and add a new Redirect url. Normally it is used to setup callbacks for apps, but just put https://localhost instead (it is mandatory as per the authorization guide, even if not used).

Forge the authorization url with your client_id and the encoded redirect_uri you whitelisted, and access it from your browser:

When prompted, authorize application.

Once redirected to redirect_uri, extract the generated authorization code from your url bar.

Go back to developer dashboard tab, and open the web console of your browser to paste the following JavaScript code, with your own client_id, client_secret, authorization code and redirect_uri.

It should return a JSON response with the following content:

Register your client_id, client_secret and refresh_token in secrets to finish setup.

🔗 Get an embed playlist url for plugin_music_playlist

Connect to spotify.com and select the playlist you want to share. From ... menu, select Share and Copy embed code.

Extract the source link from the code pasted in your clipboard:

🍎 Apple Music

🗝️ Obtaining a token

(Not available)

😥 Unfortunately I wasn't able to find a workaround to avoid paying the $99 fee for the developer program, even using workarounds like smart playlists, shortcuts and other stuff. However if you really want this feature, you could sponsor me and I could eventually invest in a developer account with enough money, implement it and also eventually offer service on the shared instance

🔗 Get an embed playlist url for plugin_music_playlist

Connect to music.apple.com and select the playlist you want to share. From ... menu, select Share and Copy embed code.

Extract the source link from the code pasted in your clipboard:

⏯️ Youtube Music

🗝️ Obtaining a token

Login to YouTube Music on any modern browser.

Open the developer tools (Ctrl-Shift-I) and select the “Network” tab

Find an authenticated POST request. The simplest way is to filter by /browse using the search bar of the developer tools. If you don’t see the request, try scrolling down a bit or clicking on the library button in the top bar.

Click on the Name of any matching request. In the “Headers” tab, scroll to the “Cookie” and copy this by right-clicking on it and selecting “Copy value”.

🔗 Get an embed playlist url for plugin_music_playlist

Extract the playlist URL of the playlist you want to share.

Connect to music.youtube.com and select the playlist you want to share.

Extract the source link from the code pasted in your clipboard:

📻 Last.fm

🗝️ Obtaining a token

Create an API account or use an existing one to obtain a Last.fm API key.

🔗 Get an embed playlist url for plugin_music_playlist

(Not available)

ℹ️ Examples workflows

<!--examples--> <!--/examples-->