Skip to main content

A performant lavalink client for python

Project description

Salad

License: WTFPL Python Code style: black Discord

Salad is a lightning-fast, completely asynchronous Python framework designed for effortless Lavalink integration with discord.py. With full Lavalink specification support, clean API architecture, and robust integrated Spotify and Apple Music functionality, Salad enables creators to craft outstanding music bots effortlessly.

Developed as an improved fork of AquaLink, Salad provides enhanced performance and developer satisfaction.

Essential Resources

Setup Instructions

Requires Python 3.8 or newer and current pip version.

Production Version (Suggested)

pip install salada

Unstable version of Salad.

pip install git+https://github.com/ToddyTheNoobDud/salad

Quick Start Guide

Browse detailed examples in the examples folder

Here's a basic starter code:

import discord
from discord.ext import commands
from discord import app_commands
from salada import Salad

INTENTS = discord.Intents.default()
INTENTS.message_content = True
INTENTS.voice_states = True

NODES = [{
    'host': '127.0.0.1',
    'port': 50166,
    'auth': 'youshallnotpass',
    'ssl': False
}]

class MusicBot(commands.Bot):
    def __init__(self):
        super().__init__(command_prefix='!', intents=INTENTS)
        self.salad = None

    async def setup_hook(self):
        self.salad = Salad(self, NODES)
        await self.salad.start(NODES, str(self.user.id))
        await self.tree.sync()

bot = MusicBot()

@bot.tree.command(name='play')
@app_commands.describe(query='Song name or URL')
async def play(interaction: discord.Interaction, query: str):
    await interaction.response.defer()

    if not interaction.user.voice:
        await interaction.followup.send('❌ Join a voice channel first!')
        return

    player = bot.salad.players.get(interaction.guild.id)

    if not player:
        player = await bot.salad.createConnection({
            'guildId': interaction.guild.id,
            'voiceChannel': interaction.user.voice.channel.id,
            'textChannel': interaction.channel.id
        })
        await interaction.user.voice.channel.connect()

    result = await bot.salad.resolve(query, requester=interaction.user)
    tracks = result.get('tracks', [])

    if not tracks:
        await interaction.followup.send('❌ No tracks found!')
        return

    track = tracks[0]
    player.addToQueue(track)

    if not player.playing:
        await player.play()
        await interaction.followup.send(f'▶️ Now playing: **{track.title}**')
    else:
        await interaction.followup.send(f'➕ Added: **{track.title}**')

bot.run('putyourtokenhere.')

Common Questions

How do I configure Lavalink initially?

  • To configure Lavalink look Here For plugins look Here

What skills do I need to use Salad?

  • Salad requires you have a little experience with python and discord.py

My application can't locate the Salad package. What should I do?

  • This means you don't have Salad installed, To install it run: pip install salada and check if it's installed by doing pip freeze and searching for salada.

Why should I choose Salad over alternative Lavalink packages?

  • Salad has a wide variety of features to use aswell as enableReconnect, infiniteReconnect, maxReconnectAttempts and autoplay coming soon.

Acknowledgments

Appreciation to southctrl for creating filters and enums!

Project details


Download files

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

Source Distribution

salada-1.2.0.tar.gz (32.3 kB view details)

Uploaded Source

Built Distribution

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

salada-1.2.0-py3-none-any.whl (39.8 kB view details)

Uploaded Python 3

File details

Details for the file salada-1.2.0.tar.gz.

File metadata

  • Download URL: salada-1.2.0.tar.gz
  • Upload date:
  • Size: 32.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for salada-1.2.0.tar.gz
Algorithm Hash digest
SHA256 65a61210cd96f375ab642658fcf252743bfe1d0c0c0e3dde97d338e661e18280
MD5 245762195b07fd0ee3f6d2db0467643a
BLAKE2b-256 656df7984e29c7b7999971f39f47997a4f9e6f221e04b926ca18c369691a9b01

See more details on using hashes here.

File details

Details for the file salada-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: salada-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 39.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for salada-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2673bf349196f7c04f1aa9dc48ac11aa7e5c45b115d1548a0490a3d686c4615e
MD5 c5e62e4d079b8418bd9b4ec802558217
BLAKE2b-256 eca4cc39fe1cf1f72a8156ec8b683f93416d4b1e0a0d7e1f877fe0e39be74da2

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