Skip to content

Commit

Permalink
Update and layout repo for future developments
Browse files Browse the repository at this point in the history
This push moves legacy extensions into a "v1" folder and actively developed extensions into a "v2" folder

The README and licensing has been updated for clarity per each extension within the repo

Release notes to come if this doesn't break anything 🔥
  • Loading branch information
3raxton committed May 1, 2022
1 parent 8e92c34 commit 14b89ea
Show file tree
Hide file tree
Showing 58 changed files with 33 additions and 10 deletions.
File renamed without changes.
43 changes: 33 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,22 @@ target="_blank"><br><img width="100" src="https://emojipedia-us.s3.dualstack.us-
<a><img src="https://img.shields.io/badge/more-Custom%20Apps%20&amp;%20Extensions-orange.svg" alt="More Custom Apps and Extensions"></a>
<a><img src="https://img.shields.io/badge/for-spicetify-E71A0E.svg" alt="For Spicetify"></a>
<a href="https://3raxton.github.io/license"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License"></a>
<a href="https://hits.seeyoufarm.com"><img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2F3raxton%2Fspicetify-customapps%2F&count_bg=%23E71A0E&title_bg=%23000000&icon=spotify.svg&icon_color=%23E71A0E&title=hits&edge_flat=false"/></a></p>
<!-- <a href="https://hits.seeyoufarm.com"><img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2F3raxton%2Fspicetify-customapps%2F&count_bg=%23E71A0E&title_bg=%23000000&icon=spotify.svg&icon_color=%23E71A0E&title=hits&edge_flat=false"/></a></p> -->

<br>

## Summary
- 🔥 A central location for custom apps and extensions for spicetify-cli
- 👀 More features
- 🎉 Open source

<br>

## How to add Custom Apps or Extensions to Spicetify

1. [Install spicetify-cli using the instructions found here](https://github.com/khanhas/spicetify-cli/wiki/Installation)
2. Click on the green `Code` button at the <b>top right</b> of this repo and choose ```Download ZIP```
3. Unzip the .zip file
1. [Install spicetify-cli using the instructions found here](https://spicetify.app/docs/getting-started)
2. Click on the green `Code` button at the <b>top right</b> of this repo and choose ```Download ZIP```
3. Unzip the .zip file
4. Choose the app that you want and drag it out of the folder
5. Open the spicetify-cli CustomApps folder (paths can be found below)
6. Drag the custom app into the CustomApps folder
Expand All @@ -35,14 +39,17 @@ spicetify config extensions CustomAppOrExtensionName.js
8. Run ```spicetify backup apply``` in the command line and Spicetify will install the app
9. You're set! 🎉

<br>

### CustomApps Folder Paths

| **Platform**|**Path** |
| ------------|--------------------------------------------------------------------------------------------|
| **macOS** |~/spicetify_data/Themes <br> **OR**<br>$SPICETIFY_CONFIG/CustomApps |
| **macOS** |~/spicetify_data/CustomApps <br> **OR**<br>$SPICETIFY_CONFIG/CustomApps |
| **Windows** |%userprofile%\.spicetify\CustomApps\ |
| **Linux** |~/.config/spicetify/CustomApps <br> **OR**<br>$XDG_CONFIG_HOME/.config/spicetify/CustomApps/|

<br>

## Want to contribute your custom app(s) to this repo?
Follow the instructions below or read the <a href="https://github.com/3raxton/spicetify-custom-apps/blob/main/CONTRIBUTING.md" target="_blank">CONTRIBUTING.md file</a>!
Expand All @@ -57,7 +64,7 @@ Follow the instructions below or read the <a href="https://github.com/3raxton/sp
## Screenshots
[Put at least one image of the app working here]
[Put at least one image of the app working / app details here]
## More
Expand All @@ -75,19 +82,35 @@ Follow the instructions below or read the <a href="https://github.com/3raxton/sp
```
6. Open a Pull Request

<br>

## 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](https://discord.gg/VnevqPp2Rr)
* Create a [discussion](https://github.com/khanhas/spicetify-cli/discussions) in the spicetify-cli repository
<!-- * Create a [discussion](https://github.com/khanhas/spicetify-cli/discussions) in the spicetify-cli repository -->
* Take a look at previous issues on the Spicetify Community's [Spectrum](https://spectrum.chat/spicetify)

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

## 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)](https://3raxton.github.io/license/BRAX) by [Braxton Huff](https://github.com/3raxton)
* This includes the following files:
<br> <br>
* AUTHORS.md
* CODE_OF_CONDUCT.md
* CONTRIBUTING.md
* LICENSE.md
* README.md
<br><br>
* This license may be modified and/or adapted upon discussion with the repo's original copyright owner
<br><br>

## License
Licensed under the [MIT License](https://3raxton.github.io/license) by [Braxton Huff](https://github.com/3raxton)

### **If there is any other problem, please refer to the <a href="https://github.com/khanhas/spicetify-cli/wiki" target="_blank">spicetify-cli wiki</a> to help troubleshoot your problem.**
### **If there is any other problem, please refer to the <a href="https://spicetify.app/docs/getting-started" target="_blank">spicetify website docs</a> to help troubleshoot your problem.**

### **Hopefully this helps improve your use of Spotify and treats you well! Cheers!**
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 14b89ea

Please sign in to comment.