From 73928b98e7a813b391dddad6c19c42a022321ad9 Mon Sep 17 00:00:00 2001 From: topi314 Date: Tue, 20 Aug 2024 19:22:27 +0200 Subject: [PATCH] cleanup README --- README.md | 83 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 47 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index caee9c9..82c8581 100644 --- a/README.md +++ b/README.md @@ -85,15 +85,26 @@ For all supported urls and queries see [here](#supported-urls-and-queries) To get a Spotify clientId & clientSecret you must go [here](https://developer.spotify.com/dashboard) 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 + +
+ + ```java 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 +##### LavaLyrics
Click to expand @@ -106,7 +117,7 @@ lyricsManager.registerLyricsManager(spotify); ```
-#### LavaSearch +##### LavaSearch
Click to expand @@ -120,16 +131,23 @@ searchManager.registerSearchManager(spotify);
+--- + +#### Apple Music +
-How to get sp dc cookie +How to get media api token without Apple developer account -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 +1. Go to https://music.apple.com +2. Open DevTools and go to the Debugger tab +3. Search with this regex `"(?(ey[\w-]+)\.([\w-]+)\.([\w-]+))"` in all `index-*.js` files +4. Copy the token from the source code
-#### Apple Music +Alternatively, you can +follow [this guide](https://developer.apple.com/help/account/configure-app-capabilities/create-a-media-identifier-and-private-key/) + ```java AudioPlayerManager playerManager = new DefaultAudioPlayerManager(); @@ -138,7 +156,8 @@ var appleMusic = new AppleMusicSourceManager(null, mediaAPIToken , "us", playerM playerManager.registerSourceManager(appleMusic); ``` -#### LavaSearch +##### LavaSearch +
Click to expand @@ -151,46 +170,34 @@ searchManager.registerSearchManager(appleMusic); ```
-
-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 `"(?(ey[\w-]+)\.([\w-]+)\.([\w-]+))"` in all `index-*.js` files -4. Copy the token from the source code - -
- -Alternatively, you can -follow [this guide](https://developer.apple.com/help/account/configure-app-capabilities/create-a-media-identifier-and-private-key/) +--- #### Deezer -```java -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); -``` -
How to get deezer master decryption key -Use google. +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. +Use Google to find a guide on how to get the arl cookie. It's not that hard.
+```java +AudioPlayerManager playerManager = new DefaultAudioPlayerManager(); + +// create a new DeezerSourceManager with the master decryption key and register it -#### LavaLyrics +var deezer = new DeezerSourceManager("the master decryption key", "your arl", formats); +playerManager.registerSourceManager(deezer); +``` + +##### LavaLyrics
Click to expand @@ -203,7 +210,7 @@ lyricsManager.registerLyricsManager(deezer); ```
-#### LavaSearch +##### LavaSearch
Click to expand @@ -216,6 +223,8 @@ searchManager.registerSearchManager(deezer); ```
+--- + #### Yandex Music
@@ -256,7 +265,7 @@ var yandex = new YandexMusicSourceManager("..."); playerManager.registerSourceManager(yandex); ``` -#### LavaLyrics +##### LavaLyrics
Click to expand @@ -269,7 +278,7 @@ lyricsManager.registerLyricsManager(yandex); ```
-#### LavaSearch +##### LavaSearch
Click to expand @@ -282,6 +291,8 @@ searchManager.registerSearchManager(yandex); ```
+--- + #### Flowery Text-to-Speech Get list of all voices and languages supported [here](https://api.flowery.pw/v1/tts/voices) @@ -375,7 +386,7 @@ plugins: 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 + # 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