Complexity Score
Low
Open Issues
N/A
Dependent Projects
27
Weekly Downloadsglobal
6,888
Keywords
License
- MIT
- Yesattribution
- Permissivelinking
- Permissivedistribution
- Permissivemodification
- Nopatent grant
- Yesprivate use
- Permissivesublicensing
- Notrademark grant
Downloads
Readme
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')
).
- @noble/ciphers
- sodium-native
🚀 Installation
npm install distube @discordjs/voice @discordjs/opus
For FFmpeg installation:
- Windows Guide
- Linux Guide
[!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
💖 Support
Dependencies
No runtime dependency information found for this package.
CVE IssuesActive
0
Scorecards Score
No Data
Test Coverage
No Data
Follows Semver
Yes
Github Stars
439
Dependenciestotal
28
DependenciesOutdated
7
DependenciesDeprecated
0
Threat Modelling
No Data
Repo Audits
No Data
Learn how to distribute distube in your own private NPM registry
$npm config set registry
https://npm.cloudsmith.com/owner/repo
/Processing...
✓Done
$npm install distube
/Processing...
✓Done
201 Releases
NPM on Cloudsmith