dpm

discord-player-music

A powerful music module for your Discord bot with lots of features.

Showing:

Popularity

Downloads/wk

55

GitHub Stars

6

Maintenance

Last Commit

1mo ago

Contributors

2

Package

Dependencies

9

License

MIT

Type Definitions

Built-In

Tree-Shakeable

No?

Categories

Readme


discord-player-music


Support server NPM version NPM downloads

Welcome

Welcome! This 'discord-player-music' module!
Discord Player Music is a powerful Node.js music module for your Discord.js bot that based on Promises and has a lot of features.

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

$ npm install discord-player-music

Features

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

Module Managers

  • 'CollectorsManager' - Manager that enables module Collectors.
  • 'QueueManager' - Manager that enables module Queue
  • 'UtilsManager' - Manager that enables module Utils.
  • 'VoiceManager' - Manager that enables module Voice.

Module Constructor Options

  • 'options.searchResultsLimit' - Property responsible for the number of results received when searching for songs.

  • 'options.synchronLoop' - Property responsible for synchronization status 'loop.song' & 'loop.queue'.

  • 'options.defaultVolume' - Property responsible for the default value of the playback volume.

  • 'options.collectorsConfig.autoAddingSongs' - Property responsible for the automatic addition of songs in queue.

  • 'options.collectorsConfig.maxAttempts' - Property responsible for the maximum number of attempts to get a valid value.

  • 'options.collectorsConfig.time' - Property responsible for the amount of time that the collector will collect values.

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

Thanks for using Discord Player Music ♥

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100