Skip to content

Latest commit

 

History

History
742 lines (554 loc) · 25.1 KB

README.md

File metadata and controls

742 lines (554 loc) · 25.1 KB
Raw

LavaSrc

Important

For LavaSrc v3 (Lavaplayer v1 & Lavalink v3) look here

A collection of additional Lavaplayer v2, LavaSearch & LavaLyrics Audio Source Managers and Lavalink v4 Plugin.

Important

Tracks from Spotify & Apple Music don't actually play from their sources, but are instead resolved via the configured providers

Summary

Lavalink Usage

This plugin requires Lavalink v4 or greater

To install this plugin either download the latest release and place it into your plugins folder or add the following into your application.yml

Note

For a full application.yml example see here

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 greater
      snapshot: false # set to true if you want to use snapshot builds (see below)

Snapshot builds are available in https://maven.lavalink.dev/snapshots with the short commit hash as the version

Configuration

For all supported urls and queries see here

To get your Spotify clientId, clientSecret go here & then copy them into your application.yml like the following.

To get your Spotify spDc cookie go here

To get your Apple Music api token go here

To get your Deezer arl cookie go here

To get your Yandex Music access token go here

To get your Vk Music user token go here

Warning

YES plugins 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 here
    sources:
      spotify: false # Enable Spotify source
      applemusic: false # Enable Apple Music source
      deezer: false # Enable Deezer source
      yandexmusic: false # Enable Yandex Music source
      flowerytts: false # Enable Flowery TTS source
      youtube: true # Enable YouTube search source (https://github.com/topi314/LavaSearch)
      vkmusic: false # Enable Vk Music source
    lyrics-sources:
      spotify: false # Enable Spotify lyrics source
      deezer: false # Enable Deezer lyrics source
      youtube: false # Enable YouTube lyrics source
      yandexmusic: false # Enable Yandex Music lyrics source
      vkmusic: true # Enable Vk Music lyrics source
    spotify:
      clientId: "your client id"
      clientSecret: "your client secret"
      # spDc: "your sp dc cookie" # the sp dc cookie used for accessing the spotify lyrics api
      countryCode: "US" # the country code you want to use for filtering the artists top tracks. See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
      playlistLoadLimit: 6 # The number of pages at 100 tracks each
      albumLoadLimit: 6 # The number of pages at 50 tracks each
      resolveArtistsInSearch: 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-2
      mediaAPIToken: "your apple music api token" # apple music api token
      # or specify an apple music key
      keyID: "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 each
      albumLoadLimit: 6 # The number of pages at 300 tracks each
    deezer:
      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 is optional but required for formats above MP3_128
      formats: [ "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 arl
    yandexmusic:
      accessToken: "your access token" # the token used for accessing the yandex music api. See https://github.com/TopiSenpai/LavaSrc#yandex-music
      playlistLoadLimit: 1 # The number of pages at 100 tracks each
      albumLoadLimit: 1 # The number of pages at 50 tracks each
      artistLoadLimit: 1 # The number of pages at 10 tracks each
    flowerytts:
      voice: "default voice" # (case-sensitive) get default voice from here https://api.flowery.pw/v1/tts/voices
      translate: false # whether to translate the text to the native language of voice
      silence: 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 mp3
    youtube:
      countryCode: "US" # the country code you want to use for searching lyrics via ISRC. See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
    vkmusic:
      userToken: "your user token" # This token is needed for authorization in the api. Guide: https://github.com/topi314/LavaSrc#vk-music
      playlistLoadLimit: 1 # The number of pages at 50 tracks each
      artistLoadLimit: 1 # The number of pages at 10 tracks each
      recommendationsLoadLimit: 10 # Number of tracks

Plugin Info

LavaSrc adds the following fields to tracks & playlists in Lavalink

Track

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": {
        ...
    }
}

Playlist

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": [
        ...
    ]
}

Playlist Types

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

Update Settings at Runtime

Sometimes you may want to update the settings at runtime without restarting Lavalink. This can be done by sending a PATCH request to the /v4/lavasrc/config endpoint. Keep in mind this will NOT update the settings in the application.yml file. If you restart Lavalink the settings will be reset to the ones in the application.yml file.

PATCH /v4/lavasrc/config

LavaSrc Config Object

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
Spotify Config Object
Field Type Description
?clientId string The Spotify clientId
?clientSecret string The Spotify clientSecret
?spDc string The Spotify spDc cookie
Apple Music Config Object
Field Type Description
?mediaAPIToken string The Apple Music api token
Deezer Config Object
Field Type Description
?arl string The Deezer arl cookie
?formats array of Deezer Format The Deezer formats
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
Yandex Music Config Object
Field Type Description
?accessToken string The Yandex Music access token
Vk Music Config Object
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"
    }
}

Lavaplayer Usage

Replace x.y.z with the latest version number

Snapshot builds are instead available in https://maven.topi.wtf/snapshots with the short commit hash as the version

Using in Gradle:

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"
}

Using in Maven:

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>

Spotify

