Lavende

In-process Discord voice connection and audio playback engine

Features

• Native Performance - Written in Rust for maximum speed and efficiency
• No Separate Server - Runs directly in your Node.js process
• Audio Sources - YouTube, Spotify, SoundCloud, Apple Music, Deezer, and more
• Audio Effects - Equalizer, timescale, rotation, vibrato, tremolo, reverb, and more
• Low Latency - Direct function calls instead of REST/WebSocket overhead
• DAVE E2EE - Discord's end-to-end encryption support
• Zero Dependencies - Prebuilt binaries for all platforms

Installation

npm install lavende

Lavende automatically downloads the correct prebuilt binary for your platform (Windows, macOS, Linux).

Quick Start

const { Client, GatewayIntentBits } = require('discord.js');
const { LavendeManager } = require('lavende');

const client = new Client({
  intents: [
    GatewayIntentBits.Guilds,
    GatewayIntentBits.GuildVoiceStates,
    GatewayIntentBits.GuildMessages,
    GatewayIntentBits.MessageContent
  ]
});

const manager = new LavendeManager({
  sendToShard: (guildId, payload) => {
    client.guilds.cache.get(guildId)?.shard?.send(payload);
  },
  client: {
    id: 'YOUR_BOT_CLIENT_ID'
  }
});

client.once('ready', () => {
  console.log('Bot is ready!');
  manager.init({ id: client.user.id, username: client.user.username });
});

client.on('raw', (packet) => {
  manager.sendRawData(packet);
});

client.on('messageCreate', async (message) => {
  if (message.content === '!play') {
    const player = manager.createPlayer({
      guildId: message.guildId,
      voiceChannelId: message.member.voice.channelId,
      textChannelId: message.channelId
    });

    const result = await player.search('your song query', message.author);
    player.queue.add(result.tracks[0]);
    
    await player.connect();
    await player.play();
  }
});

client.login('YOUR_BOT_TOKEN');

Documentation

Manager

const manager = new LavendeManager({
  sendToShard: (guildId, payload) => void,
  client: { id: string, username?: string }
});

manager.init(clientData);
manager.createPlayer(options);
manager.destroyPlayer(guildId);

Player

const player = manager.createPlayer({
  guildId: string,
  voiceChannelId: string,
  textChannelId?: string,
  volume?: number,
  selfDeaf?: boolean
});

await player.play(options?);
await player.pause(pauseState?);
await player.resume();
await player.stop();
await player.skip();
await player.seek(positionMs);
await player.setVolume(volume);

player.queue.add(track);
player.queue.remove(index);
player.queue.clear();
player.queue.shuffle();

await player.filterManager.setVolume(volume);
await player.filterManager.setSpeed(speed);
await player.filterManager.setPitch(pitch);
await player.filterManager.setAudioOutput('mono' | 'stereo' | 'left' | 'right');
await player.filterManager.toggleRotation();
await player.filterManager.resetFilters();

const result = await player.search(query, requester);

Events

player.on('trackStart', (player, track) => {});
player.on('trackEnd', (player, track, reason) => {});
player.on('queueEnd', (player) => {});
player.on('error', (player, error) => {});
player.on('position', (player, position) => {});

Supported Sources

• YouTube / YouTube Music
• Spotify
• SoundCloud
• Apple Music
• Deezer
• Tidal
• JioSaavn
• Bandcamp
• Mixcloud
• Twitch
• And many more!

Audio Filters

• Volume Control
• Equalizer (15 bands)
• Timescale (speed, pitch, rate)
• Rotation (3D audio)
• Tremolo
• Vibrato
• Distortion
• Channel Mix
• Karaoke
• Low Pass / High Pass
• Reverb
• Echo
• Chorus
• Compressor
• And more!

Advanced Configuration

IMPORTANT: You must create a source.json file in your project root directory to run your bot. This file configures which audio sources are enabled and their settings.

Create a source.json file in your project root with the following configuration:

{
  "sources": {
    "youtube": {
      "enabled": true,
      "clients": {
        "search": [
          "TVHTML5_SIMPLY",
          "MUSIC_ANDROID",
          "ANDROID",
          "WEB"
        ],
        "playback": [
          "ANDROID_VR",
          "TV_CAST",
          "WEB_EMBEDDED",
          "TV",
          "WEB",
          "IOS",
          "MWEB"
        ],
        "resolve": [
          "TVHTML5_SIMPLY",
          "TVHTML5_UNPLUGGED",
          "WEB",
          "MWEB",
          "IOS",
          "ANDROID"
        ]
      },
      "cipher": {
        "url": "https://cipher.kikkia.dev/api",
        "token": null
      }
    },
    "spotify": {
      "enabled": false,
      "client_id": "YOUR_SPOTIFY_CLIENT_ID",
      "client_secret": "YOUR_SPOTIFY_CLIENT_SECRET"
    },
    "soundcloud": {
      "enabled": true,
      "client_id": null
    },
    "applemusic": {
      "enabled": true,
      "country_code": "us"
    },
    "deezer": {
      "enabled": true
    },
    "jiosaavn": {
      "enabled": true
    },
    "http": {
      "enabled": true
    },
    "local": {
      "enabled": false
    }
  }
}

Note:

• The source.json file is required for the bot to work
• Enable/disable sources by setting "enabled": true or "enabled": false
• For Spotify, you need to provide your own API credentials from Spotify Developer Dashboard
• For full configuration options, see the example file in the package

Building from Source

npm install
npm run build
npm run build:debug

License

Licensed under the Apache License, Version 2.0 - see LICENSE file for details.

Contributing

Contributions are welcome! Please open an issue or PR.

Acknowledgements

This project is a personal hobby and learning endeavor. It is not intended to compete with, criticize, or harm any existing projects. We have great respect for the work done by the teams behind Lavalink, NodeLink, and lavalink-client, which have been instrumental in the Discord music bot ecosystem. If you find this project useful, feel free to use it. If not, that's perfectly fine too.

Built using:

• Lavalink - For inspiration and protocol design
• NodeLink - For additional inspiration
• lavalink-client - For client implementation inspiration
• napi-rs - Rust bindings for Node.js
• symphonia - Pure Rust audio decoding
• audiopus - Opus encoding
• tokio - Async runtime

Made by Debauchery Party