1.1.7 • Published 2 years ago

discord-player-music v1.1.7

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

Welcome

Welcome! This 'discord-player-music' module! This is easy module for playing music in your Discord bot.

Installation

Please note: Node.js 14.0.0 or newer is required. All types in brackets mean the type of what the method or event returns.

Install discord-player-music dev

$ npm install xyligan-gp/discord-player-music#dev

Warning

If you get the error Cannot play audio as no valid encryption package is installed, be sure to install 1 of the following libraries: sodium, libsodium-wrappers or tweetnacl!

Features

  • Simple & easy to use 👍
  • Beginner friendly 😄
  • Audio filters 🎸
  • Lyrics 📃
  • Play in multiple servers at the same time ⏰
  • TypeScript Support 🔑
  • Flexible and customizable 🛠️
  • 100% Promise-based ⚙️

Module Managers

Module Constructor Options

  • 'options.searchResultsLimit' - Property responsible for the number of results received when searching for songs.
  • 'options.searchCollector' - Property responsible for the status of a custom module collector.

  • 'options.searchCollectorConfig.type' - Property responsible for the custom collector type of the module. Available types: message &reaction.

  • 'options.searchCollectorConfig.count' - Property responsible for the amount of all data for the module collector (taken from options.searchResultsLimit).

Quick Initialization Example

const Discord = require('discord.js');

const client = new Discord.Client();
const Player = require('discord-player-music');
const player = new Player(client);

client.on('ready', () => {
  console.log('Bot started!');
})

client.login('YOUR_BOT_TOKEN_HERE');

Examples

Click here to see JavaScript examples.

Useful Links