@discordx/plugin-lava-player
TypeScript icon, indicating that this package has built-in type declarations

1.0.6 • Public • Published

Discord server NPM version NPM downloads Build status PayPal

Create a discord bot with TypeScript and Decorators!

📖 Introduction

lava player plugin for discordx bots.

💻 Installation

npm install @discordx/plugin-lava-player
yarn add @discordx/plugin-lava-player
pnpm add @discordx/plugin-lava-player

⚠️ Prerequisites

To use this plugin, You will need to have a running Lavalink instance as well as fill the following variables in with the correct information:

  • LAVA_HOST - Either a Domain or IP pointing to the host of the Lavalink instance. Is optional, Default is localhost.
  • LAVA_PORT - Port on the host the Lavalink instance is running on. Is optional, Default is 2333.
  • LAVA_PASSWORD - Lavalink instance password. Is optional.
  • LAVA_SHARD - Number of Shards your bot is running. Is optional, Default is 0.

📄 Usage

import { Client, MetadataStorage } from "discordx";
import { LavaPlayerPlugin } from "@discordx/plugin-lava-player";

// Initialize the Plugin:
const lavaPlugin = new LavaPlayerPlugin({ metadata: MetadataStorage.instance });

// Provide the plugin to the Discordx Client:
const client = new Client({ plugins: [lavaPlugin] });

📜 Documentation

☎️ Need help?

💖 Thank you

You can support discordx by giving it a GitHub star.

Readme

Keywords

none

Package Sidebar

Install

npm i @discordx/plugin-lava-player

Weekly Downloads

6

Version

1.0.6

License

Apache-2.0

Unpacked Size

38 kB

Total Files

12

Last publish

Collaborators

  • samarmeena