therandomlabs / scoop-spotify Goto Github PK

A Scoop bucket for Spotify, Spicetify and related packages.

License: The Unlicense

PowerShell 100.00%

scoop scoop-bucket scoop-apps spotify spicetify spicetify-cli spicetify-extensions spicetify-themes spicetify-custom-apps spicetify-apps

scoop-spotify's Introduction

Scoop-Spotify

A Scoop bucket for Spotify, Spicetify and related packages.

$ scoop bucket add spotify https://github.com/TheRandomLabs/Scoop-Spotify.git

...I've spent an unhealthy amount of time on automating all of this.

Also check out my personal bucket and my Python bucket!

spotify-latest: hash check failed

If the spotify-latest manifest has recently been updated, this error may occur because depending on the region, the old installer may stay cached for a bit. To work around this issue, pass the -s or --skip flag to Scoop when updating the package.

Notes

None of the packages in this bucket can be installed globally.
If you have the means, please buy Spotify Premium instead of installing BlockTheSpot.
All of the Spicetify packages require Spotify to be installed either through this Scoop bucket or the official installer.
All themes, extensions and custom apps for Spicetify should be installed to ~\.spicetify instead of the spicetify-cli installation directory.
Installing or updating any of the packages in this bucket automatically applies the Spicetify configuration and preserves BlockTheSpot if it is installed.
All Spicetify packages apart from spicetify-cli depend on spicetify-cli.
--purge or -p should be used to fully uninstall all packages apart from blockthespot, google-spicetify and spicetify-themes.

BlockTheSpot

This blocks advertisements for the latest version of Spotify.
This package depends on spotify-latest.
This is not an executable program. spotify-latest will be patched automatically every time this package or any of the Spicetify packages are installed or updated.
If BlockTheSpot is ever reset, blockthespot can be run to reapply it. This usually happens after running Spicetify commands, and running spicetify-apply rather than spicetify apply ensures that BlockTheSpot is enabled if it is installed.

genius-spicetify

See here to configure a custom Musixmatch user token. manifest.json can be found at ~\.spicetify\CustomApps\genius\manifest.json.

spicetify-autoVolume

See here to modify the configuration. autoVolume.js can be found at ~\.spicetify\Extensions\autoVolume.js.

spicetify-cli

Experimental features, fast user switching and all default extensions apart from Auto Skip Videos and DJ Mode are enabled by default.
spicetify-apply is should be run instead of spicetify apply if BlockTheSpot is installed, as it ensures that BlockTheSpot is enabled if it is installed.
It should be noted that spicetify-apply also runs spicetify restore and spicetify backup before running spicetify apply to ensure that changes are applied every time.
For similar reasons, spicetify-enable-devtool and spicetify-disable-devtool should be run instead of spicetify enable-devtool and spicetify disable-devtool.
The three above commands also support the -quiet switch.

spicetify-jqbx

This requires Spotify Premium.

spicetify-themes

The Elementary theme requires the Open Sans and Raleway fonts:

$ scoop bucket add nerd-fonts
$ sudo scoop install Open-Sans Raleway

The WintergatanBlueprint theme requires the Ubuntu font:

$ scoop bucket add nerd-fonts
$ sudo scoop install Ubuntu-NF

Spotify (latest)

This is the latest version of Spotify.
Unlike Ash258's version, this version installs completely silently and to the Scoop directory.
Spotify's built-in updater is disabled, and Scoop should be used to update it instead.
Spotify should be installed locally and not globally.
This cannot be installed concurrently with spotify-with-blockthespot.

Spotify with BlockTheSpot

This is an outdated version of Spotify (1.1.4.197.g92d52c4f) with an old version of BlockTheSpot.
Spotify's built-in updater is disabled.
This should only be used if BlockTheSpot does not work with the latest version of Spotify.
Spotify with BlockTheSpot should be installed locally and not globally.
Installation and uninstallation of this package require administrator privileges.
This cannot be installed concurrently with spotify-latest.

Installing and customizing Spotify

First, the latest version of Spotify should be installed:

$ scoop install spotify-latest

Note that Spotify should not be installed globally, as it stores files in user-specific directories.

Once Spotify is installed, spicetify-cli can be installed to customize the Spotify client:

$ scoop install spicetify-cli

Again, spicetify-cli should be installed locally, as it also stores files in a user-specific location.

spicetify-themes can be installed for a collection of community-created themes for Spicetify. Obviously, this should also be installed locally:

$ scoop install spicetify-themes

google-spicetify is also available:

$ scoop install google-spicetify

I can recommend the Adapta-Nokto theme, which can be applied by running the following:

$ spicetify config current_theme Adapta-Nokto
$ spicetify-apply

As an example, I will also demonstrate the installation of the Elementary theme, which requires Open Sans and Raleway to be installed:

$ scoop bucket add nerd-fonts
$ sudo scoop install Open-Sans Raleway
$ spicetify config current_theme Elementary
$ spicetify-apply

To install spicetify-cli and apply a theme silently, the theme can be configured before installing spicetify-themes. When any of the Spicetify packages are installed, the current configuration is applied, and if Spotify was open previously, it is reopened.

$ scoop install spicetify-cli
$ spicetify config current_theme Elementary
$ scoop install spicetify-themes

genius-spicetify can be installed to fetch lyrics from Genius or Musixmatch:

$ scoop install genius-spicetify

spicetify-autoVolume can be installed to automatically decrease the volume at specific intervals of time:

$ scoop install spicetify-autovolume

BlockTheSpot can be installed to block advertisements:

$ scoop install blockthespot

All of the above packages can be updated through Scoop.

If you don't care about reading any of this and just want a quick way to install ad-blocked Spotify with the Elementary theme, genius-spicetify and developer tools, copy and paste this into PowerShell:

Set-ExecutionPolicy RemoteSigned -Scope CurrentUser -Force
Invoke-Expression (New-Object System.Net.WebClient).DownloadString('https://get.scoop.sh')

scoop install git sudo

scoop bucket add nerd-fonts
sudo scoop install Open-Sans Raleway --global

scoop bucket add spotify https://github.com/TheRandomLabs/Scoop-Spotify.git
scoop install spotify-latest blockthespot spicetify-cli spicetify-themes genius-spicetify spicetify-autovolume

spicetify config current_theme Elementary --quiet
spicetify-enable-devtool -quiet

Or even shorter, but with Adapta-Nokto instead:

$ Set-ExecutionPolicy RemoteSigned -Scope CurrentUser -Force; iwr -useb https://raw.githubusercontent.com/TheRandomLabs/Scoop-Spotify/master/basic-setup.ps1 | iex