Skip to content

3raxton/spicetify-custom-apps-and-extensions

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Spicetify Custom Apps and Extensions

A repository to help users find custom apps and extensions for spicetify-cli

More Custom Apps and Extensions For Spicetify License


Summary

  • 🔥 A central location for custom apps and extensions for Spicetify
  • 👀 More features
  • 🎉 Open source

Determining Which Folder to Use

  • If you have the updated design of Spotify and use Spicetify 2.1.0 or later
    • Utilize extensions and custom apps in the v2 folder

  • If you have the still use the legacy design of Spotify and use Spicetify 1.2.1 or prior
    • Utilize extensions and custom apps in the v1 folder

How to add Custom Apps or Extensions to Spicetify

  1. Install spicetify-cli using the instructions found here
  2. Click on the green Code button at the top right of this repo and choose Download ZIP
  3. Unzip the .zip file
  4. Open the v1 or v2 folder based on the criteria above
  5. Choose the app that you want from either the v1 or v2 folder and drag it out of the folder
  6. Open the spicetify-cli CustomApps folder (paths can be found below)
  7. Drag the custom app into the CustomApps folder
  8. Open config.ini and add the name of the custom app to the custom_apps line separated by the | character
[AdditionalOptions]
...
custom_apps = reddit|genius|yourownapp
  • OR add the respective apps / extension by typing:
spicetify config extensions CustomAppOrExtensionName.js
  1. Run spicetify backup apply in the command line and Spicetify will install the app
  2. You're set! 🎉

CustomApps Folder Paths

Platform Path
macOS ~/spicetify_data/CustomApps
OR
$SPICETIFY_CONFIG/CustomApps
Windows %userprofile%.spicetify\CustomApps\
Linux ~/.config/spicetify/CustomApps
OR
$XDG_CONFIG_HOME/.config/spicetify/CustomApps/

Want to contribute your custom app(s) to this repo?

Follow the instructions below or read the CONTRIBUTING.md file!

  1. Fork this repository
  2. Create another folder with your custom app name in all lower case with no symbols (dashes and underscores are okay) or spaces.
    • Ensure the files and folders don't contain the word Spicetify
  3. Copy the necessary files into the folder
  4. Create a README.md in it with the following structure
# App Name

## Screenshots

[Put at least one image of the app working / app details here]

## More

[Specify any dependencies, author name, and any other info about the custom app]
  1. (Optional) Add your name and custom apps or extensions to the AUTHORS.md file
    • If you decide to add your name, please use the following format
# Authors
...
### [Your name](link to website, GitHub profile, donation page, etc.)

- [Your custom app](link to repo)
     - Your custom app description and other info
  1. Open a Pull Request

Support

There are multiple ways you can get support if you run into any issues or need help troubleshooting any custom apps or extensions

  • Reach out to the Spicetify community on Discord
  • Take a look at previous issues on the Spicetify Community's Spectrum

If you find any bugs or you'd like to request a feature, open an issue using the respective template.


Licenses

  • Each custom app or extension hosted in this repo falls under the license utilized by the maintainer

  • The layout of this repository is licensed under the Braxton Huff License (BRAX) by Braxton Huff and only includes the following files:

    • AUTHORS.md
    • CODE_OF_CONDUCT.md
    • CONTRIBUTING.md
    • LICENSE.md
    • README.md

  • This license may be modified and/or adapted upon discussion with the original copyright owner

If there is any other problem, please refer to the Spicetify website docs to help troubleshoot your problem.

Hopefully this helps improve your use of Spotify and treats you well! Cheers!