Skip to main content

A Lavalink WebSocket & API wrapper for discord.py

Project description

GitHub license Support Server PyPi Crowdin Documentation Status

Documentation

Installation


Requirements


Supported sources

Built-in:

  • youtube (Deprecated with LL 4.0.5)
  • soundcloud
  • bandcamp
  • twitch
  • vimeo
  • http
  • local

With YouTube-plugin:

  • youtube

With LavaSrc

  • spotify
  • applemusic
  • deezer
  • youtube
  • flowery-tts

With DuncteBot-plugin:

  • getyarn.io
  • clypit
  • tts
  • pornhub
  • reddit
  • ocremix
  • tiktok
  • mixcloud
  • soundgasm

With Google Cloud TTS:

  • gcloud-tts

With Sponsorblock-Plugin:

  • sponsorblock

With LavaSearch:

With LavaLyrics:

Supported Lavalink features

  • Supports all features of Lavalink
    • Filters
    • IP Rotation
    • Plug-ins

Features

  • Multiple node support
    • Node region assignment based on IP
  • Track cache for the last 30 days to reduce the number of duplicated queries
  • Managed local node with auto-restart and auto update
  • Many helper methods and functions
  • Support for multiple cogs to access the library at once
  • Playlists and EQ saved at a library level to be shared with cogs
  • Player state persistence
    • Upon library state being shutdown all player states are saved and restored on library startup
  • History of played tracks available for players
  • RadioBrowser.org API to retrieve radio stations available for players
  • M3U, PLS and PYLAV text file parser to convert contents into a playlist (p.s. Lavalink must support the format/coded of files still)

System Requirements

With a locally hosted Postgres server and locally hosted/managed lavalink node (recommended - Best performance):

  • CPU: 3 cores or more
  • RAM: 4GB or more
  • Disk Space: 10GB or more (NVME Ideally, SSD OK)

With a locally hosted Postgres server and externally hosted lavalink node (Okay performance):

  • CPU: 2 cores or more
  • RAM: 3GB or more
  • Disk Space: 10GB or more (NVME Ideally, SSD OK)

With an externally hosted Postgres server and locally hosted/managed lavalink node (Poor performance):

  • CPU: 2 cores or more
  • RAM: 2GB or more
  • Disk Space: 10GB or more (SSD)

With an externally hosted Postgres server and externally hosted lavalink node (Worst performance):

  • CPU: 1 cores or more
  • RAM: 1GB or more
  • Disk Space: 10GB or more (SSD)

Credits

  • Topi for all the work done to Lavalink and implementing direct requests to make PyLav even better.
  • Devoxin - Lavalink.py for the original ideas for implementation.
  • globocom/m3u8 for the M3U8 parser which I made asynchronous found in m3u8_parser.
  • andreztz/pyradios for the radio parser which I made asynchronous found in radio.
  • Lifeismana for the custom Red-DiscordBot docker image which added Python3.11 support until Phasecore's image is updated.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

py_lav-1.15.1.tar.gz (765.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

py_lav-1.15.1-py3-none-any.whl (1.9 MB view details)

Uploaded Python 3

File details

Details for the file py_lav-1.15.1.tar.gz.

File metadata

  • Download URL: py_lav-1.15.1.tar.gz
  • Upload date:
  • Size: 765.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.11.9 Linux/6.5.0-1018-azure

File hashes

Hashes for py_lav-1.15.1.tar.gz
Algorithm Hash digest
SHA256 09f93031aa9240a186366d8868de81b60e8fcb06e9c7160c33874c928d9a105f
MD5 5e36f9521e8f3f05b0e0e00614c07e9c
BLAKE2b-256 29c1e17ec401812480af0b3bf910a15853c1958376a5042ba17865f4c62cab60

See more details on using hashes here.

File details

Details for the file py_lav-1.15.1-py3-none-any.whl.

File metadata

  • Download URL: py_lav-1.15.1-py3-none-any.whl
  • Upload date:
  • Size: 1.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.11.9 Linux/6.5.0-1018-azure

File hashes

Hashes for py_lav-1.15.1-py3-none-any.whl
Algorithm Hash digest
SHA256 375064534750d76d5420b8b3e43975386ca896e7086e87153268468e7c1426f4
MD5 75694b7c09edd7ebcaea9c32d3835507
BLAKE2b-256 fdbaf775ae7e2636b5d32e6dafdbe38ff94897d2c90c96bef1c98dd1afeb23cc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page