Add direct Spotify playback support

Author: AnastaZIuk

Dockerfile

@@ -9,13 +9,37 @@ RUN mvn -q -DskipTests package && \
     mkdir -p /out && \
     cp target/*-All.jar /out/JMusicBot.jar
 
-FROM eclipse-temurin:17-jre-jammy
+FROM golang:1.25-bookworm AS golibrespot-build
+WORKDIR /src
+
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    git \
+    pkg-config \
+    libogg-dev \
+    libvorbis-dev \
+    flac \
+    libflac-dev \
+    libasound2-dev && \
+    rm -rf /var/lib/apt/lists/*
+
+RUN git clone --depth 1 --branch v0.7.1 https://github.com/devgianlu/go-librespot.git go-librespot
+WORKDIR /src/go-librespot
+RUN go build -o /out/go-librespot ./cmd/daemon
+
+FROM eclipse-temurin:17-jre
 WORKDIR /app
 
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    ffmpeg \
+    ca-certificates \
+    libasound2t64 && \
+    rm -rf /var/lib/apt/lists/*
+
 COPY --from=build /out/JMusicBot.jar /app/JMusicBot.jar
+COPY --from=golibrespot-build /out/go-librespot /usr/local/bin/go-librespot
 COPY docker/docker-entrypoint.sh /usr/local/bin/docker-entrypoint.sh
 
-RUN chmod +x /usr/local/bin/docker-entrypoint.sh
+RUN chmod +x /usr/local/bin/docker-entrypoint.sh /usr/local/bin/go-librespot
 
 ENV JMUSICBOT_HOME=/data
 VOLUME ["/data"]

README.md

@@ -17,9 +17,13 @@ This repository is a maintained fork focused on keeping YouTube playback working
 
 Important differences from the original project:
 1. This fork supports YouTube OAuth playback fallback.
-2. If you want reliable playback for blocked or age-restricted videos, you should use a dedicated burner Google account.
-3. Do not use your main Google account.
-4. If the burner account cannot play a video in the normal YouTube browser UI, the bot will usually not be able to play it either.
+2. This fork supports direct Spotify playback through a local `go-librespot` backend.
+3. Spotify support is per-bot and can be enabled or disabled independently at startup.
+4. If two bots use the same Spotify account, they will compete for the same Spotify Connect session.
+5. For parallel Spotify playback on two bots, use two separate Spotify accounts.
+6. If you want reliable playback for blocked or age-restricted videos, you should use a dedicated burner Google account.
+7. Do not use your main Google account.
+8. If the burner account cannot play a video in the normal YouTube browser UI, the bot will usually not be able to play it either.
 
 ## YouTube OAuth Setup For This Fork
 
@@ -143,6 +147,175 @@ Container-specific behavior:
 2. Relative state paths are resolved from `JMUSICBOT_HOME`, which defaults to `/data` in the container.
 3. Each bot keeps its own `config.txt`, `serversettings.json`, and `Playlists/` under its own instance directory.
 
+## Spotify Direct Playback
+
+This fork can play Spotify tracks, albums, and playlists directly without YouTube conversion.
+
+### What this does
+
+1. Spotify URLs are resolved as Spotify content, not mapped to YouTube.
+2. Playback is done through a local `go-librespot` backend plus an `ffmpeg` bridge to Discord voice.
+3. The feature is enabled per bot instance, not globally for the whole host.
+
+### What this does not do
+
+1. It does not use the official Spotify Web API for full audio playback.
+2. It does not allow two bots on the same Spotify account to play different things at the same time.
+3. It does not bypass normal Spotify account limits or Spotify Connect session rules.
+
+### Requirements
+
+1. Spotify playback is optional and disabled by default.
+2. It requires the Docker image or runtime environment to start the bundled `go-librespot` sidecar.
+3. It requires a Spotify Premium account for playback.
+4. The bot instance must have persistent writable storage under its data directory.
+
+### Integration overview
+
+For one bot instance with Spotify enabled, the runtime does the following:
+1. starts the Java bot process
+2. starts a local `go-librespot` daemon
+3. creates a local PCM pipe under the bot data directory
+4. authenticates the selected Spotify account
+5. uses that backend for Spotify URLs while keeping normal lavaplayer behavior for non-Spotify URLs
+
+### Per-bot enable or disable
+
+Spotify is controlled per bot instance through environment variables.
+
+Example:
+
+```env
+SPOTIFY_ENABLED=true
+SPOTIFY_DEVICE_NAME=devshmusic-test1-spotify
+SPOTIFY_CALLBACK_PORT=0
+```
+
+If `SPOTIFY_ENABLED=false` or unset:
+1. the Spotify sidecar is not started
+2. direct Spotify playback is disabled for that bot
+3. the bot continues to work as a normal YouTube/lavaplayer bot
+
+This means you can run:
+1. one bot with Spotify enabled
+2. another bot with Spotify disabled
+3. both at the same time on the same host
+
+### Minimal bot env for Spotify
+
+The smallest useful setup in `bot.env` is:
+
+```env
+BOT_TOKEN=replace_with_discord_bot_token
+BOT_OWNER=replace_with_discord_owner_id
+SPOTIFY_ENABLED=true
+SPOTIFY_DEVICE_NAME=devshmusic-spotify-1
+SPOTIFY_CALLBACK_PORT=0
+```
+
+Notes:
+1. `SPOTIFY_DEVICE_NAME` should be unique per bot.
+2. `SPOTIFY_CALLBACK_PORT=0` lets the backend choose a free local callback port automatically.
+3. If Spotify is disabled for a bot, you can omit all Spotify variables entirely.
+
+### First-time Spotify setup from scratch
+
+When `SPOTIFY_ENABLED=true` and no prior Spotify state exists:
+1. pick the bot instance that should get Spotify support
+2. set `SPOTIFY_ENABLED=true` in that bot's `bot.env`
+3. make sure the instance has its own persistent data directory
+4. start or restart that bot container
+5. watch the logs for the Spotify authorization URL
+6. open the URL in a browser
+7. log into the Spotify Premium account intended for that bot
+8. finish the callback flow
+9. let the bot finish initialization
+10. test a Spotify track, album, or playlist URL on Discord
+
+After that, restarts should reuse the stored Spotify session state.
+
+### Where Spotify state is stored
+
+For a bot instance running with `JMUSICBOT_HOME=/data`, the Spotify runtime stores:
+1. Spotify auth and daemon state under `/data/spotify`
+2. the PCM pipe under `/data/spotify.pipe`
+
+This means:
+1. deleting the instance data directory will force a fresh Spotify login
+2. moving the instance to another host requires moving the bot's data volume as well
+
+### Recommended deployment patterns
+
+#### One bot with Spotify, one bot without Spotify
+
+This is the cleanest production split.
+
+Example:
+1. `bot-a`: `SPOTIFY_ENABLED=true`
+2. `bot-b`: `SPOTIFY_ENABLED=false`
+
+Result:
+1. `bot-a` can handle Spotify URLs and normal YouTube URLs
+2. `bot-b` stays a normal non-Spotify bot
+3. only one container pays the operational cost of the Spotify sidecar
+
+#### Two bots with Spotify enabled
+
+This is valid only if you understand the account model.
+
+1. If both bots use the same Spotify account, they will fight over one Spotify Connect session.
+2. If you want both bots to play Spotify independently, use two separate Spotify accounts.
+3. Give each bot a unique `SPOTIFY_DEVICE_NAME`.
+
+### Multiple bots and account isolation
+
+1. Two bots can both have Spotify enabled.
+2. If both bots use the same Spotify account, they will fight over one Spotify Connect session.
+3. If you need two bots to play different Spotify content at the same time, use two separate Spotify accounts.
+
+### Production checklist
+
+Before enabling Spotify on a production bot:
+1. verify the bot can still play a normal YouTube URL
+2. verify the bot can play a Spotify track URL
+3. verify the bot can play a Spotify playlist URL
+4. verify `skip`, `pause`, `resume`, `seek`, `volume`, and `queue`
+5. confirm the instance data directory is persistent
+6. confirm no second bot is using the same Spotify account unless that is intentional
+
+### Troubleshooting
+
+#### The bot ignores Spotify URLs
+
+Check:
+1. `SPOTIFY_ENABLED=true` is actually present in that bot's runtime env
+2. the bot instance was restarted after editing env
+3. the Spotify sidecar started successfully in logs
+
+#### The bot asks for Spotify login every restart
+
+Check:
+1. the bot is using persistent storage
+2. `/data/spotify` is not being discarded between restarts
+3. the container is not mounting a fresh empty instance directory
+
+#### Two Spotify bots keep interrupting each other
+
+Cause:
+1. both bots are logged into the same Spotify account
+
+Fix:
+1. use one Spotify-enabled bot and one non-Spotify bot
+2. or use two separate Spotify accounts
+
+#### Spotify works but YouTube stops working
+
+This should not happen by design. The fork keeps Spotify and lavaplayer on separate playback paths.
+If this happens:
+1. test a plain YouTube URL on the same bot
+2. check bot logs for the failure path
+3. verify the bot is not stuck in an active Spotify session that should first be stopped
+
 ## GHCR Container Publishing
 
 GitHub Actions now builds the Docker image from this repository and publishes it to GHCR.

docker/docker-entrypoint.sh

@@ -21,6 +21,56 @@ if [ ! -f "$SETTINGS_FILE" ]; then
     fi
 fi
 
+if [ "${SPOTIFY_ENABLED:-false}" = "true" ]; then
+    SPOTIFY_CONFIG_DIR="${SPOTIFY_CONFIG_DIR:-$DATA_DIR/spotify}"
+    SPOTIFY_PIPE_PATH="${SPOTIFY_PIPE_PATH:-$DATA_DIR/spotify.pipe}"
+    SPOTIFY_API_PORT="${SPOTIFY_API_PORT:-3678}"
+    SPOTIFY_API_URL="${SPOTIFY_API_URL:-http://127.0.0.1:$SPOTIFY_API_PORT}"
+    SPOTIFY_FFMPEG_PATH="${SPOTIFY_FFMPEG_PATH:-ffmpeg}"
+    SPOTIFY_CALLBACK_PORT="${SPOTIFY_CALLBACK_PORT:-0}"
+    SPOTIFY_DEVICE_NAME="${SPOTIFY_DEVICE_NAME:-JMusicBot Spotify}"
+    SPOTIFY_VOLUME_STEPS="${SPOTIFY_VOLUME_STEPS:-150}"
+    SPOTIFY_INITIAL_VOLUME="${SPOTIFY_INITIAL_VOLUME:-100}"
+    SPOTIFY_BITRATE="${SPOTIFY_BITRATE:-320}"
+    SPOTIFY_CREDENTIALS_TYPE="${SPOTIFY_CREDENTIALS_TYPE:-interactive}"
+    SPOTIFY_STATE_CONFIG="$SPOTIFY_CONFIG_DIR/config.yml"
+
+    mkdir -p "$SPOTIFY_CONFIG_DIR"
+    rm -f "$SPOTIFY_PIPE_PATH"
+    mkfifo "$SPOTIFY_PIPE_PATH"
+
+    if [ ! -f "$SPOTIFY_STATE_CONFIG" ]; then
+        cat > "$SPOTIFY_STATE_CONFIG" <<EOF
+log_level: info
+device_name: "$SPOTIFY_DEVICE_NAME"
+device_type: speaker
+audio_backend: pipe
+audio_output_pipe: "$SPOTIFY_PIPE_PATH"
+audio_output_pipe_format: s16le
+bitrate: $SPOTIFY_BITRATE
+volume_steps: $SPOTIFY_VOLUME_STEPS
+initial_volume: $SPOTIFY_INITIAL_VOLUME
+external_volume: true
+disable_autoplay: false
+zeroconf_enabled: false
+credentials:
+  type: $SPOTIFY_CREDENTIALS_TYPE
+  interactive:
+    callback_port: $SPOTIFY_CALLBACK_PORT
+server:
+  enabled: true
+  address: 127.0.0.1
+  port: $SPOTIFY_API_PORT
+EOF
+    fi
+
+    export SPOTIFY_API_URL
+    export SPOTIFY_PIPE_PATH
+    export SPOTIFY_FFMPEG_PATH
+
+    /usr/local/bin/go-librespot --config_dir "$SPOTIFY_CONFIG_DIR" &
+fi
+
 exec java ${JAVA_OPTS:-} \
     -Dnogui=true \
     -Dconfig.file="$CONFIG_FILE" \

docker/instances/_template/bot.env.example

@@ -4,3 +4,6 @@ BOT_OWNER=497820759096295429
 # YT_OAUTH=false
 # YT_OAUTH_REFRESH_TOKEN=
 # JAVA_OPTS=-Xms256m -Xmx768m
+# SPOTIFY_ENABLED=true
+# SPOTIFY_DEVICE_NAME=devshmusic-test1-spotify
+# SPOTIFY_CALLBACK_PORT=0

src/main/java/com/jagrosh/jmusicbot/Bot.java

@@ -142,7 +142,7 @@ public void shutdown()
                 if(ah!=null)
                 {
                     ah.stopAndClear();
-                    ah.getPlayer().destroy();
+                    ah.destroy();
                 }
             });
             jda.shutdown();

src/main/java/com/jagrosh/jmusicbot/BotConfig.java

@@ -39,6 +39,10 @@ public class BotConfig
     private static final String YT_VISITOR_DATA_ENV = "YT_VISITOR_DATA";
     private static final String YT_OAUTH_ENV = "YT_OAUTH";
     private static final String YT_OAUTH_REFRESH_TOKEN_ENV = "YT_OAUTH_REFRESH_TOKEN";
+    private static final String SPOTIFY_ENABLED_ENV = "SPOTIFY_ENABLED";
+    private static final String SPOTIFY_API_URL_ENV = "SPOTIFY_API_URL";
+    private static final String SPOTIFY_PIPE_PATH_ENV = "SPOTIFY_PIPE_PATH";
+    private static final String SPOTIFY_FFMPEG_PATH_ENV = "SPOTIFY_FFMPEG_PATH";
     private final Prompt prompt;
     private final static String CONTEXT = "Config";
     private final static String START_TOKEN = "/// START OF JMUSICBOT CONFIG ///";
@@ -47,8 +51,9 @@ public class BotConfig
     private Path path = null;
     private String token, prefix, altprefix, helpWord, playlistsFolder, logLevel,
             successEmoji, warningEmoji, errorEmoji, loadingEmoji, searchingEmoji,
-            ytPoToken, ytVisitorData, ytOauthRefreshToken, evalEngine;
-    private boolean stayInChannel, songInGame, npImages, updatealerts, useEval, dbots, ytOauth;
+            ytPoToken, ytVisitorData, ytOauthRefreshToken, evalEngine,
+            spotifyApiUrl, spotifyPipePath, spotifyFfmpegPath;
+    private boolean stayInChannel, songInGame, npImages, updatealerts, useEval, dbots, ytOauth, spotifyEnabled;
     private long owner, maxSeconds, aloneTimeUntilStop;
     private int maxYTPlaylistPages;
     private double skipratio;
@@ -106,6 +111,10 @@ public void load()
             ytVisitorData = getEnvOverride(YT_VISITOR_DATA_ENV, config.getString("ytvisitordata"));
             ytOauth = getBooleanOverride(YT_OAUTH_ENV, config.getBoolean("ytoauth"));
             ytOauthRefreshToken = getEnvOverride(YT_OAUTH_REFRESH_TOKEN_ENV, config.getString("ytoauthrefreshtoken"));
+            spotifyEnabled = getBooleanOverride(SPOTIFY_ENABLED_ENV, config.getBoolean("spotifyenabled"));
+            spotifyApiUrl = getEnvOverride(SPOTIFY_API_URL_ENV, config.getString("spotifyapiurl"));
+            spotifyPipePath = getEnvOverride(SPOTIFY_PIPE_PATH_ENV, config.getString("spotifypipepath"));
+            spotifyFfmpegPath = getEnvOverride(SPOTIFY_FFMPEG_PATH_ENV, config.getString("spotifyffmpegpath"));
             transforms = config.getConfig("transforms");
             skipratio = config.getDouble("skipratio");
             dbots = owner == 113156185389092864L;
@@ -373,6 +382,26 @@ public String getYtOauthRefreshToken()
         return ytOauthRefreshToken.equals("YT_OAUTH_REFRESH_TOKEN_HERE") ? null : ytOauthRefreshToken;
     }
 
+    public boolean useSpotify()
+    {
+        return spotifyEnabled;
+    }
+
+    public String getSpotifyApiUrl()
+    {
+        return spotifyApiUrl;
+    }
+
+    public String getSpotifyPipePath()
+    {
+        return spotifyPipePath;
+    }
+
+    public String getSpotifyFfmpegPath()
+    {
+        return spotifyFfmpegPath;
+    }
+
     public boolean useEval()
     {
         return useEval;

src/main/java/com/jagrosh/jmusicbot/JMusicBot.java

@@ -35,6 +35,7 @@
 import net.dv8tion.jda.api.*;
 import net.dv8tion.jda.api.audio.AudioModuleConfig;
 import net.dv8tion.jda.api.entities.Activity;
+import net.dv8tion.jda.api.entities.Role;
 import net.dv8tion.jda.api.requests.GatewayIntent;
 import net.dv8tion.jda.api.utils.cache.CacheFlag;
 import net.dv8tion.jda.api.exceptions.ErrorResponseException;
@@ -197,6 +198,18 @@ private static CommandClient createCommandClient(BotConfig config, SettingsManag
         CommandClientBuilder cb = new CommandClientBuilder()
                 .setPrefix(config.getPrefix())
                 .setAlternativePrefix(config.getAltPrefix())
+                .setPrefixFunction(event ->
+                {
+                    if(!event.isFromGuild())
+                        return null;
+                    long selfId = event.getJDA().getSelfUser().getIdLong();
+                    return event.getGuild().getSelfMember().getRoles().stream()
+                            .filter(Role::isManaged)
+                            .filter(role -> role.getTags() != null && role.getTags().isBot() && role.getTags().getBotIdLong() == selfId)
+                            .findFirst()
+                            .map(role -> "<@&" + role.getId() + ">")
+                            .orElse(null);
+                })
                 .setOwnerId(Long.toString(config.getOwnerId()))
                 .setEmojis(config.getSuccess(), config.getWarning(), config.getError())
                 .setHelpWord(config.getHelp())