https://github.com/skick1234/DisTube
A powerful Discord.js module for simplifying music commands and effortless playback of various sources with integrated audio filters.
https://github.com/skick1234/DisTube
audio-filters bassboost bot discord discord-bot discord-bots discord-js discord-music-bot discordjs-bot discordjs-voice distube music music-commands queue queue-manager soundcloud spotify video youtube
Last synced: about 1 month ago
JSON representation
A powerful Discord.js module for simplifying music commands and effortless playback of various sources with integrated audio filters.
- Host: GitHub
- URL: https://github.com/skick1234/DisTube
- Owner: skick1234
- License: mit
- Created: 2020-07-08T10:27:05.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-27T16:04:24.000Z (8 months ago)
- Last Synced: 2024-10-29T15:21:20.179Z (8 months ago)
- Topics: audio-filters, bassboost, bot, discord, discord-bot, discord-bots, discord-js, discord-music-bot, discordjs-bot, discordjs-voice, distube, music, music-commands, queue, queue-manager, soundcloud, spotify, video, youtube
- Language: TypeScript
- Homepage: https://distube.js.org
- Size: 19.5 MB
- Stars: 423
- Watchers: 6
- Forks: 94
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-discord - DisTube - commit/distubejs/distube?style=flat-square) |  |  | A comprehensive Discord music bot library built for Discord.js, offering simplified music commands, effortless playback from diverse sources, and integrated audio filters. | (Libraries)
- awesome-discord - DisTube - commit/distubejs/distube?style=flat-square) |  |  | A comprehensive Discord music bot library built for Discord.js, offering simplified music commands, effortless playback from diverse sources, and integrated audio filters. | (Libraries)
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](https://discord.js.org) v14 and [@discordjs/voice](https://discord.js.org)
- **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](https://discord.gg/feaDd9h) for help
## 📋 Requirements
- Node.js 18.17.0 or higher
- [discord.js](https://discord.js.org) v14
- [@discordjs/voice](https://github.com/discordjs/voice)
- [@discordjs/opus](https://github.com/discordjs/opus)
- [FFmpeg](https://www.ffmpeg.org/download.html)
### 🔒 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](https://www.npmjs.com/package/@noble/ciphers)
- [sodium-native](https://www.npmjs.com/package/sodium-native)
## 🚀 Installation
```bash
npm install distube @discordjs/voice @discordjs/opus
```
For FFmpeg installation:
- [Windows Guide](http://blog.gregzaal.com/how-to-install-ffmpeg-on-windows/)
- [Linux Guide](https://www.tecmint.com/install-ffmpeg-in-linux/)
> [!NOTE]
> Alternative FFmpeg builds available [here](https://github.com/BtbN/FFmpeg-Builds/releases)
## 📚 Documentation
- [API Documentation](https://distube.js.org/) - Detailed API reference
- [DisTube Guide](https://github.com/skick1234/DisTube/wiki) - Step-by-step guide for beginners
- [Plugin List](https://github.com/skick1234/DisTube/wiki/Projects-Hub#plugins) - Available plugins for music sources
## 🤝 Contributing
Contributions are welcome! Please read our [Contributing Guidelines](https://github.com/skick1234/DisTube/blob/main/.github/CONTRIBUTING.md) before submitting a pull request.
## 📄 License
Licensed under [MIT License](https://github.com/skick1234/DisTube/blob/main/LICENSE)
## 💖 Support