tidal-hifi/README.md

107 lines
3.1 KiB
Markdown
Raw Normal View History

<h1>
Tidal-hifi
2019-11-03 18:52:15 +01:00
<img src = "./build/icon.png" height="40" align="right" />
</h1>
2019-09-16 23:13:12 +02:00
The web version of [listen.tidal.com](listen.tidal.com) running in electron with hifi support thanks to widevine.
![tidal-hifi preview](./docs/preview.png)
## Table of contents
2019-09-16 23:13:12 +02:00
<!-- toc -->
- [Installation](#installation)
- [Using releases](#using-releases)
- [Snap install](#snap-install)
- [Using source](#using-source)
2019-11-03 18:52:15 +01:00
- [features](#features)
2019-09-16 23:13:12 +02:00
- [Integrations](#integrations)
- [Why](#why)
- [Why not extend existing projects?](#why-not-extend-existing-projects)
- [Special thanks to..](#special-thanks-to)
2019-09-16 23:13:12 +02:00
<!-- tocstop -->
## Installation
2019-09-16 23:13:12 +02:00
### Using releases
Various packaged versions of the software are available on the [releases](https://github.com/Mastermindzh/tidal-hifi/releases) tab.
#### Snap install
To install with `snap` you need to download the pre-packaged snap-package from this repository, found under releases:
2020-10-04 11:52:08 +02:00
1. Download:
```sh
wget <URI> #for instance: https://github.com/Mastermindzh/tidal-hifi/releases/download/1.0/tidal-hifi_1.0.0_amd64.snap
```
2020-10-04 11:52:08 +02:00
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-hifi:
```sh
trizen 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
- cd tidal-hifi
- npm install
- npm start
2019-11-03 18:52:15 +01:00
## features
- HiFi playback
- Notifications
- Shortcuts ([source](https://defkey.com/tidal-desktop-shortcuts))
- API for status and playback
- [Settings feature](./docs/settings.png) to disable certain functionality. (`ctrl+/`)
2019-11-03 18:52:15 +01:00
## Integrations
- [i3 blocks config](https://github.com/Mastermindzh/dotfiles/commit/9714b2fa1d670108ce811d5511fd3b7a43180647) - My dotfiles where I use this app to fetch currently playing music (direct commit)
2020-01-18 12:10:49 +01:00
### Known bugs
2020-10-04 11:52:08 +02:00
2020-01-18 12:10:49 +01:00
- [Last.fm login doesn't work](https://github.com/Mastermindzh/tidal-hifi/issues/4).
## Why
2019-09-16 23:13:12 +02:00
I moved from Spotify over to Tidal and found Linux support to be lacking.
2019-09-16 23:13:12 +02:00
When I started this project there weren't any Linux apps that offered Tidal's "hifi" options nor any scripts to control it.
2019-09-16 23:13:12 +02:00
## 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 a 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 then making it available to the public :)
## Special thanks to...
- [Castlabs](https://castlabs.com/)
For maintaining Electron with Widevine CDM installation, Verified Media Path (VMP), and persistent licenses (StorageID)
## Buy me a coffee? Please don't
2020-10-07 20:33:39 +02:00
Instead spend some money on a charity I care for: [kwf.nl](secure.kwf.nl/donation).
Inspired by [haydenjames' issue](https://github.com/Mastermindzh/tidal-hifi/issues/27#issuecomment-704198429)