From 628609be64de9485fdd0cfaec68681fe73089a41 Mon Sep 17 00:00:00 2001 From: uh wot Date: Fri, 22 Jul 2022 14:54:25 +0200 Subject: [PATCH] added readme --- README.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c5ab6bf --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# orpheusdl-deezer +[OrpheusDL](https://github.com/yarrm80s/orpheusdl) module for downloading music from [Deezer](https://www.deezer.com/) + +# Getting started +## Prerequisites +- [OrpheusDL](https://github.com/yarrm80s/orpheusdl), duh + +## Installation +- Clone the repository from your ```orpheusdl``` directory:\ +```git clone https://github.com/uhwot/orpheusdl-deezer modules/deezer``` +- Update ```config/settings.json``` with Deezer settings:\ +```python orpheus.py``` + +# Configuration +## Global +```download_quality```: +| Value | Format | +| ---------- | ---------------------------------------------------------------------------- | +| "hifi" | 16-bit 44.1kHz FLAC / 360RA if available and ```spatial_codecs``` is enabled | +| "lossless" | 16-bit 44.1kHz FLAC | +| "high" | MP3 320kbps | +| "medium" | MP3 320kbps | +| "low" | MP3 128kbps | +| "minimum" | MP3 128kbps | + +```spatial_codecs```:\ +Enables 360RA downloads if ```download_quality``` is set to ```hifi``` + +```main_resolution```:\ +Maxes out at 3000px\ +If original cover size is smaller than the one specified, falls back to 1200px + +## Deezer +| Setting | Description | +| --------------- | --------------------------------------------------- | +| `client_id` | Client ID used for login | +| `client_secret` | Client secret used for login | +| `bf_secret` | Constant for deriving key used for track decryption | +| `track_url_key` | Key used for legacy track URL generation | +| `email` | Account email | +| `password` | Account password | \ No newline at end of file