mirror of
https://github.com/Mastermindzh/tidal-hifi.git
synced 2024-11-22 21:42:46 +01:00
179 lines
7.0 KiB
Markdown
179 lines
7.0 KiB
Markdown
# TIDAL Hi-Fi (Max quality)<img src = "./build/icon.png" height="40" align="right"/>
|
|
|
|
 [](https://github.com/Mastermindzh/tidal-hifi/actions) [](https://ci.mastermindzh.tech/Mastermindzh/tidal-hifi) [](https://discord.gg/yhNwf4v4He)
|
|
|
|
The web version of [listen.tidal.com](https://listen.tidal.com) running in electron with Hi-Fi (High & Max) support thanks to widevine.
|
|
|
|
|
|
|
|
## Table of Contents
|
|
|
|
<!-- toc -->
|
|
|
|
- [TIDAL Hi-Fi (Max quality)](#tidal-hi-fi-max-quality)
|
|
- [Table of Contents](#table-of-contents)
|
|
- [Features](#features)
|
|
- [Contributions](#contributions)
|
|
- [Why did I create TIDAL Hi-Fi?](#why-did-i-create-tidal-hi-fi)
|
|
- [Why not extend existing projects?](#why-not-extend-existing-projects)
|
|
- [Installation](#installation)
|
|
- [Dependencies](#dependencies)
|
|
- [Using releases](#using-releases)
|
|
- [Snap](#snap)
|
|
- [Arch Linux](#arch-linux)
|
|
- [Flatpak](#flatpak)
|
|
- [Nix](#nix)
|
|
- [Using source](#using-source)
|
|
- [Integrations](#integrations)
|
|
- [Known bugs](#known-bugs)
|
|
- [DRM not working on Windows](#drm-not-working-on-windows)
|
|
- [Special thanks to](#special-thanks-to)
|
|
- [Donations](#donations)
|
|
- [Images](#images)
|
|
- [Settings window](#settings-window)
|
|
- [User setups](#user-setups)
|
|
|
|
<!-- tocstop -->
|
|
|
|
## Features
|
|
|
|
- HiFi playback (High & Max settings)
|
|
- Notifications
|
|
- Custom [theming](./docs/theming.md)
|
|
- Custom hotkeys ([source](https://defkey.com/tidal-desktop-shortcuts))
|
|
- Better icons thanks to [Papirus-icon-theme](https://github.com/PapirusDevelopmentTeam/papirus-icon-theme/)
|
|
- [Settings feature](./docs/images/settings.png) to disable certain functionality. (`ctrl+=` or `ctrl+0`)
|
|
- API for status, playback and settings (see the [/docs](http://localhost:47836/docs/) route)
|
|
- Disabled audio & visual ads, unlocked lyrics, suggested track, track info, and unlimited skips thanks to uBlockOrigin custom filters ([source](https://github.com/uBlockOrigin/uAssets/issues/17495))
|
|
- AlbumArt in integrations ([best-effort](https://github.com/Mastermindzh/tidal-hifi/pull/88#pullrequestreview-840814847))
|
|
- Custom [integrations](#integrations)
|
|
- [ListenBrainz](https://listenbrainz.org/?redirect=false) integration
|
|
- Songwhip.com integration (hotkey `ctrl + w`)
|
|
- Discord RPC integration (showing "now listening", "Browsing", etc)
|
|
- MPRIS integration
|
|
- UI + Json config (`~/.config/tidal-hifi/`, or `~/.var/app/com.mastermindzh.tidal-hifi/` for Flatpak)
|
|
|
|
## Contributions
|
|
|
|
To contribute you can use the standard GitHub features (issues, prs, etc.) or join the discord server to talk with like-minded individuals.
|
|
|
|
-  [Join the Discord server](https://discord.gg/yhNwf4v4He)
|
|
|
|
## Why did I create TIDAL Hi-Fi?
|
|
|
|
I moved from Spotify over to Tidal and found Linux support to be lacking.
|
|
When I started this project there weren't any Linux apps that offered Tidal's "hifi" options nor any scripts to control it.
|
|
I made this app to support the highest quality audio available on the Linux platform. It used to be "hifi" but now is ["High & Max"](https://tidal.com/sound-quality).
|
|
|
|
### Why not extend existing projects?
|
|
|
|
Whilst there are a handful of projects attempting to run Tidal on Electron they are all unappealing to me because of various reasons:
|
|
|
|
- Lack of maintainers/developers. (no hotfixes, no issues being handled etc)
|
|
- Most are simple web wrappers, not my cup of tea.
|
|
- Some are DE-oriented. I want this to work on WM's too.
|
|
- None have Widevine working at the moment
|
|
|
|
Sometimes it's just easier to start over, cover my own needs and after that making it available to the public :)
|
|
|
|
## Installation
|
|
|
|
### Dependencies
|
|
|
|
Note that you **need** a notification library such as [libnotify](https://github.com/GNOME/libnotify) or [dunst](https://github.com/dunst-project/dunst) for the software to work properly.
|
|
|
|
### Using releases
|
|
|
|
Various packaged versions of the software are available on the [releases](https://github.com/Mastermindzh/tidal-hifi/releases) tab.
|
|
|
|
### Snap
|
|
|
|
To install with `snap` you need to download the pre-packaged snap-package from this repository, found under releases:
|
|
|
|
1. Download
|
|
|
|
```sh
|
|
wget <URI> #for instance: https://github.com/Mastermindzh/tidal-hifi/releases/download/1.0/tidal-hifi_1.0.0_amd64.snap
|
|
```
|
|
|
|
2. Install
|
|
|
|
```sh
|
|
snap install --dangerous <path> #for instance: tidal-hifi_1.0.0_amd64.snap
|
|
```
|
|
|
|
### Arch Linux
|
|
|
|
Arch Linux users can use the AUR to install TIDAL Hi-Fi:
|
|
|
|
```sh
|
|
trizen tidal-hifi-git
|
|
```
|
|
|
|
### Flatpak
|
|
|
|
To install via [Flatpak](https://flathub.org/apps/details/com.mastermindzh.tidal-hifi) run the following command:
|
|
|
|
```sh
|
|
flatpak install flathub com.mastermindzh.tidal-hifi
|
|
```
|
|
|
|
### Nix
|
|
|
|
To install with Nix run the following command:
|
|
|
|
```sh
|
|
nix-env -iA nixpkgs.tidal-hifi
|
|
```
|
|
|
|
### Using source
|
|
|
|
To install and work with the code on this project follow these steps:
|
|
|
|
- `git clone [https://github.com/Mastermindzh/tidal-hifi.git](https://github.com/Mastermindzh/tidal-hifi.git)`
|
|
- `cd tidal-hifi`
|
|
- `npm install`
|
|
- `npm run watch` to watch for auto-reload of Typescript/SCSS changes.
|
|
- `npm run compile` can be used to trigger it once
|
|
- `npm watchStart` to auto watch for any updates files and reload Tidal Hi-Fi
|
|
- `npm start` can be used to run Tidal Hi-Fi manually once
|
|
|
|
## Integrations
|
|
|
|
TIDAL Hi-Fi comes with several integrations out of the box.
|
|
You can find these in the settings menu (`ctrl + =` by default) under the "integrations" tab.
|
|
|
|
|
|
|
|
Integrations with other projects that are not included natively:
|
|
|
|
- [i3 blocks config](https://github.com/Mastermindzh/dotfiles/commit/9714b2fa1d670108ce811d5511fd3b7a43180647) - My dotfiles where I use this app to fetch currently playing music (direct commit)
|
|
- [neptune](https://github.com/uwu/neptune) third party plugins & theming
|
|
|
|
## Known bugs
|
|
|
|
### DRM not working on Windows
|
|
|
|
Most Windows users run into DRM issues when trying to use TIDAL Hi-Fi.
|
|
Nothing I can do about that I'm afraid... Tidal is working on removing/changing DRM so when they finish with that we can give it another shot.
|
|
|
|
## Special thanks to
|
|
|
|
- [Castlabs](https://castlabs.com/)
|
|
For maintaining Electron with Widevine CDM installation, Verified Media Path (VMP), and persistent licenses (StorageID)
|
|
|
|
## Donations
|
|
|
|
You can find my Github sponsorship page at: [https://github.com/sponsors/Mastermindzh](https://github.com/sponsors/Mastermindzh)
|
|
|
|
## Images
|
|
|
|
### Settings window
|
|
|
|
|
|
|
|
### User setups
|
|
|
|
Some of our users are kind enough to share their usage pictures.
|
|
If you want to see them or possibly even add one please do so in the following issue: [#3 - image thread](https://github.com/Mastermindzh/tidal-hifi/issues/3).
|