Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

distube

skick123429.6kMIT5.0.7TypeScript support: included

A powerful Discord.js module for simplifying music commands and effortless playback of various sources with integrated audio filters.

youtube, music, discord, discordjs, bot, distube, queue, musicbot, discord-music-bot, music-bot, discord-js

readme

GitHub Workflow Status node-current npm peer dependency version Codecov branch
npm GitHub Repo stars Discord

Buy Me a Coffee at ko-fi.com

DisTube

DisTube is a comprehensive Discord music bot library built for Discord.js, offering simplified music commands, effortless playback from diverse sources, and integrated audio filters.

🌟 Features

  • Easy Integration: Built on top of discord.js v14 and @discordjs/voice
  • Voice Management: Robust handling of voice connections and queue management
  • Audio Filters: Built-in filters (bassboost, echo, karaoke, etc.) and custom filter support
  • Plugin System: Extensible architecture supporting various music sources through plugins
  • Type Safety: Written in TypeScript for better development experience
  • Active Community: Join our Discord Support Server for help

📋 Requirements

🔒 Encryption Libraries

[!NOTE] You only need to install one of these libraries if your system does not support aes-256-gcm (verify by running require('node:crypto').getCiphers().includes('aes-256-gcm')).

🚀 Installation

npm install distube @discordjs/voice @discordjs/opus

For FFmpeg installation:

[!NOTE] Alternative FFmpeg builds available here

📚 Documentation

🤝 Contributing

Contributions are welcome! Please read our Contributing Guidelines before submitting a pull request.

📄 License

Licensed under MIT License

💖 Support

Support me on Ko-fi