13 KiB
🎼 Music plugin | |
|---|---|
This plugin can display top and recently listened music tracks or from a random playlist. Different music providers are supported. | |
| Supported features → Full specification |
📗 Classic template |
👤 Users 👥 Organizations |
|
🗝️ plugin_music_token |
|
Random tracks from a playlist Recently listened |
|
➡️ Available options
| Type | Description |
plugin_music |
Enable music plugin |
type: boolean
default: no |
|
plugin_music_provider |
Music provider
This setting is optional when using |
type: string
allowed values:
|
|
plugin_music_token |
Music provider token Below is the expected token format for each provider:
|
| 🔐 Token type: token
|
|
plugin_music_mode |
Display mode
If |
type: string
allowed values:
|
|
plugin_music_playlist |
Playlist URL It must be from an "embed url" (i.e. music player iframes that can be integrated in other websites) |
type: string
|
|
plugin_music_limit |
Display limit |
type: number
(1 ≤
𝑥
≤ 100)
default: 4 |
|
plugin_music_played_at |
Recently played - Toggle last played timestamp display |
type: boolean
default: no |
|
plugin_music_time_range |
Top tracks - Time range for
|
type: string
default: short allowed values:
|
|
plugin_music_top_type |
Top tracks - Display type
|
type: string
default: tracks allowed values:
|
|
plugin_music_user |
Music provider username |
type: string
default: → User login |
🎺 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:
https://accounts.spotify.com/authorize?client_id=********&response_type=code&scope=user-read-recently-played%20user-top-read&redirect_uri=https%3A%2F%2Flocalhost
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.
(async () => {
console.log(await (await fetch("https://accounts.spotify.com/api/token", {
method:"POST",
headers:{"Content-Type":"application/x-www-form-urlencoded"},
body:new URLSearchParams({
grant_type:"authorization_code",
redirect_uri:"https://localhost",
client_id:"********",
client_secret:"********",
code:"********",
})
})).json())
})()
It should return a JSON response with the following content:
{
"access_token":"********",
"expires_in": 3600,
"scope":"user-read-recently-played user-top-read",
"token_type":"Bearer",
"refresh_token":"********"
}
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:
<iframe src="https://open.spotify.com/embed/playlist/********" width="" height="" frameborder="0" allowtransparency="" allow=""></iframe>
🍎 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 developper 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:
<iframe allow="" frameborder="" height="" style="" sandbox="" src="https://embed.music.apple.com/**/playlist/********"></iframe>
⏯️ 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:
https://music.youtube.com/playlist?list=********
📻 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
name: Apple Music - Random track from playlist
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.music.playlist.svg
token: NOT_NEEDED
base: ''
plugin_music: 'yes'
plugin_music_playlist: https://embed.music.apple.com/fr/playlist/usr-share/pl.u-V9D7m8Etjmjd0D
plugin_music_limit: 2
name: Spotify - Random track from playlist
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.music.playlist.spotify.svg
token: NOT_NEEDED
base: ''
plugin_music: 'yes'
plugin_music_playlist: https://open.spotify.com/embed/playlist/3nfA87oeJw4LFVcUDjRcqi
name: Spotify - Recently listed
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.music.recent.svg
token: NOT_NEEDED
base: ''
plugin_music: 'yes'
plugin_music_provider: spotify
plugin_music_mode: recent
plugin_music_token: ${{ secrets.SPOTIFY_TOKENS }}
plugin_music_limit: 2
name: Spotify - Top tracks
uses: lowlighter/metrics@latest
with:
token: NOT_NEEDED
base: ''
plugin_music: 'yes'
plugin_music_mode: top
plugin_music_provider: spotify
plugin_music_token: ${{ secrets.SPOTIFY_TOKENS }}
plugin_music_time_range: short
plugin_music_top_type: tracks
name: Spotify - Top artists
uses: lowlighter/metrics@latest
with:
token: NOT_NEEDED
base: ''
plugin_music: 'yes'
plugin_music_mode: top
plugin_music_provider: spotify
plugin_music_token: ${{ secrets.SPOTIFY_TOKENS }}
plugin_music_time_range: long
plugin_music_top_type: artists
name: Youtube Music - Random track from playlist
uses: lowlighter/metrics@latest
with:
token: NOT_NEEDED
base: ''
plugin_music: 'yes'
plugin_music_playlist: >-
https://music.youtube.com/playlist?list=OLAK5uy_kU_uxp9TUOl9zVdw77xith8o9AknVwz9U
name: Youtube Music - Recently listed
uses: lowlighter/metrics@latest
with:
token: NOT_NEEDED
base: ''
plugin_music_token: ${{ secrets.YOUTUBE_MUSIC_TOKENS }}
plugin_music: 'yes'
plugin_music_mode: recent
plugin_music_provider: youtube
name: Last.fm - Recently listed
uses: lowlighter/metrics@latest
with:
token: NOT_NEEDED
base: ''
plugin_music_token: ${{ secrets.LASTFM_TOKEN }}
plugin_music: 'yes'
plugin_music_provider: lastfm
plugin_music_user: RJ