Usage

Add this flake as an input

spicetify-nix.url = "github:Gerg-L/spicetify-nix";

IMPORTANT

For 24.11 use "github:Gerg-L/spicetify-nix/24.11" instead!

or import the base of this repo with a fetchTarball passing pkgs

like import (builtins.fetchTarball { ... } ) {inherit pkgs;}

Then use one of the modules or spicetify-nix.lib.mkSpicetify

Wrapper function

The wrapper takes two arguments pkgs and then an attribute set of config options

let
  spicetify = spicetify-nix.lib.mkSpicetify pkgs {
    #config options
  };
in {
...

then add it to environment.systemPackages or users.users.<name>.packages or anywhere you can add a package

Modules

Import spicetify-nix.<module>.spicetify into your config

Where <module> is:

nixosModules for NixOS,

darwinModules for nix-darwin

homeManagerModulesfor home-manager

imports = [
  # Example for NixOS
  spicetify-nix.nixosModules.spicetify 
];

and use the programs.spicetify options

programs.spicetify = {
  enable = true;
  #config options

and it'll install the wrapped spotify to environment.systemPackages or home.packages

Alternatively set programs.spicetify.enable = false; and add config.programs.spicetify.spicedSpotify where you want manually

IMPORTANT

Don't install pkgs.spotify anywhere The module installs spotify for you!

Example Configuration

   let
     # For Flakeless:
     # spicePkgs = spicetify-nix.packages;

     # With flakes:
     spicePkgs = inputs.spicetify-nix.legacyPackages.${pkgs.stdenv.system};
   in
   programs.spicetify = {
     enable = true;
     enabledExtensions = with spicePkgs.extensions; [
       adblockify
       hidePodcasts
       shuffle # shuffle+ (special characters are sanitized out of extension names)
     ];
     theme = spicePkgs.themes.catppuccin;
     colorScheme = "mocha";
   }