Skip to content

Installation

RevvLink requires Python 3.10+ and a running Lavalink v4 server.

pip install revvlink

uv venv
# Creating virtual environment at: .venv
# Activate with: source .venv/bin/activate
uv pip install revvlink

RevvLink requires a running Lavalink v4 server. The quickest way to get one running is with Docker:

docker run --name lavalink \
  -p 2333:2333 \
  -e SERVER_PASSWORD=youshallnotpass \
  lavalink/lavalink:4

Or download the latest Lavalink.jar and create an application.yml:

application.yml
server:
  port: 2333
  address: 0.0.0.0
  http2:
    enabled: false
lavalink:
  server:
    password: "youshallnotpass"
    sources:
      youtube: true
      bandcamp: true
      soundcloud: true
      twitch: true
      vimeo: true
      http: true
      local: false
    filters:
      volume: true
      equalizer: true
      karaoke: true
      timescale: true
      tremolo: true
      vibrato: true
      distortion: true
      rotation: true
      channelMix: true
      lowPass: true
    bufferDurationMs: 400
    frameBufferDurationMs: 5000
    youtubePlaylistLoadLimit: 6
    playerUpdateInterval: 5
    youtubeSearchEnabled: true
    soundcloudSearchEnabled: true
    gc-warnings: true

Then run it:

java -jar Lavalink.jar

LavaSrc Plugin (Recommended)

Install the LavaSrc plugin to Lavalink to unlock Spotify, Apple Music, and Deezer support.

Verifying Installation

import revvlink
print(revvlink.__version__)  # e.g. "1.0.0"

Next Steps