/ README.md
README.md
  1  <br>
  2      <a href="https://github.com/yaronzz/Tidal-Media-Downloader-PRO">[GUI-REPOSITORY]</a>
  3  <br>
  4  
  5  ![Tidal-Media-Downloader](https://socialify.git.ci/yaronzz/Tidal-Media-Downloader/image?description=1&font=Rokkitt&forks=1&issues=1&language=1&name=1&owner=1&pattern=Circuit%20Board&stargazers=1&theme=Dark)
  6  
  7  
  8  <div align="center">
  9    <h1>Tidal-Media-Downloader</h1>
 10    <a href="https://github.com/yaronzz/Tidal-Media-Downloader/blob/master/LICENSE">
 11      <img src="https://img.shields.io/github/license/yaronzz/Tidal-Media-Downloader.svg?style=flat-square" alt="">
 12    </a>
 13    <a href="https://github.com/yaronzz/Tidal-Media-Downloader/releases">
 14      <img src="https://img.shields.io/github/v/release/yaronzz/Tidal-Media-Downloader.svg?style=flat-square" alt="">
 15    </a>
 16    <a href="https://www.python.org/">
 17      <img src="https://img.shields.io/github/issues/yaronzz/Tidal-Media-Downloader.svg?style=flat-square" alt="">
 18    </a>
 19    <a href="https://github.com/yaronzz/Tidal-Media-Downloader">
 20      <img src="https://img.shields.io/github/downloads/yaronzz/Tidal-Media-Downloader/total?label=tidal-gui%20download" alt="">
 21    </a>
 22    <a href="https://pypi.org/project/tidal-dl/">
 23      <img src="https://img.shields.io/pypi/dm/tidal-dl?label=tidal-dl%20download" alt="">
 24    </a>
 25    <a href="https://github.com/yaronzz/Tidal-Media-Downloader/actions/workflows/build.yml">
 26      <img src="https://github.com/yaronzz/Tidal-Media-Downloader/actions/workflows/build.yml/badge.svg" alt="">
 27    </a>
 28  </div>
 29  <p align="center">
 30    «Tidal-Media-Downloader» is an application that lets you download videos and tracks from Tidal. It supports two version: tidal-dl and tidal-gui. (This repository only contains tidal-dl, and the release isn't the newest gui version.)
 31      <br>
 32          <a href="https://github.com/yaronzz/Tidal-Media-Downloader-PRO/releases">Download</a> |
 33          <a href="https://doc.yaronzz.com/post/tidal_dl_installation/">Documentation</a> |
 34          <a href="https://doc.yaronzz.com/post/tidal_dl_installation_chn/">中文文档</a> |
 35      <br>
 36  </p>
 37  
 38  ## 📺 Installation 
 39  
 40  ```shell
 41  pip3 install tidal-dl --upgrade
 42  ```
 43  
 44  | USE                                                   | FUNCTION                   |
 45  | ----------------------------------------------------- | -------------------------- |
 46  | tidal-dl                                              | Show interactive interface |
 47  | tidal-dl -h                                           | Show help-message          |
 48  | tidal-dl -l "https://tidal.com/browse/track/70973230" | Download link              |
 49  | tidal-dl -g                                           | Show simple-gui            |
 50  
 51  If you are using windows system, you can use [tidal-pro](https://github.com/yaronzz/Tidal-Media-Downloader-PRO)
 52  
 53  ### Nightly Builds
 54  
 55  |Download nightly builds from continuous integration: 	| [![Build Status][Build]][Actions] 
 56  |-------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
 57  
 58  [Actions]: https://github.com/yaronzz/Tidal-Media-Downloader/actions
 59  [Build]: https://github.com/yaronzz/Tidal-Media-Downloader/workflows/Tidal%20Media%20Downloader/badge.svg
 60  
 61  ## 🤖 Features
 62  - Download album \ track \ video \ playlist \ artist-albums
 63  
 64  - Add metadata to songs
 65  
 66  - Selectable video resolution and track quality
 67  
 68  ## 💽 User Interface
 69  
 70  <img src="https://i.loli.net/2020/08/19/gqW6zHI1SrKlomC.png" alt="image" style="zoom: 50%;" />
 71  
 72  ![image-20220708105823257](https://s2.loli.net/2022/07/08/vV6HsxugwoDyGr8.png)
 73  
 74  ![image-20200806013705425](https://i.loli.net/2020/08/06/sPLowIlCGyOdpVN.png)
 75  
 76  ## Settings - Possible Tags
 77  
 78  ### Album
 79  
 80  | Tag               | Example value                        |
 81  | ----------------- | ------------------------------------ |
 82  | {ArtistName}      | The Beatles                          |
 83  | {AlbumArtistName} | The Beatles                          |
 84  | {Flag}            | M/A/E  (Master/Dolby Atmos/Explicit) |
 85  | {AlbumID}         | 55163243                             |
 86  | {AlbumYear}       | 1963                                 |
 87  | {AlbumTitle}      | Please Please Me (Remastered)        |
 88  | {AudioQuality}    | LOSSLESS                             |
 89  | {DurationSeconds} | 1919                                 |
 90  | {Duration}        | 31:59                                |
 91  | {NumberOfTracks}  | 14                                   |
 92  | {NumberOfVideos}  | 0                                    |
 93  | {NumberOfVolumes} | 1                                    |
 94  | {ReleaseDate}     | 1963-03-22                           |
 95  | {RecordType}      | ALBUM                                |
 96  | {None}            |                                      |
 97  
 98  ### Track
 99  
100  | Tag               | Example Value                              |
101  | ----------------- | ------------------------------------------ |
102  | {TrackNumber}     | 01                                         |
103  | {ArtistName}      | The Beatles                                |
104  | {ArtistsName}     | The Beatles                                |
105  | {TrackTitle}      | I Saw Her Standing There (Remastered 2009) |
106  | {ExplicitFlag}    | (*Explicit*)                               |
107  | {AlbumYear}       | 1963                                       |
108  | {AlbumTitle}      | Please Please Me (Remastered)              |
109  | {AudioQuality}    | LOSSLESS                                   |
110  | {DurationSeconds} | 173                                        |
111  | {Duration}        | 02:53                                      |
112  | {TrackID}         | 55163244                                   |
113  
114  ### Video
115  
116  | Tag               | Example Value                              |
117  | ----------------- | ------------------------------------------ |
118  | {VideoNumber}     | 00                                         |
119  | {ArtistName}      | DMX                                        |
120  | {ArtistsName}     | DMX, Westside Gunn                         |
121  | {VideoTitle}      | Hood Blues                                 |
122  | {ExplicitFlag}    | (*Explicit*)                               |
123  | {VideoYear}       | 2021                                       |
124  | {TrackID}         | 188932980                                  |
125  
126  ## ☕ Support
127  
128  If you really like my projects and want to support me, you can buy me a coffee and star this project. 
129  
130  <a href="https://www.buymeacoffee.com/yaronzz" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/arial-orange.png" alt="Buy Me A Coffee" style="height: 51px !important;width: 217px !important;" ></a>
131  
132  ## 🎂 Contributors
133  This project exists thanks to all the people who contribute. 
134  
135  <a href="https://github.com/yaronzz/Tidal-Media-Downloader/graphs/contributors"><img src="https://contributors-img.web.app/image?repo=yaronzz/Tidal-Media-Downloader" /></a>
136  
137  ## 🎨 Libraries and reference
138  
139  - [aigpy](https://github.com/yaronzz/AIGPY)
140  - [python-tidal](https://github.com/tamland/python-tidal)
141  - [redsea](https://github.com/redsudo/RedSea)
142  - [tidal-wiki](https://github.com/Fokka-Engineering/TIDAL/wiki)
143  
144  ## 📜 Disclaimer
145  - Private use only.
146  - Need a Tidal-HIFI subscription. 
147  - You should not use this method to distribute or pirate music.
148  - It may be illegal to use this in your country, so be informed.
149  
150  ## Developing
151  
152  ```shell
153  pip3 uninstall tidal-dl
154  pip3 install -r requirements.txt --user
155  python3 setup.py install
156  ```