diff --git a/README.md b/README.md index 5b233cb..4b5e35e 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,25 @@ # Dribbblish Dynamic ### Preview -![preview](showcase-images/preview.gif) + +img ## Features ### Resizable sidebar -img +img ### Customizable sidebar Rearrange icons positions, stick icons to header or hide unnecessary to save space. Turn on "Sidebar config" mode in Profile menu and hover on icon to show control buttons. After you finish customizing, turn off Config mode in Profile menu to save. -img +img ### Playlist Folder image Right click at folder and choose images for your playlist folder. Every image formats supported by Chrome can be used, but do keep image size small and in compressed format. -img +img ### Left/Right expanded cover In profile menu, toggle option "Right expanded cover" to change expaned current track cover image to left or right side, whereever you prefer. @@ -26,20 +27,30 @@ In profile menu, toggle option "Right expanded cover" to change expaned current ## Install / Update Make sure you are using spicetify >= v2.6.0 and Spotify >= v1.1.67. -Run these commands: - -### Windows -In **Powershell**: +### Windows (PowerShell) ```powershell Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/JulienMaille/dribbblish-dynamic-theme/master/install.ps1" | Invoke-Expression ``` -### Linux and MacOS: -In **Bash**: +### Linux/MacOS (Bash) ```bash curl -fsSL https://raw.githubusercontent.com/JulienMaille/dribbblish-dynamic-theme/master/install.sh | sh ``` +### Manual Install +1. Download the latest [DribbblishDynamic_vX.X.X.zip](https://github.com/JulienMaille/dribbblish-dynamic-theme/releases/latest) +2. Extract the files to your [Spicetify/Themes folder](https://github.com/khanhas/spicetify-cli/wiki/Customization#themes) +3. Copy `dribbblish-dynamic.js` to your [Spicetify/Extensions folder](https://github.com/khanhas/spicetify-cli/wiki/Extensions#installing) +4. Run: + ``` + spicetify config extensions dribbblish-dynamic.js + spicetify config current_theme DribbblishDynamic + spicetify config color_scheme base + spicetify config inject_css 1 replace_colors 1 overwrite_assets 1 + spicetify apply + ``` + +## IMPORTANT! From Spotify > v1.1.62, in sidebar, they use an adaptive render mechanic to actively show and hide items on scroll. It helps reducing number of items to render, hence there is significant performance boost if you have a large playlists collection. But the drawbacks is that item height is hard-coded, it messes up user interaction when we explicity change, in CSS, playlist item height bigger than original value. So you need to add these 2 lines in Patch section in config file: ```ini [Patch] @@ -50,15 +61,12 @@ xpui.js_repl_8008 = ,${1}56, ## Hide Window Controls Windows user, please edit your Spotify shortcut and add flag `--transparent-window-controls` after the Spotify.exe: To edit an taskbar shortcut, right click it, then right click Spotify in the list again. -![instruction1](showcase-images/windows-shortcut-instruction.png) + +img In addition to `--transparent-window-controls` you can set `Windows Top Bars` to `Solid` or `Transparent` to look like this: -![top-bars](showcase-images/top-bars.png) -Alternatively, you can use [`SpotifyNoControl.exe`](https://github.com/JulienMaille/SpotifyNoControl/files/6793911/SpotifyNoControl.zip), included in this theme package, to completely remove all windows controls and title menu (three dots at top left corner). Title menu still can be accessed via the Alt key. Closing and minimizing can be done via the right click menu at top window region. -`SpotifyNoControl.exe` could be used as Spotify launcher, it opens Spotify and hides controls right after. You can drag and drop it to your taskbar but make sure you unpin the original Spotify icon first. Alternatively you can make a shortcut for it and add to desktop or start menu. - -![nocontrol](https://i.imgur.com/qdZyv1t.png) +img ## Auto-uninstall ### Windows @@ -67,13 +75,9 @@ Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/JulienMail ``` ## Manual uninstall -Remove the dribbblish script with the following commands - -``` -spicetify config extensions dribbblish.js- -spicetify config extensions dribbblish-dynamic.js- -``` -And remove Patch lines you added in config file earlier. Finally, run: -``` -spicetify apply -``` +1. Remove Patch lines you added in config file earlier. +2. Run: + ``` + spicetify config extensions dribbblish-dynamic.js- + spicetify apply + ``` \ No newline at end of file diff --git a/showcase-images/customize-sidebar.png b/showcase-images/customize-sidebar.png new file mode 100644 index 0000000..aab9789 Binary files /dev/null and b/showcase-images/customize-sidebar.png differ diff --git a/showcase-images/playlist-folders.gif b/showcase-images/playlist-folders.gif new file mode 100644 index 0000000..5c16db4 Binary files /dev/null and b/showcase-images/playlist-folders.gif differ diff --git a/showcase-images/resize-sidebar.png b/showcase-images/resize-sidebar.png new file mode 100644 index 0000000..c47f557 Binary files /dev/null and b/showcase-images/resize-sidebar.png differ diff --git a/src/js/main.js b/src/js/main.js index 60cc630..f947918 100644 --- a/src/js/main.js +++ b/src/js/main.js @@ -662,7 +662,7 @@ hookCoverChange(false); upd.innerText = "Dev version!"; } else if (data.tag_name > process.env.DRIBBBLISH_VERSION) { upd.innerText = `Theme UPD v${data.tag_name} avail.`; - new Spicetify.Menu.Item("Update Dribbblish", false, () => window.open("https://github.com/JulienMaille/dribbblish-dynamic-theme/blob/main/README.md#install--update", "_blank")).register(); + new Spicetify.Menu.Item("Update Dribbblish", false, () => window.open("https://github.com/JulienMaille/dribbblish-dynamic-theme/releases/latest", "_blank")).register(); } document.querySelector(".main-userWidget-box").append(upd); document.querySelector(".main-userWidget-box").classList.add("update-avail");