SMLoadr/README.md

199 lines
5.4 KiB
Markdown
Raw Normal View History

2018-01-19 16:16:15 +01:00
#SMLoadr
> A streaming music downloader.
![Screenshot](screenshot.png)
2018-01-19 16:16:15 +01:00
SMLoadr is a program for downloading music from streaming music services.
It is intended for educational and private use only, and not as a tool for pirating and distributing music!
Remember that the artists and studios put a lot of work into making music - purchase music to support them.
2018-02-03 17:30:18 +01:00
## Features
2018-01-19 16:16:15 +01:00
- Download music in excellent quality for free
- Supports single tracks, albums, artists, playlists and users favourite tracks
2018-01-30 21:32:30 +01:00
- Music quality selection (MP3 - 128 kbps, MP3 - 320 kbps, FLAC - 1411 kbps)
2018-01-19 16:16:15 +01:00
- Auto tagging MP3 & FLAC files (with album cover)
- Saves music to "DOWNLOADS/[artist]/[album]/[track_number] [title].mp3/flac"
- Download a list of links from "downloadLinks.txt"
- CLI support
2018-02-03 17:30:18 +01:00
## Supported sites
2018-01-19 16:16:15 +01:00
- Currently only Deezer is supported.
- We'll add more in the future ;)
2018-02-03 17:30:18 +01:00
## Supported platforms
2018-01-19 16:16:15 +01:00
- Windows x64
- Windows x86
- Linux x64
- Linux x86
- MacOS x64
2018-02-03 17:30:18 +01:00
- Android (Run from source, see guide below)
- ARM like Raspberry Pi (Run from source)
2018-01-19 16:16:15 +01:00
2018-02-03 17:30:18 +01:00
## How to use (Windows)
2018-01-19 16:16:15 +01:00
2018-01-31 19:38:00 +01:00
Run it as admin if you get "EPERM: operation not permitted..." error!
2018-02-03 17:30:18 +01:00
###Interactive:
2018-01-19 16:16:15 +01:00
```
Double click the exe :)
```
2018-02-03 17:30:18 +01:00
###CLI:
2018-01-19 16:16:15 +01:00
```
.\SMLoadr-win-x64.exe -q "MP3_128" -p "DOWNLOADS/" "http://www.deezer.com/album|artist|playlist|profile|track/0123456789"
```
2018-02-03 17:30:18 +01:00
## How to use (Linux/MacOS)
2018-01-19 16:16:15 +01:00
2018-02-03 17:30:18 +01:00
See "How to use (from source)" to run it on ARM devices like the Raspberry Pi.
2018-01-19 16:16:15 +01:00
2018-02-03 17:30:18 +01:00
###Interactive:
2018-01-19 16:16:15 +01:00
```
2018-02-03 20:07:20 +01:00
chmod +x SMLoadr-linux-x64
2018-01-20 00:31:29 +01:00
./SMLoadr-linux-x64
2018-01-19 16:16:15 +01:00
```
2018-02-03 17:30:18 +01:00
###CLI:
2018-01-19 16:16:15 +01:00
```
2018-02-03 20:07:20 +01:00
chmod +x SMLoadr-linux-x64
2018-01-20 00:31:29 +01:00
./SMLoadr-linux-x64 -q "MP3_128" -p "DOWNLOADS/" "http://www.deezer.com/album|artist|playlist|profile|track/0123456789"
2018-01-19 16:16:15 +01:00
```
2018-02-03 17:30:18 +01:00
## How to use (Android)
2018-04-10 18:10:07 +02:00
Installing SMLoadr on Android is a little bit complicated and **not officially supported** :/
If you need help, tag @sudoHackr in Telegram, and don't expect many people to help you.
2018-01-24 21:24:09 +01:00
2018-02-03 17:30:18 +01:00
### 1. Install Termux
In order to run SMLoadr on Android you have to install `Termux`.
- Play Store: [link](https://play.google.com/store/apps/details?id=com.termux)
- Apk Mirror: [link](https://www.apkmirror.com/apk/fredrik-fornwall/termux)
### 2. Install dependencies
Run `Termux` and enter these lines in the given order (If it asks you if you want to continue, enter `y`):
```
pkg update
pkg upgrade
2018-02-03 19:02:31 +01:00
pkg install nodejs git
2018-02-03 18:55:13 +01:00
2018-02-03 17:30:18 +01:00
```
### 3. Download
First download the latest version from the repo:
```
2018-02-03 18:55:13 +01:00
git clone --depth 1 https://git.teknik.io/SMLoadrDev/SMLoadr.git
2018-02-03 17:30:18 +01:00
```
### 4. Install
2018-02-03 18:55:13 +01:00
2018-02-03 19:01:14 +01:00
Move files and remove unnecessary ones:
```
2018-04-10 21:42:50 +02:00
mv SMLoadr/{package.json,SMLoadr.js,./libs/} ./
rm -rf SMLoadr
2018-02-03 18:55:13 +01:00
```
Now we install what we've downloaded:
2018-02-03 17:30:18 +01:00
```
npm install
```
2018-02-03 19:40:39 +01:00
Patch openurl:
```
sed -i 's/linux/android/' node_modules/openurl/openurl.js
```
2018-02-03 18:55:13 +01:00
2018-02-03 19:40:39 +01:00
### 5. Setup storage
2018-02-03 18:55:13 +01:00
In order to let SMLoadr download to the right folder, we need to setup storage for `Termux`:
2018-02-03 17:30:18 +01:00
```
termux-setup-storage
```
2018-02-03 18:55:13 +01:00
Now we trick SMLoadr into downloading to the public storage:
```
mkdir ~/storage/shared/SMLoadr
ln -s ~/storage/shared/SMLoadr DOWNLOADS
```
### 6. Run
Last but not least run the app (downloaded files will be in a folder named SMLoadr in public storage):
2018-02-03 17:30:18 +01:00
```
node SMLoadr.js
```
2018-04-10 19:51:19 +02:00
### 7. Updating to a new version
2018-02-03 18:55:13 +01:00
To update it, run step 3 and step 4
2018-02-03 17:30:18 +01:00
## How to use (from source)
2018-04-10 18:07:09 +02:00
To run it from source you have to install [Node.js](https://nodejs.org/) first (>= 8.0.0 is required).
After that download the repo and execute the following commands in the directory:
2018-01-24 21:24:09 +01:00
```
npm i
node SMLoadr.js
```
2018-02-03 17:30:18 +01:00
## CLI parameters
2018-01-19 16:16:15 +01:00
| Parameter | Short | Default | Supported values | Description |
| :----------------- | :------------------ | :--------------- | :-------------------------------------- | :----------------------------------- |
2018-01-30 21:32:30 +01:00
| ```--quality``` | ```-q``` | ```MP3_320``` | MP3_128/MP3_320/FLAC | The quality of the files to download |
2018-01-19 16:16:15 +01:00
| ```--path``` | ```-p``` | ```DOWNLOADS/``` | Path with / in the end | The path to download the files to |
| ```--url``` | ```-u or nothing``` | | album/artist/playlist/profile/track url | Downloads single deezer url |
| ```--downloadmode``` | ```-d``` | ```single``` | ```all``` for "downloadLinks.txt" | Downloads multiple urls from list |
2018-01-30 21:32:30 +01:00
| ```--help``` | ```-h``` | | _Nothing_ | Shows the CLI help |
2018-01-19 16:16:15 +01:00
2018-02-03 17:30:18 +01:00
## Downloads
2018-01-19 16:16:15 +01:00
- Get stable releases here: [https://git.teknik.io/SMLoadrDev/SMLoadr/releases](https://git.teknik.io/SMLoadrDev/SMLoadr/releases)
2018-01-19 16:16:15 +01:00
- Telegram news channel: [https://t.me/SMLoadrNews](https://t.me/SMLoadrNews)
- Telegram community group: [https://t.me/SMLoadrCommunity](https://t.me/SMLoadrCommunity)
- Telegram off-topic group: [https://t.me/SMLoadrOffTopic](https://t.me/SMLoadrOffTopic)
2018-02-03 17:30:18 +01:00
## Donate
2018-01-19 16:16:15 +01:00
- **BTC:** 15GktD5M1kCmESyxfhA6EvmhGzWnRA8gvg
- **BTC Cash:** 1LpLtLREzTWzba94wBBpJxcv7r6h6u1jgF
- **ETH:** 0xd07c98bF53b21c4921E7b30491Fe0B86E714afeD
- **ETH Classic:** 0x7b8f83e4cE082BfCe5B6f6E4F204c914e925f242
- **LTC:** LXJwhRmjfUruuwp76rJmLrhJJjHSG8TNxm
- **DASH:** XmHzFcygcwtqabgfEtJyq9cen1G5EnvuGR
2018-02-03 17:30:18 +01:00
## Disclaimer
2018-01-19 16:16:15 +01:00
- We do **not** call to commit crimes.
- The usage of this tool **may be illegal** in your country! Please inform yourself.
2018-01-19 16:30:05 +01:00
- We do **not** give any guarantee at all and we am **not** responsible for damages of all kinds!
2018-02-03 17:30:18 +01:00
2018-01-19 16:33:21 +01:00
---
2018-01-24 21:24:09 +01:00
> Made with :heart: & :beer: by SMLoadrDevs | Copyright © 2018 SMLoadrDevs.