kyrie25 / Spicetify-Cache-Cleaner

Automatically clear Spotify client's cache using Spicetify.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Spicetify Cache Cleaner

Spicetify extension to automatically clear Spotify cache. Executes on startup.

Only works on Spotify 1.1.92, Spicetify 2.12.0 and above.

Github Stars badge

Install

Copy cacheCleaner.js into your Spicetify extensions directory:

Platform Path
Linux ~/.config/spicetify/Extensions or $XDG_CONFIG_HOME/.config/spicetify/Extensions/
MacOS ~/.config/spicetify/Extensions or $SPICETIFY_CONFIG/Extensions
Windows %appdata%/spicetify/Extensions/

After putting the extension file into the correct folder, run the following command to install the extension:

spicetify config extensions cacheCleaner.js
spicetify apply

Note: Using the config command to add the extension will always append the file name to the existing extensions list. It does not replace the whole key's value.

Or you can manually edit your config-xpui.ini file. Add your desired extension filenames in the extensions key, separated them by the | character. Example:

[AdditionalOptions]
...
extensions = autoSkipExplicit.js|shuffle+.js|trashbin.js|cacheCleaner.js

Then run:

spicetify apply

Usage

The extension will automatically clear the Spotify cache after a period of time or if a threshold has been surpassed. Configuration format

Key Values
enabled Boolean value. Define whether the extension is allowed to run or not.
notify Boolean value. Define whether notification is shown when cache is cleared automatically.
frequency Option value. Can be either never, daily, weekly, or monthly.
threshold Input value. Defined in MB. Cache is automatically cleared when this value is met. 0 to disable this function.
time Snowflake value. Is automatically assigned based on frequency and execution time.

By default, it will have these values:

{
    enabled: true,
    notify: true,
    frequency: "weekly",
    threshold: "0",
    time: 0 // Precisely a week after the extension is first installed.
}

Screenshot

About

Automatically clear Spotify client's cache using Spicetify.

License:GNU General Public License v3.0


Languages

Language:JavaScript 100.0%