From 23d36347239209468dc5eb1ac48bb3e423984388 Mon Sep 17 00:00:00 2001 From: OhItsTom <22730962+ohitstom@users.noreply.github.com> Date: Mon, 25 Sep 2023 10:18:39 +0100 Subject: [PATCH 1/3] feat: addons --- docs/addons/custom-apps.md | 51 +++++++++++++ docs/addons/extensions.md | 146 +++++++++++++++++++++++++++++++++++++ docs/addons/index.md | 10 +++ docs/addons/themes.md | 18 +++++ docusaurus.config.js | 4 + sidebars.js | 19 ++++- 6 files changed, 244 insertions(+), 4 deletions(-) create mode 100644 docs/addons/custom-apps.md create mode 100644 docs/addons/extensions.md create mode 100644 docs/addons/index.md create mode 100644 docs/addons/themes.md diff --git a/docs/addons/custom-apps.md b/docs/addons/custom-apps.md new file mode 100644 index 0000000..9bea262 --- /dev/null +++ b/docs/addons/custom-apps.md @@ -0,0 +1,51 @@ +--- +title: Custom Apps +description: 💥 Custom Apps for Spicetify. +--- + +Below are list of default custom apps that come with the distributed package: + +- [Reddit](#reddit) +- [New Releases](#new-releases) +- [Lyrics Plus](#lyrics-plus) + +### Reddit + +Fetching posts from any Spotify link sharing subreddit. You can add, remove, arrange subreddits and customize post visual in config menu (in Profile menu, top right button with your user name). + +![Reddit](https://i.imgur.com/MC3tpNZ.png) + +To install, run following commands: + +``` +spicetify config custom_apps reddit +spicetify apply +``` + +### New Releases + +Aggregate all new releases from favorite artists, podcasts. Time range, release type, and other filters can be customized in config menu (in Profile menu, top right button with your user name). Date format is based on your locale code (BCP47). + +![New Releases](https://i.imgur.com/MP9dTjt.png) + +To install, run following commands: + +``` +spicetify config custom_apps new-releases +spicetify apply +``` + +### Lyrics Plus + +Get access to the current track's lyrics from various lyrics providers (Musixmatch, Netease, Genius). Learn more [here](https://github.com/spicetify/spicetify-cli/tree/master/CustomApps/lyrics-plus). + +Colors, lyrics providers can be customized in config menu (in Profile menu, top right button with your user name). + +![Lyrics Plus](https://i.imgur.com/WtD080A.png) + +To install, run following commands: + +``` +spicetify config custom_apps lyrics-plus +spicetify apply +``` diff --git a/docs/addons/extensions.md b/docs/addons/extensions.md new file mode 100644 index 0000000..3841ba5 --- /dev/null +++ b/docs/addons/extensions.md @@ -0,0 +1,146 @@ +--- +title: Extensions +description: 🧩 Extensions for Spicetify. +--- + +Below are list of default extensions that come with the distributed package: + +- [Extensions](#extensions) + - [Auto Skip Videos](#auto-skip-videos) + - [Bookmark](#bookmark) + - [Christian Spotify](#christian-spotify) + - [Full App Display](#full-app-display) + - [Keyboard Shortcut](#keyboard-shortcut) + - [Loopy Loop](#loopy-loop) + - [Pop-up Lyrics](#pop-up-lyrics) + - [Shuffle+](#shuffle) + - [Trash Bin](#trash-bin) + - [Web Now Playing](#web-now-playing) +- [Legacy Extensions](#legacy-extensions) + - [DJ Mode](#dj-mode) + - [New Release](#new-release) + - [Queue All](#queue-all) + +### Auto Skip Videos + +**Filename:** `autoSkipVideo.js` + +Videos are unable to play in some regions because of Spotify's policy. Instead of jumping to next song in playlist, it just stops playing. And it's kinda annoying to open up the client to manually click next every times it happens. Use this extension to skip them automatically. + +### Bookmark + +**Filename:** `bookmark.js` + +Easily store and browse pages, play tracks or tracks in specific time. Useful for who wants to check out an artist, album later without following them or writing their name down. + +![Ext_bookmark](https://i.imgur.com/isgU4TS.png) + +### Christian Spotify + +**Filename:** `autoSkipExplicit.js` + +Auto skip explicit tracks. Toggle option is in Profile menu (top right button). + +![Ext_ChristianDemo](https://i.imgur.com/5reGrBb.png) + +### Full App Display + +**Filename:** `fullAppDisplay.js` + +Full App Display: Minimal album cover art display with beautiful blur effect background. Activating button locates in top bar. While in display mode, double click anywhere to exit. Right click anywhere to open setting menu. + +![Ext_FAD](https://i.imgur.com/S7CPQ2s.png) + +### Keyboard Shortcut + +**Filename:** `keyboardShortcut.js` + +Register some useful keybinds to support keyboard-driven navigation in Spotify client. Less time touching the mouse. + +- Ctrl Tab / Ctrl Shift Tab: Navigate items in left sidebar menu. +- Shift H/Shift L: Navigate history backward/forward. +- PageUp/PageDown: Force scroll up/down app page only (because mouse focus is sometimes in sidebar region and they scroll sidebar instead of app page). +- J/K: Scroll app page up/down. \*Tips hat to Vim users\* +- G/Shift G: Scroll to top or bottom +- M: Like/Unlike track +- /: Open search page +- Ctrl Q: Open Queue page. +- F: Open up keyboard-driven navigation. Hit correct key sequences to open up place you want to go: + +![KeyboardDemo](https://i.imgur.com/evkGv9q.png) + +### Loopy Loop + +**Filename:** `loopyLoop.js` + +Provide ability to mark start and end points on progress bar and automatically loop over that track portion. + +![LoopyLoop](https://i.imgur.com/YEkbjLC.png) + +### Pop-up Lyrics + +**Filename:** `popupLyrics.js` + +Have easy access to a pop-up window with the current song's lyrics. Click at microphone icon on top bar to open lyrics windows. Right click at the same icon to open config menu to customize looks and lyrics providers priorities. + +![Pop-up Lyrics](https://i.imgur.com/Nx9Lx7D.png) + +### Shuffle+ + +**Filename:** `shuffle+.js` +Shuffles using Fisher–Yates algorithm with zero bias. After installing extensions, right click album/playlist/artist item, there will be an option "Play with Shuffle+". You can also multiple select tracks and choose to "Play with Shuffle+". Moreover, enable option "Auto Shuffle+" in Profile menu to inject Shuffle+ into every play buttons, no need to right click anymore. + +![Shuffle](https://i.imgur.com/gxbnqSN.png) + +### Trash Bin + +**Filename:** `trashbin.js` +Throw songs/artists to trash bin and never hear them again (automatically skip). This extension will append a Throw to Trashbin option in tracks and artists link right click menu. + +![Ext_Trash](https://i.imgur.com/ZFTy5Rm.png) + +### Web Now Playing + +**Filename:** `webnowplaying.js` +For Rainmeter users, establish connection with WebNowPlaying plugin to send track metadata and control players. + +If you just want WebNowPlaying without changing UI color, CSS, run this: + +```powershell +spicetify config inject_css 0 replace_colors 0 +spicetify config extensions webnowplaying.js +spicetify apply +``` + +## Legacy Extensions + +If you are running Spicetify 1.2.1 or below, and a supported Spotify version, you may also have access to the extensions listed below. + +- [Legacy Extensions](#legacy-extensions) + - [DJ Mode](#dj-mode) + - [New Release](#new-release) + - [Queue All](#queue-all) + +### DJ Mode + +**Filename:** `djMode.js` + +Easily setting up the client for your friends or audiences to choose, add song to queue but prevent them to control player. Plays button in album track list/playlist are re-purposed to add track to queue, instead of play track directly. Hide Controls option also allow you to hide all control button in player bar, Play/More/Follow buttons in cards. + +![Ext_DJDemo](https://i.imgur.com/pOFEqtM.png) + +### New Release + +**Filename:** `newRelease.js` + +Aggregate all new releases from favorite artists, podcasts. Setting menu could be opened by right clicking at Bell icon. + +![Ext_newrelease](https://user-images.githubusercontent.com/26436809/86569793-50dd8480-bfb2-11ea-8d82-be238d719660.png) + +### Queue All + +**Filename:** `queueAll.js` + +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. + +![QueueAllDemo](https://i.imgur.com/D9ytt7K.png) diff --git a/docs/addons/index.md b/docs/addons/index.md new file mode 100644 index 0000000..2b7f49e --- /dev/null +++ b/docs/addons/index.md @@ -0,0 +1,10 @@ +--- +title: Addons +--- + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` \ No newline at end of file diff --git a/docs/addons/themes.md b/docs/addons/themes.md new file mode 100644 index 0000000..afa011e --- /dev/null +++ b/docs/addons/themes.md @@ -0,0 +1,18 @@ +--- +title: Themes +description: ✨ Themes for Spicetify. +--- + +The Spicetify community has created a huge library of themes which can be found in the following repositories: + +1. [spicetify/spicetify-themes](https://github.com/spicetify/spicetify-themes) - The official Spicetify themes repository. Feel free to contribute with more themes! +2. [NYRI4/Comfy-spicetify](https://github.com/NYRI4/Comfy-spicetify) +3. [williamckha/spicetify-fluent](https://github.com/williamckha/spicetify-fluent) +4. [JulienMaille/dribbblish-dynamic-theme](https://github.com/JulienMaille/dribbblish-dynamic-theme) +5. [Tetrax-10/Nord-Spotify](https://github.com/Tetrax-10/Nord-Spotify) +6. [Catpuccin/spicetify](https://github.com/catppuccin/spicetify) +7. Insert your theme here! + +:::note +This is not a completely exhaustive list, we recommend you check out our official themes repo or Marketplace for more +::: \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index 2b88ed1..7a1bbba 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -87,6 +87,10 @@ const config = { label: 'Advanced Usage', to: '/docs/advanced-usage', }, + { + label: 'Addons', + to: '/docs/addons', + }, { label: 'Development', to: '/docs/development', diff --git a/sidebars.js b/sidebars.js index 9d498f6..4482f66 100644 --- a/sidebars.js +++ b/sidebars.js @@ -27,10 +27,21 @@ const sidebars = { items: [ 'advanced-usage/installation', 'advanced-usage/uninstallation', - 'advanced-usage/command-line-interface', - 'advanced-usage/themes', - 'advanced-usage/extensions', - 'advanced-usage/custom-apps', + 'advanced-usage/command-line-interface' + ], + }, + { + type: 'category', + label: 'Addons', + link: { + type: 'generated-index', + description: "Here is a collection of official and popular addons, and what they do.", + slug: '/addons', + }, + items: [ + 'addons/themes', + 'addons/extensions', + 'addons/custom-apps', ], }, { From 9d4ed367a9d593190615f83d7427b086550a66ce Mon Sep 17 00:00:00 2001 From: OhItsTom <22730962+ohitstom@users.noreply.github.com> Date: Mon, 25 Sep 2023 11:48:53 +0100 Subject: [PATCH 2/3] actually move files --- docs/addons/custom-apps.md | 64 +++++++++- docs/addons/extensions.md | 92 ++++++++++---- docs/addons/themes.md | 15 +-- docs/advanced-usage/custom-apps.md | 111 ---------------- docs/advanced-usage/extensions.md | 196 ----------------------------- docs/advanced-usage/themes.md | 19 --- 6 files changed, 141 insertions(+), 356 deletions(-) delete mode 100644 docs/advanced-usage/custom-apps.md delete mode 100644 docs/advanced-usage/extensions.md delete mode 100644 docs/advanced-usage/themes.md diff --git a/docs/addons/custom-apps.md b/docs/addons/custom-apps.md index 9bea262..f032276 100644 --- a/docs/addons/custom-apps.md +++ b/docs/addons/custom-apps.md @@ -1,9 +1,69 @@ --- title: Custom Apps -description: 💥 Custom Apps for Spicetify. +description: 💥 Manually installing Custom Apps. --- -Below are list of default custom apps that come with the distributed package: +Custom Apps, similar to Extensions, are simply Javascript that will be injected into Spotify, that consists of a page that can be accessed from the sidebar. + +## Installing + +Custom Apps files can be stored in: + +- `CustomApps` folder in Home directory: + +| Platform | Path | +| ------------------- | -------------------------------------- | +| **Windows** | `%appdata%\spicetify\CustomApps\` | +| **Linux**/**MacOS** | `~/.config/spicetify/CustomApps` | + +- `CustomApps` folder in Spicetify executable directory. + +If there are 2 Custom Apps with the same name, the extension within the Home directory will be prioritized. + +After placing the Custom App file into correct folder, run following command to install it: + +```bash +spicetify config custom_apps +spicetify apply +``` + +**Note:** Using `config` command to add Custom Apps always append file name to existed extensions list. It does not replace the whole key's value. + +## Uninstalling + +If you want to remove a custom app from the current list of custom app you can always append a `-` after the file name: + +```bash +spicetify config custom_apps - +spicetify apply +``` + +## Custom Apps + +Inject custom apps to Spotify and access them in left sidebar. +Add your desired custom app folder names in config, separated them by `|` character. +Example: + +```ini +[AdditionalOptions] +... +custom_apps = reddit|yourownapp +``` + +App folders can be stored in: + +- `CustomApps` folder in Home directory: + +| Platform | Path | +| ------------------- | -------------------------------------- | +| **Windows** | `%appdata%\spicetify\CustomApps\` | +| **Linux**/**MacOS** | `~/.config/spicetify/CustomApps` | + +- `CustomApps` folder in Spicetify executable directory. + +If there are 2 apps having same name, app in Home directory is prioritized. + +Three apps have been included to demonstrate how to create and inject an app: - [Reddit](#reddit) - [New Releases](#new-releases) diff --git a/docs/addons/extensions.md b/docs/addons/extensions.md index 3841ba5..9ab6930 100644 --- a/docs/addons/extensions.md +++ b/docs/addons/extensions.md @@ -1,25 +1,76 @@ --- title: Extensions -description: 🧩 Extensions for Spicetify. +description: 🧩 Manually installing Extensions. --- +Extensions, in a nutshell, are JavaScript files that will be evaluated along with Spotify main JavaScript. + +## Installing + +Extension files can be stored in: + +- `Extensions` folder in Home directory: + +| Platform | Path | +| ------------------- | -------------------------------------- | +| **Windows** | `%appdata%\spicetify\Extensions\` | +| **Linux**/**MacOS** | `~/.config/spicetify/Extensions` | + +- `Extensions` folder in Spicetify executable directory. + +If there are 2 extensions with the same name, the extension within the Home directory will be prioritized. + +Some Spotify API endpoints are exposed and can be found in the global object `Spicetify`. Check out `global.d.ts` for API documentation. + +After placing the extension file into correct folder, run following command to install it: + +```bash +spicetify config extensions +spicetify apply +``` + +**Note:** Using `config` command to add extension always append file name to existed extensions list. It does not replace the whole key's value. + +## Uninstalling + +If you want to remove an extension from the current list of extensions you can always append a `-` after the file name: + +```bash +spicetify config extensions - +spicetify apply +``` + +## Manual Install + +You can always manually edit the config file, add your desired extension filenames in `extensions` key, separated them by `|` character. +Example: + +```ini +[AdditionalOptions] +... +extensions = autoSkipExplicit.js|queueAll.js|djMode.js|shuffle+.js|trashbin.js +``` + +Afterwards, you will need to run the following: + +``` +spicetify apply +``` + +## Extensions + Below are list of default extensions that come with the distributed package: -- [Extensions](#extensions) - - [Auto Skip Videos](#auto-skip-videos) - - [Bookmark](#bookmark) - - [Christian Spotify](#christian-spotify) - - [Full App Display](#full-app-display) - - [Keyboard Shortcut](#keyboard-shortcut) - - [Loopy Loop](#loopy-loop) - - [Pop-up Lyrics](#pop-up-lyrics) - - [Shuffle+](#shuffle) - - [Trash Bin](#trash-bin) - - [Web Now Playing](#web-now-playing) -- [Legacy Extensions](#legacy-extensions) - - [DJ Mode](#dj-mode) - - [New Release](#new-release) - - [Queue All](#queue-all) +- [Auto Skip Videos](#auto-skip-videos) +- [Bookmark](#bookmark) +- [Christian Spotify](#christian-spotify) +- [Full App Display](#full-app-display) +- [Keyboard Shortcut](#keyboard-shortcut) +- [Loopy Loop](#loopy-loop) +- [Pop-up Lyrics](#pop-up-lyrics) +- [Shuffle+](#shuffle) +- [Trash Bin](#trash-bin) +- [Web Now Playing](#web-now-playing) ### Auto Skip Videos @@ -88,7 +139,7 @@ Have easy access to a pop-up window with the current song's lyrics. Click at mic ### Shuffle+ **Filename:** `shuffle+.js` -Shuffles using Fisher–Yates algorithm with zero bias. After installing extensions, right click album/playlist/artist item, there will be an option "Play with Shuffle+". You can also multiple select tracks and choose to "Play with Shuffle+". Moreover, enable option "Auto Shuffle+" in Profile menu to inject Shuffle+ into every play buttons, no need to right click anymore. +Shuffles using Fisher–Yates algorithm with zero bias. After installing extensions, right click album/playlist/artist item, there will be an option "Play with Shuffle+". You can also multiple select tracks and choose to "Play with Shuffle+". ![Shuffle](https://i.imgur.com/gxbnqSN.png) @@ -116,10 +167,9 @@ spicetify apply If you are running Spicetify 1.2.1 or below, and a supported Spotify version, you may also have access to the extensions listed below. -- [Legacy Extensions](#legacy-extensions) - - [DJ Mode](#dj-mode) - - [New Release](#new-release) - - [Queue All](#queue-all) +- [DJ Mode](#dj-mode) +- [New Release](#new-release) +- [Queue All](#queue-all) ### DJ Mode diff --git a/docs/addons/themes.md b/docs/addons/themes.md index afa011e..15c780d 100644 --- a/docs/addons/themes.md +++ b/docs/addons/themes.md @@ -3,16 +3,17 @@ title: Themes description: ✨ Themes for Spicetify. --- -The Spicetify community has created a huge library of themes which can be found in the following repositories: +One of the most popular features in Spicetify is theming. +You can customize your Spotify to your **heart's** desire! +**However**, this is a very cumbersome task. + +For this reason, the theming heroes of the Spicetify community have created a huge library of themes which can be found in the following repositories: 1. [spicetify/spicetify-themes](https://github.com/spicetify/spicetify-themes) - The official Spicetify themes repository. Feel free to contribute with more themes! 2. [NYRI4/Comfy-spicetify](https://github.com/NYRI4/Comfy-spicetify) 3. [williamckha/spicetify-fluent](https://github.com/williamckha/spicetify-fluent) 4. [JulienMaille/dribbblish-dynamic-theme](https://github.com/JulienMaille/dribbblish-dynamic-theme) 5. [Tetrax-10/Nord-Spotify](https://github.com/Tetrax-10/Nord-Spotify) -6. [Catpuccin/spicetify](https://github.com/catppuccin/spicetify) -7. Insert your theme here! - -:::note -This is not a completely exhaustive list, we recommend you check out our official themes repo or Marketplace for more -::: \ No newline at end of file +6. [Catppuccin/spicetify](https://github.com/catppuccin/spicetify) +7. [nimsandu/spicetify-bloom](https://github.com/nimsandu/spicetify-bloom) +8. Insert your theme here! diff --git a/docs/advanced-usage/custom-apps.md b/docs/advanced-usage/custom-apps.md deleted file mode 100644 index f032276..0000000 --- a/docs/advanced-usage/custom-apps.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -title: Custom Apps -description: 💥 Manually installing Custom Apps. ---- - -Custom Apps, similar to Extensions, are simply Javascript that will be injected into Spotify, that consists of a page that can be accessed from the sidebar. - -## Installing - -Custom Apps files can be stored in: - -- `CustomApps` folder in Home directory: - -| Platform | Path | -| ------------------- | -------------------------------------- | -| **Windows** | `%appdata%\spicetify\CustomApps\` | -| **Linux**/**MacOS** | `~/.config/spicetify/CustomApps` | - -- `CustomApps` folder in Spicetify executable directory. - -If there are 2 Custom Apps with the same name, the extension within the Home directory will be prioritized. - -After placing the Custom App file into correct folder, run following command to install it: - -```bash -spicetify config custom_apps -spicetify apply -``` - -**Note:** Using `config` command to add Custom Apps always append file name to existed extensions list. It does not replace the whole key's value. - -## Uninstalling - -If you want to remove a custom app from the current list of custom app you can always append a `-` after the file name: - -```bash -spicetify config custom_apps - -spicetify apply -``` - -## Custom Apps - -Inject custom apps to Spotify and access them in left sidebar. -Add your desired custom app folder names in config, separated them by `|` character. -Example: - -```ini -[AdditionalOptions] -... -custom_apps = reddit|yourownapp -``` - -App folders can be stored in: - -- `CustomApps` folder in Home directory: - -| Platform | Path | -| ------------------- | -------------------------------------- | -| **Windows** | `%appdata%\spicetify\CustomApps\` | -| **Linux**/**MacOS** | `~/.config/spicetify/CustomApps` | - -- `CustomApps` folder in Spicetify executable directory. - -If there are 2 apps having same name, app in Home directory is prioritized. - -Three apps have been included to demonstrate how to create and inject an app: - -- [Reddit](#reddit) -- [New Releases](#new-releases) -- [Lyrics Plus](#lyrics-plus) - -### Reddit - -Fetching posts from any Spotify link sharing subreddit. You can add, remove, arrange subreddits and customize post visual in config menu (in Profile menu, top right button with your user name). - -![Reddit](https://i.imgur.com/MC3tpNZ.png) - -To install, run following commands: - -``` -spicetify config custom_apps reddit -spicetify apply -``` - -### New Releases - -Aggregate all new releases from favorite artists, podcasts. Time range, release type, and other filters can be customized in config menu (in Profile menu, top right button with your user name). Date format is based on your locale code (BCP47). - -![New Releases](https://i.imgur.com/MP9dTjt.png) - -To install, run following commands: - -``` -spicetify config custom_apps new-releases -spicetify apply -``` - -### Lyrics Plus - -Get access to the current track's lyrics from various lyrics providers (Musixmatch, Netease, Genius). Learn more [here](https://github.com/spicetify/spicetify-cli/tree/master/CustomApps/lyrics-plus). - -Colors, lyrics providers can be customized in config menu (in Profile menu, top right button with your user name). - -![Lyrics Plus](https://i.imgur.com/WtD080A.png) - -To install, run following commands: - -``` -spicetify config custom_apps lyrics-plus -spicetify apply -``` diff --git a/docs/advanced-usage/extensions.md b/docs/advanced-usage/extensions.md deleted file mode 100644 index 9ab6930..0000000 --- a/docs/advanced-usage/extensions.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -title: Extensions -description: 🧩 Manually installing Extensions. ---- - -Extensions, in a nutshell, are JavaScript files that will be evaluated along with Spotify main JavaScript. - -## Installing - -Extension files can be stored in: - -- `Extensions` folder in Home directory: - -| Platform | Path | -| ------------------- | -------------------------------------- | -| **Windows** | `%appdata%\spicetify\Extensions\` | -| **Linux**/**MacOS** | `~/.config/spicetify/Extensions` | - -- `Extensions` folder in Spicetify executable directory. - -If there are 2 extensions with the same name, the extension within the Home directory will be prioritized. - -Some Spotify API endpoints are exposed and can be found in the global object `Spicetify`. Check out `global.d.ts` for API documentation. - -After placing the extension file into correct folder, run following command to install it: - -```bash -spicetify config extensions -spicetify apply -``` - -**Note:** Using `config` command to add extension always append file name to existed extensions list. It does not replace the whole key's value. - -## Uninstalling - -If you want to remove an extension from the current list of extensions you can always append a `-` after the file name: - -```bash -spicetify config extensions - -spicetify apply -``` - -## Manual Install - -You can always manually edit the config file, add your desired extension filenames in `extensions` key, separated them by `|` character. -Example: - -```ini -[AdditionalOptions] -... -extensions = autoSkipExplicit.js|queueAll.js|djMode.js|shuffle+.js|trashbin.js -``` - -Afterwards, you will need to run the following: - -``` -spicetify apply -``` - -## Extensions - -Below are list of default extensions that come with the distributed package: - -- [Auto Skip Videos](#auto-skip-videos) -- [Bookmark](#bookmark) -- [Christian Spotify](#christian-spotify) -- [Full App Display](#full-app-display) -- [Keyboard Shortcut](#keyboard-shortcut) -- [Loopy Loop](#loopy-loop) -- [Pop-up Lyrics](#pop-up-lyrics) -- [Shuffle+](#shuffle) -- [Trash Bin](#trash-bin) -- [Web Now Playing](#web-now-playing) - -### Auto Skip Videos - -**Filename:** `autoSkipVideo.js` - -Videos are unable to play in some regions because of Spotify's policy. Instead of jumping to next song in playlist, it just stops playing. And it's kinda annoying to open up the client to manually click next every times it happens. Use this extension to skip them automatically. - -### Bookmark - -**Filename:** `bookmark.js` - -Easily store and browse pages, play tracks or tracks in specific time. Useful for who wants to check out an artist, album later without following them or writing their name down. - -![Ext_bookmark](https://i.imgur.com/isgU4TS.png) - -### Christian Spotify - -**Filename:** `autoSkipExplicit.js` - -Auto skip explicit tracks. Toggle option is in Profile menu (top right button). - -![Ext_ChristianDemo](https://i.imgur.com/5reGrBb.png) - -### Full App Display - -**Filename:** `fullAppDisplay.js` - -Full App Display: Minimal album cover art display with beautiful blur effect background. Activating button locates in top bar. While in display mode, double click anywhere to exit. Right click anywhere to open setting menu. - -![Ext_FAD](https://i.imgur.com/S7CPQ2s.png) - -### Keyboard Shortcut - -**Filename:** `keyboardShortcut.js` - -Register some useful keybinds to support keyboard-driven navigation in Spotify client. Less time touching the mouse. - -- Ctrl Tab / Ctrl Shift Tab: Navigate items in left sidebar menu. -- Shift H/Shift L: Navigate history backward/forward. -- PageUp/PageDown: Force scroll up/down app page only (because mouse focus is sometimes in sidebar region and they scroll sidebar instead of app page). -- J/K: Scroll app page up/down. \*Tips hat to Vim users\* -- G/Shift G: Scroll to top or bottom -- M: Like/Unlike track -- /: Open search page -- Ctrl Q: Open Queue page. -- F: Open up keyboard-driven navigation. Hit correct key sequences to open up place you want to go: - -![KeyboardDemo](https://i.imgur.com/evkGv9q.png) - -### Loopy Loop - -**Filename:** `loopyLoop.js` - -Provide ability to mark start and end points on progress bar and automatically loop over that track portion. - -![LoopyLoop](https://i.imgur.com/YEkbjLC.png) - -### Pop-up Lyrics - -**Filename:** `popupLyrics.js` - -Have easy access to a pop-up window with the current song's lyrics. Click at microphone icon on top bar to open lyrics windows. Right click at the same icon to open config menu to customize looks and lyrics providers priorities. - -![Pop-up Lyrics](https://i.imgur.com/Nx9Lx7D.png) - -### Shuffle+ - -**Filename:** `shuffle+.js` -Shuffles using Fisher–Yates algorithm with zero bias. After installing extensions, right click album/playlist/artist item, there will be an option "Play with Shuffle+". You can also multiple select tracks and choose to "Play with Shuffle+". - -![Shuffle](https://i.imgur.com/gxbnqSN.png) - -### Trash Bin - -**Filename:** `trashbin.js` -Throw songs/artists to trash bin and never hear them again (automatically skip). This extension will append a Throw to Trashbin option in tracks and artists link right click menu. - -![Ext_Trash](https://i.imgur.com/ZFTy5Rm.png) - -### Web Now Playing - -**Filename:** `webnowplaying.js` -For Rainmeter users, establish connection with WebNowPlaying plugin to send track metadata and control players. - -If you just want WebNowPlaying without changing UI color, CSS, run this: - -```powershell -spicetify config inject_css 0 replace_colors 0 -spicetify config extensions webnowplaying.js -spicetify apply -``` - -## Legacy Extensions - -If you are running Spicetify 1.2.1 or below, and a supported Spotify version, you may also have access to the extensions listed below. - -- [DJ Mode](#dj-mode) -- [New Release](#new-release) -- [Queue All](#queue-all) - -### DJ Mode - -**Filename:** `djMode.js` - -Easily setting up the client for your friends or audiences to choose, add song to queue but prevent them to control player. Plays button in album track list/playlist are re-purposed to add track to queue, instead of play track directly. Hide Controls option also allow you to hide all control button in player bar, Play/More/Follow buttons in cards. - -![Ext_DJDemo](https://i.imgur.com/pOFEqtM.png) - -### New Release - -**Filename:** `newRelease.js` - -Aggregate all new releases from favorite artists, podcasts. Setting menu could be opened by right clicking at Bell icon. - -![Ext_newrelease](https://user-images.githubusercontent.com/26436809/86569793-50dd8480-bfb2-11ea-8d82-be238d719660.png) - -### Queue All - -**Filename:** `queueAll.js` - -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. - -![QueueAllDemo](https://i.imgur.com/D9ytt7K.png) diff --git a/docs/advanced-usage/themes.md b/docs/advanced-usage/themes.md deleted file mode 100644 index 15c780d..0000000 --- a/docs/advanced-usage/themes.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Themes -description: ✨ Themes for Spicetify. ---- - -One of the most popular features in Spicetify is theming. -You can customize your Spotify to your **heart's** desire! -**However**, this is a very cumbersome task. - -For this reason, the theming heroes of the Spicetify community have created a huge library of themes which can be found in the following repositories: - -1. [spicetify/spicetify-themes](https://github.com/spicetify/spicetify-themes) - The official Spicetify themes repository. Feel free to contribute with more themes! -2. [NYRI4/Comfy-spicetify](https://github.com/NYRI4/Comfy-spicetify) -3. [williamckha/spicetify-fluent](https://github.com/williamckha/spicetify-fluent) -4. [JulienMaille/dribbblish-dynamic-theme](https://github.com/JulienMaille/dribbblish-dynamic-theme) -5. [Tetrax-10/Nord-Spotify](https://github.com/Tetrax-10/Nord-Spotify) -6. [Catppuccin/spicetify](https://github.com/catppuccin/spicetify) -7. [nimsandu/spicetify-bloom](https://github.com/nimsandu/spicetify-bloom) -8. Insert your theme here! From d1b55a6d978527f479784c2b1052106828b4cdde Mon Sep 17 00:00:00 2001 From: OhItsTom <22730962+ohitstom@users.noreply.github.com> Date: Mon, 25 Sep 2023 11:55:23 +0100 Subject: [PATCH 3/3] links --- docs/development/custom-apps.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/development/custom-apps.md b/docs/development/custom-apps.md index 219cc69..7cb5011 100644 --- a/docs/development/custom-apps.md +++ b/docs/development/custom-apps.md @@ -5,7 +5,7 @@ description: 🔧 Creating Custom Apps. ## How to start -- Make a new folder for your custom app in your [CustomApps folder](../advanced-usage/custom-apps). You'll install it like any other custom app. +- Make a new folder for your custom app in your [CustomApps folder](../addons/custom-apps). You'll install it like any other custom app. - Create an `index.js` and a `manifest.json` inside that folder. - The `index.js` file is the main file for the custom app. - The manifest includes some important information to make the custom app work.