An open API service indexing awesome lists of open source software.

https://github.com/skick1234/distube

A comprehensive Discord music bot library built for Discord.js, offering simplified music commands, effortless playback from diverse sources, and 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: 2 days ago
JSON representation

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

Awesome Lists containing this project

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](https://discord.js.org), offering simplified music commands, effortless playback from diverse sources, and integrated audio filters.

## 🌟 Key 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 YouTube, Spotify, SoundCloud, and 700+ other sites.
- **Type Safety**: Written in TypeScript for a superior development experience.

## 📚 Resources

| Resource | Description |
| --- | --- |
| [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/skick1234/DisTube) | Learn DisTube with AI-powered assistance. |
| [Installation](https://deepwiki.com/skick1234/DisTube/Installation) | Detailed requirements and setup guide. |
| [API Reference](https://distube.js.org/) | Complete technical documentation. |
| [Discord Support](https://discord.gg/feaDd9h) | Join our community for help and discussion. |

## 🚀 Quick Start

```bash
npm install distube @discordjs/voice @discordjs/opus
```

```javascript
const { DisTube } = require('distube');
const { Client, GatewayIntentBits } = require('discord.js');

const client = new Client({
intents: [
GatewayIntentBits.Guilds,
GatewayIntentBits.GuildVoiceStates,
GatewayIntentBits.GuildMessages,
GatewayIntentBits.MessageContent,
],
});

const distube = new DisTube(client, {
emitNewSongOnly: true,
});

distube.on('playSong', (queue, song) =>
queue.textChannel.send(`Playing \`${song.name}\` - \`${song.formatDuration()}\``)
);

client.on('messageCreate', message => {
if (message.content.startsWith('!play')) {
distube.play(message.member.voice.channel, message.content.slice(6), {
message,
textChannel: message.channel,
member: message.member,
});
}
});

client.login('TOKEN');
```

## 🤝 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 me on Ko-fi