Skip to content

Options

alwaysEnableDevTools

Whether to enable chromium dev tools.

Type
plaintext
boolean
Default
nix
false
Example
nix
true
Declaration

colorScheme

Spicetify color scheme to use, given a specific theme. If using customColorScheme, leave this as default "custom".

Type
plaintext
string
Default
nix
""
Declaration

createdPackages

A list of all generated packages containing the spiced spotify and extra packages from the current theme.

Type
plaintext
list of package
Default
nix
[ spicedSpotify ] ++ theme.extraPkgs
Declaration

customColorScheme

Custom scheme used to generate a corresponding color.ini. See https://spicetify.app/docs/development/themes.

Type
plaintext
attribute set of string
Default
nix
{ }
Declaration

enable

Whether to enable Spicetify a modified Spotify..

Type
plaintext
boolean
Default
nix
false
Example
nix
true
Declaration

enabledCustomApps

Custom apps to add to the spice. See https://spicetify.app/docs/development/custom-apps.

Type
plaintext
list of (attribute set of anything)
Default
nix
[ ]
Declaration

enabledCustomApps.*.name

Name of the app. No spaces or special characters

Type
plaintext
string
Default
nix
""
Example
nix
"localFiles"
Declaration

enabledCustomApps.*.src

Path to the folder containing the app code.

Type
plaintext
path in the Nix store
Example
nix
pkgs.fetchFromGitHub {
  owner = "hroland";
  repo = "spicetify-show-local-files";
  rev = "1bfd2fc80385b21ed6dd207b00a371065e53042e";
  hash = "sha256-neKR2WaZ1K10dZZ0nAKJJEHNS56o8vCpYpi+ZJYJ/gU=";
}
Declaration

enabledExtensions

Type
plaintext
list of (path in the Nix store or (attribute set of anything))
Default
nix
[ ]
Example
nix
''
  [
    {
      src = (pkgs.fetchFromGitHub {
        owner = "Taeko-ar";
        repo = "spicetify-last-fm";
        rev = "d2f1d3c1e286d789ddfa002f162405782d822c55";
        hash = "sha256-/C4Y3zuSAEwhMXCRG2/4b5oWfGz/ij6wu0B+CpuJKXs=";
      }) + /src;
  
      name = "lastfm.js";
    }
  ]
''
Declaration

enabledSnippets

Type
plaintext
list of string
Default
nix
[ ]
Declaration

experimentalFeatures

Whether to enable experimental features.

Type
plaintext
null or boolean
Default
nix
null
Example
nix
true
Declaration

extraCommands

Extra commands to be run during the setup of spicetify.

Type
plaintext
strings concatenated with "\n"
Default
nix
""
Declaration

spicedSpotify

The final spotify package after spicing.

Type
plaintext
package
Declaration

spicetifyPackage

The spicetify-cli package to use.

Type
plaintext
package
Default
nix
pkgs.spicetify-cli
Declaration

spotifyLaunchFlags

Launch flags to pass to spotify.

Type
plaintext
string
Default
nix
""
Declaration

spotifyPackage

The spotify package to use.

Type
plaintext
package
Default
nix
pkgs.spotify
Declaration

spotifywmPackage

The spotifywm package to use. Note: this is only available on linux

Type
plaintext
package
Default
nix
pkgs.spotifywm
Declaration

theme

Type
plaintext
attribute set of anything
Default
nix
{
  name = "Default";
  override = <function, args: {lib, pkgs, sources}>;
  overrideDerivation = <function>;
  src = "/nix/store/z2911yczr12snqkafzhc9ccsmj1glhki-source/Default";
}
Declaration

theme.additionalCss

Type
plaintext
strings concatenated with "\n"
Default
nix
""
Declaration

theme.extraCommands

A bash script to run from the spicetify config directory if this theme is installed.

Type
plaintext
strings concatenated with "\n"
Default
nix
""
Declaration

theme.extraPkgs

Extra required packges for the theme to function (usually a font)

Type
plaintext
list of package
Default
nix
[ ]
Declaration

theme.homeConfig

Type
plaintext
boolean
Default
nix
true
Declaration

theme.injectCss

Type
plaintext
boolean
Default
nix
true
Declaration

theme.injectThemeJs

Type
plaintext
boolean
Default
nix
true
Declaration

theme.name

The name of the theme as it will be copied into the spicetify themes directory.

Type
plaintext
string
Example
nix
"Dribbblish"
Declaration

theme.overwriteAssets

Type
plaintext
boolean
Default
nix
false
Declaration

theme.patches

INI entries to add in the [Patch] section of config-xpui.ini

Type
plaintext
attribute set of string
Default
nix
{ }
Example
nix
''
  {
    "xpui.js_find_8008" = ",(\\w+=)32";
    "xpui.js_repl_8008" = ",$\{1}56";
  };
''
Declaration

theme.replaceColors

Type
plaintext
boolean
Default
nix
true
Declaration

theme.requiredExtensions

Type
plaintext
list of (path in the Nix store or (attribute set of anything))
Default
nix
[ ]
Declaration

theme.src

Path to folder containing the theme.

Type
plaintext
path in the Nix store
Example
nix
''
  fetchFromGitHub {
    owner = "spicetify";
    repo = "spicetify-themes";
    rev = "02badb180c902f986a4ea4e4033e69fe8eec6a55";
    hash = "sha256-KD9VfHtlN0BIHC4inlooxw5XC4xlHNC5evASRqP7pUA=";
  }
  Or a relative path 
  
  ./myTheme
''
Declaration

wayland

true sets chrome flags to use wayland native.

false sets chrome flags to use Xwayland.

null relies on the $NIXOS_OZONE_WL environmental variable

Note: this is only available on linux

Type
plaintext
null or boolean
Default
nix
null
Example
nix
true
Declaration

windowManagerPatch

Whether to enable preloading the spotifywm patch.

Note: this is only available on linux .

Type
plaintext
boolean
Default
nix
false
Example
nix
true
Declaration