Skip to content

Commit faa1c35

Browse files
authored
Update README.md
1 parent 8ed1f51 commit faa1c35

File tree

1 file changed

+46
-5
lines changed

1 file changed

+46
-5
lines changed

README.md

+46-5
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,20 @@ Supports Windows, MacOS and Linux.
1919
- [Auto Skip Videos](#auto-skip-videos)
2020
- [Christian Spotify](#christian-spotify)
2121
- [DJ Mode](#dj-mode)
22+
- [Keyboard Shortcut](#keyboard-shortcut)
2223
- [Queue All](#queue-all)
2324
- [Shuffle+](#shuffle)
2425
- [Trash Bin](#trash-bin)
25-
26+
- Default Custom apps:
27+
- [Reddit](#reddit)
2628
- [Development](#development)
2729

2830
## Features
2931
- Change colors whole UI
3032
- Inject CSS for advanced customization
3133
- Inject Extensions (Javascript script) to extend functionalities, manipulate UI and control player.
32-
- Enable some additional, hidden features
34+
- Inject Custom apps
35+
- Enable additional, hidden features
3336
- Remove bloated components to improve performance
3437

3538
![mac_demo1](https://i.imgur.com/JyWVzeC.png)
@@ -104,7 +107,7 @@ spicetify update
104107
```
105108
to update your theme.
106109

107-
In Spotify, hit <kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>R</kbd>/<kbd>Command</kbd> <kbd>Shift</kbd> <kbd>R</kbd> to reload and receive visual update of your theme.
110+
In Spotify, hit <kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>R</kbd> / <kbd>Command</kbd> <kbd>Shift</kbd> <kbd>R</kbd> to reload and receive visual update of your theme.
108111

109112
For other commands and additional flags information, please run:
110113
```bash
@@ -178,6 +181,19 @@ Easily setting up the client for your friends or audiences to choose, add song t
178181

179182
![Ext_DJDemo](https://i.imgur.com/pOFEqtM.png)
180183

184+
#### Keyboard Shortcut
185+
**Filename:** `keyboardShortcut.js`
186+
187+
Register some useful keybinds to support keyboard-driven navigation in Spotify client. Less time touching the mouse.
188+
- <kbd>Ctrl</kbd> <kbd>Tab</kbd> / <kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>Tab</kbd>: Navigate items in left sidebar menu.
189+
- <kbd>Backspace</kbd>/<kbd>Shift</kbd> <kbd>Backspace</kbd>: Navigate history backward/forward.
190+
- <kbd>PageUp</kbd>/<kbd>PageDown</kbd>: Force scroll up/down app page only (because mouse focus is sometimes in sidebar region and they scroll sidebar instead of app page).
191+
- <kbd>J</kbd>/<kbd>K</kbd>: Scroll app page up/down. \*Tips hat to Vim users\*
192+
- <kbd>Ctrl</kbd> <kbd>Q</kbd>: Open Queue page.
193+
- <kbd>`</kbd>: Open up keyboard-driven navigation. Hit correct key sequences to open up place you want to go:
194+
195+
![KeyboardDemo](https://i.imgur.com/YX09Lc1.png)
196+
181197
#### Queue All
182198
**Filename:** `queueAll.js`
183199
You like using Discover, New Releases page to find new music but adding each one of them to queue takes a lot of effort? If so, activate this extensions and apply. At top of every carousel now has a "Queue All" button to help you add all of them to queue. Note: Not available for playlist carousels. Just songs, albums ones.
@@ -202,6 +218,32 @@ Throw songs/artists to trash bin and never hear them again (automatically skip).
202218
![Ext_Trash1](https://i.imgur.com/k7A7oBI.png) | ![Ext_Trash2](https://i.imgur.com/dVZclSJ.png)
203219
---|---
204220

221+
### Custom apps
222+
Inject custom apps to Spotify and access them in left sidebar.
223+
Add your desired custom app folder names in config, separated them by `|` character.
224+
Example:
225+
```ini
226+
[AdditionalOptions]
227+
...
228+
custom_apps = reddit|yourownapp
229+
```
230+
231+
App folders can be store in:
232+
- `CustomApps` folder in Home directory:
233+
**Windows:** `%userprofile%\.spicetify\CustomApps\`
234+
**Linux:** `~/.spicetify/CustomApps/`
235+
**MacOS:** `~/spicetify_data/CustomApps`
236+
- `CustomApps` folder in Spicetify executable directory.
237+
238+
If there are 2 apps having same name, app in Home directory is prioritized.
239+
240+
I included my own app to demonstrate how to make and inject an app:
241+
242+
#### Reddit
243+
Fetching top 100 Spotify posts in any subreddit. This app has native feels and behavior just like other Spotify apps: you can follow, save, play, open playlist/track/album directly. Moreover, it also can fetch Youtube posts and play them inside Spotify.
244+
245+
![RedditDemo](https://i.imgur.com/OTrW2e8.png)
246+
205247
## Development
206248
### Requirements
207249
- [Go](https://golang.org/dl/)
@@ -226,5 +268,4 @@ go build -o spicetify
226268
```
227269

228270
### Future
229-
- [ ] SASS
230-
- [ ] Inject custom apps
271+
- [ ] SASS

0 commit comments

Comments
 (0)