Browse Source

Update docs

pull/24/head 1.1
kmille 2 years ago
parent
commit
28bd28136a
  1. 36
      README.md
  2. BIN
      screenshots/2020-05-13-213544_screenshot.png

36
README.md

@ -1,9 +1,9 @@
## Music Downloader :notes :headphones:: :dancer: :unicorn :
## Music Downloader :notes: :headphones: :dancer: :unicorn:
### Features
- download songs, albums, public playlists from Deezer.com (Account is required, free plan is enough)
- download Spotify playlists (by parsing the Spotify website and download it from Deezer)
- download songs, albums, public playlists from Deezer.com (account is required, free plan is enough)
- download Spotify playlists (by parsing the Spotify website and download the songs from Deezer)
- download as zip file (including m3u8 playlist file)
- 320 kbit/s mp3s with ID3-Tags and album cover
- download songs via youtube-dl
@ -15,9 +15,9 @@
### How to use it
There is a settings file template called `settings.ini.example`. You can specify the download directory with `download_dir`. Pressing the download button only downloads the song/album/playlist. If you set `use_mpd=True` in the `settings.ini` the backend will connect to mpd (localhost:6600) and update the music database. Pressing the play button will download the music. If `use_mpd=True` is set the mpd database will be updated and the song/album/playlist will be added to the playlist. In `settings.ini` `music_dir` should be the root of the music for mpd. The `download_dir` must be a subdirectory of `music_dir`.
There is a settings file template called `settings.ini.example`. You can specify the download directory with `download_dir`. Pressing the download button only downloads the song/album/playlist. If you set `use_mpd=True` in the `settings.ini` the backend will connect to mpd (localhost:6600) and update the music database. Pressing the play button will download the music. If `use_mpd=True` is set the mpd database will be updated and the song/album/playlist will be added to the playlist. In `settings.ini` `music_dir` should be the music root location of mpd. The `download_dir` must be a subdirectory of `music_dir`.
As Deezer sometimes requires a captcha to login the auto login features is disabled. Instead you have to manually insert the Deezer cookie to the `settings.ini` file. The relevant cookie is the `sid` cookie. A dedicated thread in the background is used to keep the cookie active.
As Deezer sometimes requires a captcha to login the auto login features was removed. Instead you have to manually insert a valid Deezer cookie to the `settings.ini`. The relevant cookie is the `sid` cookie. A dedicated thread in the background is used to keep the cookie alive.
@ -28,7 +28,7 @@ We use it with nginx and [ympd](https://github.com/notandy/ympd) as mpd frontend
- / goes to ympd
- /d/ goes to the downloader
Dhe deployment directory contains a systemd unit file and a nginx vhost config file. There is also a [patch](https://github.com/kmille/music-ansible/blob/master/roles/ympd/files/fix_header.patch) to add a link to the ympd frontend. The `debug` tab will show you the debug output of the app.
The deployment directory contains a systemd unit file and a nginx vhost config file. There is also a [patch](https://github.com/kmille/music-ansible/blob/master/roles/ympd/files/fix_header.patch) to add a link to the ympd frontend. The `debug` tab will show you the debug output of the app.
@ -80,11 +80,15 @@ ctrl-shift-[1-7] switch tabs
### Some screenshots
Search for songs. You can listen to a 30 second preview in the browser
Search for songs. You can listen to a 30 second preview in the browser.
![](/screenshots/2020-05-13-211356_screenshot.png)
Search for albums. You can download them as zip file
Search for albums. You can download them as zip file.
![](/screenshots/2020-05-13-213544_screenshot.png)
List songs of an album.
![](/screenshots/2020-05-13-211528_screenshot.png)
@ -92,15 +96,15 @@ Download songs with youtube-dl
![](/screenshots/2020-05-13-211622_screenshot.png)
Download a Spotify playlist
Download a Spotify playlist.
![](/screenshots/2020-05-13-211629_screenshot.png)
Download a Deezer playlist
Download a Deezer playlist.
![](/screenshots/2020-05-13-211633_screenshot.png)
ncmpcpp mpd client
ncmpcpp mpd client.
![](/screenshots/2020-05-13-212025_screenshot.png)
@ -117,3 +121,13 @@ https://github.com/kmille/music-ansible (almost always outdated)
### Changelog
#### Version 1.1 (13.05.2020)
- thanks to [luelista](https://github.com/luelista) for the contribution!
- play 30 second preview in browser
- add Vagrantfile
- show album cover in search results
- use a threaded queue for download tasks
- list album songs

BIN
screenshots/2020-05-13-213544_screenshot.png

After

Width: 1129  |  Height: 634  |  Size: 2.1 MiB

Loading…
Cancel
Save