Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 3 KB

BUILD.md

File metadata and controls

39 lines (27 loc) · 3 KB
Raw

Building Soggfy

For end users, the easiest way to build Soggfy is by forking (or reuploading) the repository into GitHub and manually triggering the Release workflow in GitHub Actions. Alternatively, the steps below describe how to build locally.

Requirements

Building

To build the project, open a "Native Tools CMD for VS", cd into the repository directory and run the following commands:

set PATH=C:\Program Files\7-Zip;%PATH%
fetch_external_deps.bat

msbuild /p:Configuration=Release

cd Sprinkles
npm run build
copy dist\bundle.js ..\build\Release\Soggfy.js /y

Note that the Core DLL depends on some CEF headers, they are downloaded by the fetch_external_deps.bat script, which assumes that curl and 7z are available. You can alternatively manually download the .tar file (link in the .bat) and extract it into external/cef_bin/ folder.

Development Guide

Soggfy is split into three components:

  • Injector: Responsible for launching and/or loading the Core DLL into Spotify.
  • Core DLL (SpotifyOggDumper): Audio/player hooks, state and file management.
  • Sprinkles: UI integration and track metadata provider. This is a single JS bundle injected into the main CEF window by the Core DLL.

Client reverse engineering is done with Ghidra, x64dbg, and CheatEngine (though it's worth mentioning Frida). Most functions can be found via strings, but the audio decode dispatch function is tricky since it's a virtual method. You need to place a breakpoint on e.g. the ogg demuxer function and find the (virtual) dispatcher on the call stack.

Debugging the Core DLL is easily done by attaching the VS debugger into the main Spotify process after injecting the DLL (there are no anti-debugging tricks). Change cycles are slow, you'll need to rebuild and reinject the DLL, but in most cases, you won't need to restart Spotify - just "uninject" the DLL by typing u in the console, then build and reinject.

The easiest way to develop Sprinkles is via Spicetify, after adding it as an extension.
The builtin Spotify DevTools was disabled in v1.1.80. Remote debugging via Spotify.exe --remote-debugging-port=9222 and chrome://inspect seems to be the easiest and most reliable way to do it now.

After adding Soggfy as a Spicetify extension, the dev_build.bat will build and copy it to the extension folder, but Spotify must be reloaded by running location.reload() on the DevTools console (Ctrl+R no longer works).
The dev_build.bat script will build and restart Spotify with the compiled bundle, though it's worth nothing that some changes can be made in the devtools console or sources tab.