Skip to content
This repository was archived by the owner on Jan 29, 2022. It is now read-only.

FlafyDev/spicetify-custom-app

Repository files navigation

Spicetify Custom App Template

STILL NEED TO BE TESTED | NOT READY YET

A template for making Spicetify Custom Apps.

Features

  • Typescript/Javascript support
  • React syntax
  • Node modules
  • CSS/SCSS global and modules (PostCSS)
  • Improved Custom App's structure
  • Under 1 second compile time with esbuild
  • Save & reload (Save and the changes will appear in Spotify)

Getting started

Structure

  • All your code should be inside the src folder.
  • The default component exported from src/app.tsx will be displayed as your Custom App.
  • Each file in the src/extensions folder is an extension of its own.
  • the Custom App's folder name is the name in package.json
  • the Custom App's name in Spotify is the name in manifest.json

Running

  1. Generate a repo from this repo
  2. Clone your new repo to your computer
  3. Change the name in package.json:
  4. Open a terminal and enter this:
yarn
yarn run addApp
  1. To build and watch the Custom App enter this in separate terminals:
yarn run build --watch
spicetify apply
spicetify watch -la

The Template's Example

The template includes:

  • 2 SCSS files (1 module and 1 global).
  • A counter for the Custom App.
  • An extension that says "Welcome!" whenever Spotify starts.

Tested

  • Windows
  • MacOS
  • Linux

About

A template for making a Spicetify Custom App with Typescript, React syntax, and NPM packages.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published