stormbeatz-lavaclient

A simple, easy-to-use, and flexible lavalink client for node.js. Forked from Lavaclient. Used for StormBeatz.

Usage no npm install needed!

<script type="module">
  import stormbeatzLavaclient from 'https://cdn.skypack.dev/stormbeatz-lavaclient';
</script>

README

LavaClient

discord server • codacy rating • npm version

A simple, easy-to-use, and flexible node.js lavalink client.

  • Flexible: LavaClient doesn't depend on a specific Discord library. Each class can be changed relatively easily, allowing everything to be customized.
  • Plugins: Provides a simple Plugin class that the Manager can load, you can view the Plugins Guide for a basic implementation.
  • Easy-to-use: LavaClient has a neat and user-friendly promise-based api.
  • Performant: Designed to be small and performant, it's a great choice for any sized project.

Installation

node.js v14 or newer needed.

npm install lavaclient
# or
yarn add lavaclient

Usage

Documentation: https://lavaclient.js.org/ outdated (join our support server for updates)

import LavaClient from "lavaclient";

const nodes = [
  {
    id: "My Node",
    host: "localhost",
    port: 3000,
    password: "lavaclient-is-amazing"
  }
]

const manager = new LavaClient.Manager(nodes, {
  send(id, payload) {
    sendPayloadToDiscord()
    // check out our guides for an eris and discord.js example.
  }
});

await manager.init("your client id.");

// Use these two methods when receiving voice state and server updates.
await manager.stateUpdate(<update>);
await manager.serverUpdate(<update>);

Bot Showcase

Here's a few bots that use Lavaclient in production!

If you'd like your bot listed just join our discord and ask 2D#5773!

melike2d © 2020