https://github.com/PythonistaGuild/Wavelink

A powerful Lavalink library for Discord.py.
https://github.com/PythonistaGuild/Wavelink

discord-bot discord-py lavalink lavaplayer music music-bot python

Last synced: 3 months ago
JSON representation

A powerful Lavalink library for Discord.py.

• Host: GitHub
• URL: https://github.com/PythonistaGuild/Wavelink
• Owner: PythonistaGuild
• License: mit
• Created: 2019-01-04T05:32:14.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2025-01-25T09:43:02.000Z (5 months ago)
• Last Synced: 2025-03-16T16:57:53.710Z (3 months ago)
• Topics: discord-bot, discord-py, lavalink, lavaplayer, music, music-bot, python
• Language: Python
• Homepage: https://wavelink.dev
• Size: 920 KB
• Stars: 407
• Watchers: 11
• Forks: 186
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-discord - Wavelink - A powerful Lavalink library for Discord.py. (Misc Resources)

README

        


![Logo](https://raw.githubusercontent.com/PythonistaGuild/Wavelink/master/logo.png)

![Python Version](https://img.shields.io/pypi/pyversions/Wavelink)

[![PyPI - Version](https://img.shields.io/pypi/v/Wavelink)](https://pypi.org/project/wavelink/)

[![Github License](https://img.shields.io/github/license/PythonistaGuild/Wavelink)](LICENSE)

[![Lavalink Version](https://img.shields.io/badge/Lavalink-v4.0%2B-blue?color=%23FB7713)](https://lavalink.dev)

![Lavalink Plugins](https://img.shields.io/badge/Lavalink_Plugins-Native_Support-blue?color=%2373D673)



Wavelink is a robust and powerful Lavalink wrapper for [Discord.py](https://github.com/Rapptz/discord.py)

Wavelink features a fully asynchronous API that's intuitive and easy to use.

# Migrating from Version 2 to Version 3:

[Migrating Guide](https://wavelink.dev/en/latest/migrating.html)

### Features

- Full asynchronous design.

- Lavalink v4+ Supported with REST API.

- discord.py v2.0.0+ Support.

- Advanced AutoPlay and track recommendations for continuous play.

- Object orientated design with stateful objects and payloads.

- Fully annotated and complies with Pyright strict typing.

## Getting Started

**See Examples:** [Examples](https://github.com/PythonistaGuild/Wavelink/tree/main/examples)

**Lavalink:** [GitHub](https://github.com/lavalink-devs/Lavalink/releases), [Webpage](https://lavalink.dev)

## Documentation

[Official Documentation](https://wavelink.dev/en/latest)

## Support

For support using WaveLink, please join the official [Support Server](https://discord.gg/RAKc3HF) on

[Discord](https://discordapp.com)

[![Discord Banner](https://discordapp.com/api/guilds/490948346773635102/widget.png?style=banner2)](https://discord.gg/RAKc3HF)

## Installation

**WaveLink 3 requires Python 3.10+**

**Windows**

```sh

py -3.10 -m pip install -U wavelink

```

**Linux**

```sh

python3.10 -m pip install -U wavelink

```

**Virtual Environments**

```sh

pip install -U wavelink

```

## Lavalink

Wavelink **3** requires **Lavalink v4**.

See: [Lavalink](https://github.com/lavalink-devs/Lavalink/releases)

For spotify support, simply install and use [LavaSrc](https://github.com/topi314/LavaSrc) with your `wavelink.Playable`

### Notes

- Wavelink **3** is compatible with Lavalink **v4+**.

- Wavelink has built in support for Lavalink Plugins including LavaSrc and SponsorBlock.

- Wavelink is fully typed in compliance with Pyright Strict, though some nuances remain between discord.py and wavelink.