- Notifications
You must be signed in to change notification settings - Fork63
A collection of additional Lavaplayer/Lavalink Sources
License
NotificationsYou must be signed in to change notification settings
topi314/LavaSrc
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Important
For LavaSrc v3 (Lavaplayer v1 & Lavalink v3) lookhere
A collection of additionalLavaplayer v2,LavaSearch &LavaLyrics Audio Source Managers andLavalink v4 Plugin.
- Spotify playlists/albums/songs/artists(top tracks)/search results/LavaSearch/LavaLyrics
- Apple Music playlists/albums/songs/artists/search results/LavaSearch (Big thx toryan5453 for helping me)
- Deezer playlists/albums/songs/artists/search results/LavaSearch/LavaLyrics (Big thx toryan5453 andmelike2d for helping me)
- Yandex Music playlists/albums/songs/artists/podcasts/search results/LavaLyrics/LavaSearch (Thx toAgutinVBoy for implementing it)
- Flowery TTS (Thx tobachtran02 for implementing it)
- YouTube &YouTubeMusicLavaSearch/LavaLyrics (Thx toDRSchlaubi for helping me)
- Vk Music playlists/albums/songs/artists(top tracks)/search results/LavaLyrics/LavaSearch (Thx toKrispeckt for implementing it)
- Tidal playlists/albums/songs/search results (Thx toNansess andInfNibor for implementing it)
Important
Tracks from Spotify & Apple Music & Tidal don't actually play from their sources, but are instead resolved via the configured providers
This plugin requires Lavalinkv4 or greater
To install this plugin either download the latest release and place it into yourplugins folder or add the following into yourapplication.yml
Note
For a fullapplication.yml example seehere
Replace x.y.z with the latest version number
lavalink:plugins: -dependency:"com.github.topi314.lavasrc:lavasrc-plugin:x.y.z"repository:"https://maven.lavalink.dev/releases"# this is optional for lavalink v4.0.0-beta.5 or greatersnapshot:false# set to true if you want to use snapshot builds (see below)
Snapshot builds are available inhttps://maven.lavalink.dev/snapshots with the short commit hash as the version
For all supported urls and queries seehere
To get your Spotify clientId, clientSecret gohere & then copy them into yourapplication.yml like the following.
To get your Spotify spDc cookie gohere
To get your Apple Music api token gohere
To get your Deezer arl cookie gohere
To get your Yandex Music access token gohere
To get your Vk Music user token gohere
To get your Tidal token gohere
Warning
YESplugins IS AT ROOT IN THE YAML
plugins:lavasrc:providers:# Custom providers for track loading. This is the default# - "dzisrc:%ISRC%" # Deezer ISRC provider# - "dzsearch:%QUERY%" # Deezer search provider -"ytsearch:\"%ISRC%\""# Will be ignored if track does not have an ISRC. See https://en.wikipedia.org/wiki/International_Standard_Recording_Code -"ytsearch:%QUERY%"# Will be used if track has no ISRC or no track could be found for the ISRC# you can add multiple other fallback sources heresources:spotify:false# Enable Spotify sourceapplemusic:false# Enable Apple Music sourcedeezer:false# Enable Deezer sourceyandexmusic:false# Enable Yandex Music sourceflowerytts:false# Enable Flowery TTS sourceyoutube:false# Enable YouTube search source (https://github.com/topi314/LavaSearch)vkmusic:false# Enable Vk Music sourcetidal:false# Enable Tidal sourcelyrics-sources:spotify:false# Enable Spotify lyrics sourcedeezer:false# Enable Deezer lyrics sourceyoutube:false# Enable YouTube lyrics sourceyandexmusic:false# Enable Yandex Music lyrics sourcevkmusic:false# Enable Vk Music lyrics sourcespotify:clientId:"your client id"clientSecret:"your client secret"# spDc: "your sp dc cookie" # the sp dc cookie used for accessing the spotify lyrics apicountryCode:"US"# the country code you want to use for filtering the artists top tracks. See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2playlistLoadLimit:6# The number of pages at 100 tracks eachalbumLoadLimit:6# The number of pages at 50 tracks eachresolveArtistsInSearch:true# Whether to resolve artists in track search results (can be slow)localFiles:false# Enable local files support with Spotify playlists. Please note `uri` & `isrc` will be `null` & `identifier` will be `"local"`applemusic:countryCode:"US"# the country code you want to use for filtering the artists top tracks and language. See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2mediaAPIToken:"your apple music api token"# apple music api token# or specify an apple music keykeyID:"your key id"teamID:"your team id"musicKitKey:| -----BEGIN PRIVATE KEY----- your key -----END PRIVATE KEY-----playlistLoadLimit:6# The number of pages at 300 tracks eachalbumLoadLimit:6# The number of pages at 300 tracks eachdeezer:masterDecryptionKey:"your master decryption key"# the master key used for decrypting the deezer tracks. (yes this is not here you need to get it from somewhere else)arl:"your deezer arl"# the arl cookie used for accessing the deezer api this does not appear to be optional anymoreformats:[ "FLAC", "MP3_320", "MP3_256", "MP3_128", "MP3_64", "AAC_64" ]# the formats you want to use for the deezer tracks. "FLAC", "MP3_320", "MP3_256" & "AAC_64" are only available for premium users and require a valid arlyandexmusic:accessToken:"your access token"# the token used for accessing the yandex music api. See https://github.com/TopiSenpai/LavaSrc#yandex-musicplaylistLoadLimit:1# The number of pages at 100 tracks eachalbumLoadLimit:1# The number of pages at 50 tracks eachartistLoadLimit:1# The number of pages at 10 tracks eachflowerytts:voice:"default voice"# (case-sensitive) get default voice from here https://api.flowery.pw/v1/tts/voicestranslate:false# whether to translate the text to the native language of voicesilence:0# the silence parameter is in milliseconds. Range is 0 to 10000. The default is 0.speed:1.0# the speed parameter is a float between 0.5 and 10. The default is 1.0. (0.5 is half speed, 2.0 is double speed, etc.)audioFormat:"mp3"# supported formats are: mp3, ogg_opus, ogg_vorbis, aac, wav, and flac. Default format is mp3youtube:countryCode:"US"# the country code you want to use for searching lyrics via ISRC. See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2vkmusic:userToken:"your user token"# This token is needed for authorization in the api. Guide: https://github.com/topi314/LavaSrc#vk-musicplaylistLoadLimit:1# The number of pages at 50 tracks eachartistLoadLimit:1# The number of pages at 10 tracks eachrecommendationsLoadLimit:10# Number of trackstidal:countryCode:"US"# the country code for accessing region-specific content on Tidal (ISO 3166-1 alpha-2).searchLimit:6# How many search results should be returnedtoken:"your tidal token"# the token used for accessing the tidal api. See https://github.com/topi314/LavaSrc#tidal
LavaSrc adds the following fields to tracks & playlists in Lavalink
| Field | Type | Description |
|---|---|---|
| albumName | ?string | The name of the album |
| albumArtUrl | ?string | The url of the album art |
| artistUrl | ?string | The url of the artist |
| artistArtworkUrl | ?string | The url of the artist artwork |
| previewUrl | ?string | The url of the preview |
| isPreview | bool | Whether the track is a preview |
Example Payload
{"encoded":"...","info": {... },"pluginInfo": {"albumName":"...","albumArtUrl":"...","artistUrl":"...","artistArtworkUrl":"...","previewUrl":"...","isPreview":false },"userData": {... }}| Field | Type | Description |
|---|---|---|
| type | Playlist Type | The type of the playlist |
| url | ?string | The url of the playlist |
| artworkUrl | ?string | The url of the playlist artwork |
| author | ?string | The author of the playlist |
| totalTracks | ?int | The total number of tracks in the playlist |
Example Payload
{"info": {... },"pluginInfo": {"type":"playlist","url":"...","artworkUrl":"...","author":"...","totalTracks":10 },"tracks": [... ]}| Type | Description |
|---|---|
album | The playlist is an album |
playlist | The playlist is a playlist |
artist | The playlist is an artist |
recommendations | The playlist is a recommendations playlist |
Sometimes you may want to update the settings at runtime without restarting Lavalink. This can be done by sending aPATCH request to the/v4/lavasrc/config endpoint.Keep in mind this willNOT update the settings in theapplication.yml file. If you restart Lavalink the settings will be reset to the ones in theapplication.yml file.
PATCH /v4/lavasrc/config
Note
All fields are optional and only the fields you provide will be updated.
| Field | Type | Description |
|---|---|---|
| ?spotify | Spotify Config | The Spotify settings |
| ?applemusic | Apple Music Config | The Apple Music settings |
| ?deezer | Deezer Config | The Deezer settings |
| ?yandexMusic | Yandex Music Config | The Yandex Music settings |
| ?vkMusic | Vk Music Config | The Vk Music settings |
| Field | Type | Description |
|---|---|---|
| ?clientId | string | The Spotify clientId |
| ?clientSecret | string | The Spotify clientSecret |
| ?spDc | string | The Spotify spDc cookie |
| Field | Type | Description |
|---|---|---|
| ?mediaAPIToken | string | The Apple Music api token |
| Field | Type | Description |
|---|---|---|
| ?arl | string | The Deezer arl cookie |
| ?formats | array ofDeezer Format | The Deezer formats |
| Format | Description |
|---|---|
FLAC | FLAC |
MP3_320 | MP3 320kbps |
MP3_256 | MP3 256kbps |
MP3_128 | MP3 128kbps |
MP3_64 | MP3 64kbps |
AAC_64 | AAC 64kbps |
| Field | Type | Description |
|---|---|---|
| ?accessToken | string | The Yandex Music access token |
| Field | Type | Description |
|---|---|---|
| ?userToken | string | The Vk Music user token |
Example Payload
{"spotify": {"clientId":"your client id","clientSecret":"your client secret","spDc":"your sp dc cookie" },"applemusic": {"mediaAPIToken":"your apple music api token" },"deezer": {"arl":"your deezer arl","formats": ["FLAC","MP3_320","MP3_256","MP3_128","MP3_64","AAC_64" ] },"yandexMusic": {"accessToken":"your access token" },"vkMusic": {"userToken":"your user token" }}Replacex.y.z with the latest version number
Snapshot builds are instead available inhttps://maven.topi.wtf/snapshots with the short commit hash as the version
Gradle
repositories { maven { url"https://maven.topi.wtf/releases" }}dependencies { implementation"com.github.topi314.lavasrc:lavasrc:x.y.z" implementation"com.github.topi314.lavasrc:lavasrc-protocol:x.y.z"}
Maven
<repositories> <repository> <id>TopiWTF-releases</id> <name>Topis Maven Repo</name> <url>https://maven.topi.wtf/releases</url> </repository></repositories><dependencies> <dependency> <groupId>com.github.topi314.lavasrc</groupId> <artifactId>lavasrc</artifactId> <version>x.y.z</version> </dependency> <dependency> <groupId>com.github.topi314.lavasrc</groupId> <artifactId>lavasrc-protocol-jvm</artifactId> <version>x.y.z</version> </dependency></dependencies>
To get a Spotify clientId & clientSecret you must gohere and create a new application.
How to get sp dc cookie
- Go tohttps://open.spotify.com
- Open DevTools and go to the Application tab
- Copy the value of the
sp_dccookie
AudioPlayerManagerplayerManager =newDefaultAudioPlayerManager();// create a new SpotifySourceManager with the default providers, clientId, clientSecret, spDc, countryCode and AudioPlayerManager and register it// spDc is only needed if you want to use it with LavaLyricsvarspotify =newSpotifySourceManager(clientId,clientSecret,spDc,countryCode, () ->playerManager,DefaultMirroringAudioTrackResolver);playerManager.registerSourceManager(spotify);
Click to expand
// create new lyrics managervarlyricsManager =newLyricsManager();// register sourcelyricsManager.registerLyricsManager(spotify);
Click to expand
// create new search managervarsearchManager =newSearchManager();// register sourcesearchManager.registerSearchManager(spotify);
How to get media api token without Apple developer account
- Go tohttps://music.apple.com
- Open DevTools and go to the Debugger tab
- Search with this regex
"(?<token>(ey[\w-]+)\.([\w-]+)\.([\w-]+))"in allindex-*.jsfiles - Copy the token from the source code
Alternatively, you canfollowthis guide
AudioPlayerManagerplayerManager =newDefaultAudioPlayerManager();// create a new AppleMusicSourceManager with the standard providers, apple music api token, countrycode and AudioPlayerManager and register itvarappleMusic =newAppleMusicSourceManager(null,mediaAPIToken,"us",playerManager);playerManager.registerSourceManager(appleMusic);
Click to expand
// create new search managervarsearchManager =newSearchManager();// register sourcesearchManager.registerSearchManager(appleMusic);
How to get deezer master decryption key
Use Google.
How to get deezer arl cookie
Use Google to find a guide on how to get the arl cookie. It's not that hard.
AudioPlayerManagerplayerManager =newDefaultAudioPlayerManager();// create a new DeezerSourceManager with the master decryption key and register itvardeezer =newDeezerSourceManager("the master decryption key","your arl",formats);playerManager.registerSourceManager(deezer);
Click to expand
// create new lyrics managervarlyricsManager =newLyricsManager();// register sourcelyricsManager.registerLyricsManager(deezer);
Click to expand
// create new search managervarsearchManager =newSearchManager();// register sourcesearchManager.registerSearchManager(deezer);
How to get access token
- (Optional) Open DevTools in your browser and on the Network tab enable trotlining.
- Go tohttps://oauth.yandex.ru/authorize?response_type=token&client_id=23cabbbdc6cd418abb4b39c32c41195d
- Authorize and grant access
- The browser will redirect to the address like
https://music.yandex.ru/#access_token=AQAAAAAYc***&token_type=bearer&expires_in=31535645.Very quickly there will be a redirect to another page, so you need to have time to copy the link.
- Your accessToken, what is after
access_token.
Token expires in 1 year. You can get a new one by repeating the steps above.
Yandex Music is very location-dependent. You should either have a premium subscription or be located in one of the following countries:
- Azerbaijan
- Armenia
- Belarus
- Georgia
- Kazakhstan
- Kyrgyzstan
- Moldova
- Russia
- Tajikistan
- Turkmenistan
- Uzbekistan
Else you will only have access to podcasts.
AudioPlayerManagerplayerManager =newDefaultAudioPlayerManager();// create a new YandexMusicSourceManager with the access token and register itvaryandex =newYandexMusicSourceManager("...");playerManager.registerSourceManager(yandex);
Click to expand
// create new lyrics managervarlyricsManager =newLyricsManager();// register sourcelyricsManager.registerLyricsManager(yandex);
Click to expand
// create new search managervarsearchManager =newSearchManager();// register sourcesearchManager.registerSearchManager(yandex);
Get list of all voices and languages supportedhere
AudioPlayerManagerplayerManager =newDefaultAudioPlayerManager();// create a new FloweryTTSSourceManagerplayerManager.registerSourceManager(newFloweryTTSSourceManager());// create a new FloweryTTSSourceManager with a default voiceplayerManager.registerSourceManager(newFloweryTTSSourceManager("..."));
How to get user token
Carefully, this token can be used to access your personal data. Use a newly created account specifically for LavaSrc. This source is designed mainly for the RU region, 80% of songs in other regions will not be played.
- Go to the authorization pageMarusya application
- Authorize through your vk account.
- A link like this
https://oauth.vk.com/blank.html#access_token=$$$$$&expires_in=0&user_id=$$$$$@email=$$$$$@gmail.com - Copy your token and paste it into your config! Enjoy captcha-free vk music!
AudioPlayerManagerplayerManager =newDefaultAudioPlayerManager();// create a new VkMusicSourceManager with the user token and register itplayerManager.registerSourceManager(newVkMusicSourceManager("...");
Click to expand
// create new lyrics managervarlyricsManager =newLyricsManager();// register sourcelyricsManager.registerLyricsManager(vkmusic);
Click to expand
// create new search managervarsearchManager =newSearchManager();// register sourcesearchManager.registerSearchManager(vkmusic);
How to get tidal token
Use Google to get the tidal token.
AudioPlayerManagerplayerManager =newDefaultAudioPlayerManager();// create a new TidalSourceManager with the token and register itvartidal =newTidalSourceManager(countryCode, () ->playerManager,newDefaultMirroringAudioTrackResolver(providers),"your tidal token");playerManager.registerSourceManager(tidal);
spsearch:animals architects(check outSpotify Search Docs for advanced search queries like isrc & co)sprec:seed_artists=3ZztVuWxHzNpl0THurTFCv,4MzJMcHQBl9SIYSjwWn8QW&seed_genres=metalcore&seed_tracks=5ofoB8PFmocBXFBEWVb6Vz,6I5zXzSDByTEmYZ7ePVQeB(check outSpotify Recommendations Docs for the full query parameter list)- https://open.spotify.com/track/0eG08cBeKk0mzykKjw4hcQ
- https://open.spotify.com/album/7qemUq4n71awwVPOaX7jw4
- https://open.spotify.com/playlist/7HAO9R9v203gkaPAgknOMp (playlists can include local files if you enabled this via:
plugins.lavasrc.spotify.localFiles: true. Please noteuri&isrcwill benull&identifierwill be"local") - https://open.spotify.com/artist/3ZztVuWxHzNpl0THurTFCv
(including new regional links likehttps://open.spotify.com/intl-de/track/0eG08cBeKk0mzykKjw4hcQ)
amsearch:animals architects- https://music.apple.com/cy/album/animals/1533388849?i=1533388859
- https://music.apple.com/cy/album/for-those-that-wish-to-exist/1533388849
- https://music.apple.com/us/playlist/architects-essentials/pl.40e568c609ae4b1eba58b6e89f4cd6a5
- https://music.apple.com/cy/artist/architects/182821355
dzsearch:animals architectsdzisrc:USEP42058010dzrec:1090538082(dzrec:{TRACK_ID},dzrec:track={TRACK_ID}ordzrec:artist={ARTIST_ID})- https://deezer.page.link/U6BTQ2Q1KpmNt2yh8
- https://www.deezer.com/track/1090538082
- https://www.deezer.com/album/175537082
- https://www.deezer.com/playlist/8164349742
- https://www.deezer.com/artist/159126
ymsearch:animals architectsymrec:71663565(ymrec:{TRACK_ID})- https://music.yandex.ru/album/13886032/track/71663565
- https://music.yandex.ru/album/13886032
- https://music.yandex.ru/track/71663565
- https://music.yandex.ru/users/yamusic-bestsongs/playlists/701626
- https://music.yandex.ru/artist/701626
You can read about all the available optionshere, a list of available voices ishere
ftts://hello%20worldftts://hello%20world?audio_format=ogg_opus&translate=False&silence=1000&speed=1.0&voice=09924826-684f-51e9-825b-cf85aed2b2cf
vksearch:animals architectsvkrec:-2001015907_104015907(vkrec:{TRACK_ID})- https://vk.com/audio-2001015907_104015907
- https://vk.ru/artist/shadxwbxrn
- https://vk.com/audios700949584?q=phonk%20playlist&z=audio_playlist-219343251_152_389941c481d1375ac0
- https://vk.com/audios700949584?q=phonk%20playlist&z=audio_playlist-219343251_152
- https://vk.com/music/playlist/-219343251_152_389941c481d1375ac0
- https://vk.ru/music/playlist/-219343251_152
- https://vk.com/music/album/-2000228258_15228258_cafcb9e95f552acbb6?act=album
- https://vk.com/music/album/-2000228258_15228258_cafcb9e95f552acbb6
- https://vk.ru/music/album/-2000228258_15228258?act=album
- https://vk.com/music/album/-2000228258_15228258
- https://vk.com/audios700949584?q=phonk%20album&z=audio_playlist-2000933493_13933493%2Fbe3494d46d310b0d0d
- https://vk.ru/audios700949584?q=phonk%20album&z=audio_playlist-2000933493_13933493
tdsearch:animals architectstdrec:12345678(tdrec:{TRACK_ID})- https://tidal.com/browse/track/12345678
- https://tidal.com/browse/album/12345678
- https://tidal.com/browse/playlist/12345678
- https://tidal.com/browse/artist/12345678
About
A collection of additional Lavaplayer/Lavalink Sources