Files
Aurora-SpotiRip/docs/building-windows.md
T
R3ap3r 3178b8f4f7 Aurora SpotiRip desktop and web app
- Spotify playlist, library, album and artist browsing with in-app playback
- Song, playlist and album downloads via spotdl with YouTube and Bandcamp fallbacks
- Electron desktop app (castLabs Widevine) with a permanent sidebar layout
- Linux and Windows packaging scripts
2026-09-25 23:20:57 -05:00

69 lines
2.1 KiB
Markdown

# Building the Windows installer
## 1. Install the tools (once)
Open **PowerShell** and run:
```powershell
winget install Git.Git OpenJS.NodeJS.LTS Python.Python.3.12
```
Close PowerShell, open a new one, then:
```powershell
npm install -g pnpm
```
## 2. Get the code
```powershell
cd $HOME
git clone <your repository URL> aurora-spotirip
cd aurora-spotirip
```
To update an existing copy later: `git pull`.
## 3. Create the castLabs signing account (once)
Spotify only plays inside apps signed by castLabs on Windows. The account is free.
```powershell
py -3 -m venv venv
venv\Scripts\python.exe -m pip install castlabs-evs
venv\Scripts\python.exe -m castlabs_evs.account signup
```
Follow the prompts and confirm the e-mail they send. On later builds the script signs you in again automatically (`castlabs_evs.account reauth`).
## 4. Build
```powershell
pnpm dist:win
```
The first build takes a while (it downloads Python packages, ffmpeg and castLabs Electron). The installer ends up in `release\Aurora SpotiRip Setup <version>.exe`.
## 5. Install and set up
1. Run the installer. Windows shows **"Windows protected your PC"** because the installer is not code-signed: click **More info → Run anyway**.
2. Create `%APPDATA%\Aurora SpotiRip\env.json` with the Spotify keys:
```json
{
"SPOTIFY_CLIENT_ID": "...",
"SPOTIFY_CLIENT_SECRET": "...",
"AUDD_API_TOKEN": ""
}
```
3. In the Spotify Developer Dashboard, add the Windows user's Spotify account under **User Management**. In-app playback needs Spotify Premium.
4. Start Aurora SpotiRip and click **Connect Spotify**.
The redirect URI `http://127.0.0.1:43117/spotify/callback` is the same on every computer, so nothing else changes in the dashboard.
## Troubleshooting
- **Songs play on another device instead of the PC:** the castLabs signing step did not run; rebuild after `venv\Scripts\python.exe -m castlabs_evs.account reauth`.
- **Antivirus removes `spotify_downloader.exe`:** some antivirus programs flag PyInstaller programs by mistake. Restore it and add an exception for the Aurora SpotiRip install folder.