Installation

This library is designed to work with the Lavalink v4 audio delivery system, which directly interfaces with Discord to provide buttery smooth audio without wasting your precious system resources.

Lyra is made with convenience in mind — everything is easy to use and out of your way, while also being customizable.

Setting up Lavalink

In order to start using this library, you need a running Lavalink v4 node. You can download the latest release here.

A minimal application.yml for Lavalink v4:

server:
  port: 2333
  address: 127.0.0.1

lavalink:
  plugins:
    # Required for YouTube support
    - dependency: "dev.lavalink.youtube:youtube-plugin:VERSION"
    - repository: "https://maven.lavalink.dev/releases"

    # Required for Spotify, Apple Music, Deezer, etc.
    - dependency: "com.github.topi314.lavasrc:lavasrc-plugin:VERSION"
      repository: "https://maven.lavalink.dev/releases"

    # Optional: LavaSearch for advanced search functionality
    - dependency: "com.github.topi314.lavasearch:lavasearch-plugin:VERSION"
      repository: "https://maven.lavalink.dev/releases"

  server:
    password: "youshallnotpass"

plugins:
  youtube:
    enabled: true
    allowSearch: true

  lavasrc:
    sources:
      spotify: true
      applemusic: true
      deezer: true
    
    spotify:
      clientId: ""
      clientSecret: ""
      spDc: ""
      countryCode: "US"      
      customTokenEndpoint: "http://localhost:8080/api/token"

    applemusic:
      countryCode: "US"

      # The following settings, manually input or empty to get a token automatically
      mediaAPIToken: "your apple music api token" # apple music api token
      # or specify an apple music key
      keyID: "your key id"
      teamID: "your team id"
      musicKitKey: |
        -----BEGIN PRIVATE KEY-----
        your key
        -----END PRIVATE KEY-----

For extended platform support (Spotify, Apple Music, Deezer, etc.) install the LavaSrc plugin on your Lavalink server.

Installing Lyra

After your Lavalink node is up and running, install Lyra with pip:

pip install lava-lyra

Lyra will handle installing all required dependencies automatically.

Next Steps

After installing Lyra, get familiar with how it works by starting with an example.

If you want to jump into the library and learn how to do everything you need, refer to the How Do I? section.

If you want a deeper look into how the library works beyond the How Do I? guide, refer to the API Reference section.