DisTube API Documentation

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

Node.js 18.17.0 or higher
discord.js v14
@discordjs/voice
@discordjs/opus
FFmpeg

🔒 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

API Documentation - Detailed API reference
DisTube Guide - Step-by-step guide for beginners
Plugin List - Available plugins for music sources

🤝 Contributing

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

📄 License

Licensed under MIT License