To get a Spotify clientId & clientSecret you must go here and create a new application.

How to get sp dc cookie
  1. Go to https://open.spotify.com
  2. Open DevTools and go to the Application tab
  3. Copy the value of the sp_dc cookie
AudioPlayerManager playerManager = new DefaultAudioPlayerManager();

// 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 LavaLyrics
var spotify = new SpotifySourceManager(clientId, clientSecret, spDc, countryCode, () -> playerManager, DefaultMirroringAudioTrackResolver);
playerManager.registerSourceManager(spotify);

LavaLyrics

Click to expand 
// create new lyrics manager
var lyricsManager = new LyricsManager();

// register source
lyricsManager.registerLyricsManager(spotify);

LavaSearch

Click to expand 
// create new search manager
var searchManager = new SearchManager();

// register source
searchManager.registerSearchManager(spotify);

Apple Music

How to get media api token without Apple developer account
  1. Go to https://music.apple.com
  2. Open DevTools and go to the Debugger tab
  3. Search with this regex "(?<token>(ey[\w-]+)\.([\w-]+)\.([\w-]+))" in all index-*.js files
  4. Copy the token from the source code

Alternatively, you can follow this guide

AudioPlayerManager playerManager = new DefaultAudioPlayerManager();

// create a new AppleMusicSourceManager with the standard providers, apple music api token, countrycode and AudioPlayerManager and register it
var appleMusic = new AppleMusicSourceManager(null, mediaAPIToken , "us", playerManager);
playerManager.registerSourceManager(appleMusic);

LavaSearch

Click to expand 
// create new search manager
var searchManager = new SearchManager();

// register source
searchManager.registerSearchManager(appleMusic);

Deezer

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.

AudioPlayerManager playerManager = new DefaultAudioPlayerManager();

// create a new DeezerSourceManager with the master decryption key and register it

var deezer = new DeezerSourceManager("the master decryption key", "your arl", formats);
playerManager.registerSourceManager(deezer);

LavaLyrics

Click to expand 
// create new lyrics manager
var lyricsManager = new LyricsManager();

// register source
lyricsManager.registerLyricsManager(deezer);

LavaSearch

Click to expand 
// create new search manager
var searchManager = new SearchManager();

// register source
searchManager.registerSearchManager(deezer);

Yandex Music

How to get access token
  1. (Optional) Open DevTools in your browser and on the Network tab enable trotlining.
  2. Go to https://oauth.yandex.ru/authorize?response_type=token&client_id=23cabbbdc6cd418abb4b39c32c41195d
  3. Authorize and grant access
  4. 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. image
  5. Your accessToken, what is after access_token.

Token expires in 1 year. You can get a new one by repeating the steps above.

Important information

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.

AudioPlayerManager playerManager = new DefaultAudioPlayerManager();

// create a new YandexMusicSourceManager with the access token and register it
var yandex = new YandexMusicSourceManager("...");

playerManager.registerSourceManager(yandex);

LavaLyrics

Click to expand 
// create new lyrics manager
var lyricsManager = new LyricsManager();

// register source
lyricsManager.registerLyricsManager(yandex);

LavaSearch

Click to expand 
// create new search manager
var searchManager = new SearchManager();

// register source
searchManager.registerSearchManager(yandex);

Flowery Text-to-Speech

Get list of all voices and languages supported here

AudioPlayerManager playerManager = new DefaultAudioPlayerManager();

// create a new FloweryTTSSourceManager 
playerManager.registerSourceManager(new FloweryTTSSourceManager());
// create a new FloweryTTSSourceManager with a default voice
playerManager.registerSourceManager(new FloweryTTSSourceManager("..."));

Vk Music

How to get user token

WARNING!

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.

  1. Go to the authorization page Marusya application
  2. Authorize through your vk account.
  3. A link like this https://oauth.vk.com/blank.html#access_token=$$$$$&expires_in=0&user_id=$$$$$@[email protected]
  4. Copy your token and paste it into your config! Enjoy captcha-free vk music!
AudioPlayerManager playerManager = new DefaultAudioPlayerManager();

// create a new VkMusicSourceManager with the user token and register it
playerManager.registerSourceManager(new VkMusicSourceManager("...");

LavaLyrics

Click to expand 
// create new lyrics manager
var lyricsManager = new LyricsManager();

// register source
lyricsManager.registerLyricsManager(vkmusic);

LavaSearch

Click to expand 
// create new search manager
var searchManager = new SearchManager();

// register source
searchManager.registerSearchManager(vkmusic);

Supported URLs and Queries

Spotify

(including new regional links like https://open.spotify.com/intl-de/track/0eG08cBeKk0mzykKjw4hcQ)

Apple Music

Deezer

Yandex Music

Flowery TTS

You can read about all the available options here, a list of available voices is here

  • ftts://hello%20world
  • ftts://hello%20world?audio_format=ogg_opus&translate=False&silence=1000&speed=1.0&voice=09924826-684f-51e9-825b-cf85aed2b2cf

Vk Music