SpotX-Linux-Ridged/readme.md

91 lines
3.3 KiB
Markdown
Raw Permalink Normal View History

2022-10-23 21:44:38 -06:00
<p align="center">
<a href="https://github.com/SpotX-CLI/SpotX-Linux"><img src="https://raw.githubusercontent.com/SpotX-CLI/SpotX-commons/main/.github/Pic/Logo/logo-linux.png" />
2022-10-23 21:44:38 -06:00
</p>
<p align="center">
2023-05-20 01:21:59 -06:00
<a href="https://discord.gg/eYudMwgYtY"><img src="https://discord.com/api/guilds/807273906872123412/widget.png"></a>
2022-10-23 21:44:38 -06:00
</p>
***
2022-10-20 16:26:40 -06:00
<center>
<h4 align="center">A multi-featured adblocker for the Spotify Linux application.</h4>
2022-10-20 16:26:40 -06:00
<p align="center">
2023-07-03 07:11:42 -06:00
<strong>Last updated:</strong> 03 July 2023<br>
<strong>Last tested version:</strong> 1.2.3.1115
2022-10-20 16:26:40 -06:00
</p>
</center>
2023-03-06 01:56:36 -07:00
## We need collaborators.
- We are running short of people who can collaborate and maintain this project. If you are good with bash scripting, please create an issue here or contact Red.#1111 in discord.
2022-10-20 16:26:40 -06:00
### Features:
- Blocks all banner/video/audio ads within the app
2022-10-22 18:32:16 -06:00
- Blocks logging (Sentry, etc)
2022-10-20 16:26:40 -06:00
- Unlocks the skip function for any track
- Blocks Spotify automatic updates (optional)
- Enables [experimental features](https://github.com/SpotX-CLI/SpotX-Win/discussions/50) (optional)
- Hides podcasts, episodes and audiobooks on Home Screen (optional)
2022-10-20 16:26:40 -06:00
### Installation/Update:
NOTE: SpotX does not support the Spotify client from Snap
2022-10-20 16:26:40 -06:00
- Close Spotify completely.
- Run The following command in Terminal:
```
bash <(curl -sSL https://raw.githubusercontent.com/SpotX-CLI/SpotX-Linux/main/install.sh)
```
2023-04-05 16:17:23 -06:00
#### Flatpak Version
2023-04-24 19:31:00 -06:00
To install on the Flatpak version of Spotify:
2023-04-05 16:17:23 -06:00
```
2023-04-24 19:31:00 -06:00
bash <(curl -sSL https://raw.githubusercontent.com/SpotX-CLI/SpotX-Linux/main/install.sh) -P /var/lib/flatpak/app/com.spotify.Client/x86_64/stable/active/files/extra/share/spotify/
2023-04-05 16:17:23 -06:00
```
2022-10-20 16:26:40 -06:00
#### Optional Install Arguments:
`-c` Clear app cache -- use if UI-related patches aren't working
`-e` Experimental features -- enables experimental features
`-E` Exclude feature -- disables specified feature(s) [currently disabled]
2022-10-20 16:26:40 -06:00
`-f` Force patch -- forces re-patching if backup detected
`-h` Hide podcasts, episodes and audiobooks on home screen
`-o` Old UI -- skips forced 'new UI' patch
`-P` Path directory -- manually set Spotify directory if not found in PATH
2022-10-20 16:26:40 -06:00
`-p` Premium subscription setup -- use if premium subscriber
Use any combination of flags.
The following example clears app cache, adds experimental features and uses the new UI (if supported):
2022-10-20 16:26:40 -06:00
```
bash <(curl -sSL https://raw.githubusercontent.com/SpotX-CLI/SpotX-Linux/main/install.sh) -ce
2022-10-20 16:26:40 -06:00
```
### Uninstall:
- Close Spotify completely.
- Run The following command in Terminal:
```
bash <(curl -sSL https://raw.githubusercontent.com/SpotX-CLI/SpotX-Linux/main/uninstall.sh)
```
or
- Reinstall Spotify
2022-12-27 08:15:32 -07:00
### Notes:
2023-01-09 08:33:24 -07:00
- Audio/video ads during Podcast playback are currently NOT blocked with SpotX.
2022-12-27 08:15:32 -07:00
- Spicetify users: When using SpotX-Linux + Spicetify, the current script requires running SpotX first.
2022-10-20 16:26:40 -06:00
### DISCLAIMER
2022-10-22 18:42:47 -06:00
- Ad blocking is the main concern of this repo. Any other feature provided by SpotX-Linux or consequence of using those features will be the sole responsibility of the user, not BlockTheSpot/SpotX/SpotX-CLI/SpotX-Linux.
2022-10-20 16:26:40 -06:00
### Credits
- Thanks to [SpotX - amd64fox](https://github.com/amd64fox/spotx).
2023-02-02 14:07:29 -07:00
- Thanks to [@jetfir3](https://github.com/jetfir3) for the extended contribution
- Thanks to the peeps on Discord who tested these on various Linux distro's