📖 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 islocalhost
. -
LAVA_PORT
- Port on the host the Lavalink instance is running on. Is optional, Default is2333
. -
LAVA_PASSWORD
- Lavalink instance password. Is optional. -
LAVA_SHARD
- Number of Shards your bot is running. Is optional, Default is0
.
📄 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?
- Check frequently asked questions
- Check examples
- Ask in the community Discord server