https://github.com/toddythenoobdud/aqualink
An Stable, performant, Recourse friendly and fast lavalink wrapper
https://github.com/toddythenoobdud/aqualink
discord-js discord-music-bot high-performance javscript lavalink lavalink-client lavalink-wrapper wrapper youtube
Last synced: 11 months ago
JSON representation
An Stable, performant, Recourse friendly and fast lavalink wrapper
- Host: GitHub
- URL: https://github.com/toddythenoobdud/aqualink
- Owner: ToddyTheNoobDud
- Created: 2024-12-01T18:58:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-08-22T18:15:55.000Z (12 months ago)
- Last Synced: 2025-08-22T20:58:44.367Z (12 months ago)
- Topics: discord-js, discord-music-bot, high-performance, javscript, lavalink, lavalink-client, lavalink-wrapper, wrapper, youtube
- Language: JavaScript
- Homepage: https://toddythenoobdud.github.io/aqualink.github.io/
- Size: 965 KB
- Stars: 6
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/aqualink)
[](https://www.npmjs.com/package/aqualink)
[](https://github.com/ToddyTheNoobDud/AquaLink/stargazers)
[](https://discord.gg/K4CVv84VBC)
🌊 REIMAGINING AUDIO STREAMING FOR DISCORD 🌊
Experience crystal-clear audio with unmatched stability
## 💎 Why Choose Aqualink?
🚀
Performance First
Optimized architecture with 50% less latency than other wrappers
🛠️
Developer Friendly
Intuitive API with extensive documentation and CJS/ESM support
🔌
Extendable
Plugin ecosystem for custom functionality and seamless integration
## 📦 Installation
**Latest Stable Release: `v2.11.7`** • **Choose your preferred package manager below**
📦 NPM (Most Popular)
```bash
# 🎯 Stable release (recommended for production)
npm install aqualink
# 🚧 Latest development build
npm install ToddyTheNoobDud/aqualink
```
🧶 Yarn (Fast & Reliable)
```bash
# 🎯 Stable release (recommended for production)
yarn add aqualink
# 🚧 Latest development build
yarn add ToddyTheNoobDud/aqualink
```
⚡ Bun (Lightning Fast)
```bash
# 🎯 Stable release (recommended for production)
bun add aqualink
# 🚧 Latest development build
bun add ToddyTheNoobDud/aqualink
```
📦 pnpm (Space Efficient)
```bash
# 🎯 Stable release (recommended for production)
pnpm add aqualink
# 🚧 Latest development build
pnpm add ToddyTheNoobDud/aqualink
```
## 🔥 Feature Highlights
Advanced Filters
EQ, Bass Boost, Nightcore & more
Fail-Safe System
Auto-reconnect & queue preservation
Real-time Analytics
Performance monitoring & insights
Customizable
Adapt to your specific needs
## 📦 Resources
## 💻 Quick Start
```bash
npm install aqualink discord.js
```
```javascript
const { Aqua } = require("aqualink");
const { Client, GatewayIntentBits, Events } = require("discord.js");
const client = new Client({
intents: [
GatewayIntentBits.Guilds,
GatewayIntentBits.GuildMembers,
GatewayIntentBits.GuildMessages,
GatewayIntentBits.MessageContent,
GatewayIntentBits.GuildVoiceStates
]
});
const nodes = [
{
host: "127.0.0.1",
password: "your_password",
port: 2333,
secure: false,
name: "main-node"
}
];
const aqua = new Aqua(client, nodes, {
defaultSearchPlatform: "ytsearch",
restVersion: "v4",
autoResume: true,
infiniteReconnects: true,
autoplayPlatform: ['spsearch', 'ytsearch', 'scsearch'],
nodeResolver: 'LeastLoad'
});
client.aqua = aqua;
client.once(Events.Ready, () => {
client.aqua.init(client.user.id);
console.log(`Logged in as ${client.user.tag}`);
});
client.on(Events.Raw, (d) => {
if (![Events.VoiceStateUpdate, Events.VoiceServerUpdate].includes(d.t)) return;
client.aqua.updateVoiceState(d);
});
client.on(Events.MessageCreate, async (message) => {
if (message.author.bot || !message.content.startsWith("!play")) return;
const query = message.content.slice(6).trim();
if (!query) return message.channel.send("Please provide a song to play.");
// Check if user is in a voice channel
if (!message.member.voice.channel) {
return message.channel.send("You need to be in a voice channel to play music!");
}
const player = client.aqua.createConnection({
guildId: message.guild.id,
voiceChannel: message.member.voice.channel.id,
textChannel: message.channel.id,
deaf: true,
});
try {
const resolve = await client.aqua.resolve({ query, requester: message.member });
const { loadType, tracks, playlistInfo } = resolve;
if (loadType === 'playlist') {
for (const track of tracks) {
player.queue.add(track);
}
message.channel.send(`Added ${tracks.length} songs from ${playlistInfo.name}.`);
} else if (loadType === 'search' || loadType === 'track') {
const track = tracks[0];
player.queue.add(track);
message.channel.send(`Added **${track.title}** to the queue.`);
} else {
return message.channel.send("No results found.");
}
if (!player.playing && !player.paused) {
player.play();
}
} catch (error) {
console.error("Playback error:", error);
message.channel.send("An error occurred while trying to play the song.");
}
});
client.aqua.on("nodeConnect", (node) => {
console.log(`Node connected: ${node.name}`);
});
client.aqua.on("nodeError", (node, error) => {
console.log(`Node "${node.name}" encountered an error: ${error.message}.`);
});
client.aqua.on('trackStart', (player, track) => {
const channel = client.channels.cache.get(player.textChannel);
if (channel) channel.send(`Now playing: **${track.title}**`);
});
client.aqua.on('queueEnd', (player) => {
const channel = client.channels.cache.get(player.textChannel);
if (channel) channel.send('The queue has ended.');
player.destroy();
});
client.login("YOUR_DISCORD_BOT_TOKEN");
```
### Additional Commands You Can Add:
```javascript
client.on(Events.MessageCreate, async (message) => {
if (message.content === "!skip") {
const player = client.aqua.players.get(message.guild.id);
if (player) {
player.skip();
message.channel.send("⏭️ Skipped current track!");
}
}
});
client.on(Events.MessageCreate, async (message) => {
if (message.content === "!stop") {
const player = client.aqua.players.get(message.guild.id);
if (player) {
player.destroy();
message.channel.send("⏹️ Stopped playback and cleared queue!");
}
}
});
```
## 🌟 Featured Projects
[View All Projects →](https://github.com/ToddyTheNoobDud/AquaLink#used-by)
**300+** weekly downloads • **3+** GitHub stars • **3+** Discord bots
## 📖 Documentation
For detailed usage, API references, and examples, check out our official documentation:
[](https://roddynnn.github.io/docs/)
📌 **Get Started Quickly**
- Installation guide
- API methods
- Advanced features
- Troubleshooting
🔗 Visit: **[Aqualink Docs](https://roddynnn.github.io/docs)**
## 👑 Premium Bots Using Aqualink
| Bot | Invite Link | Features |
|-----|-------------|----------|
| Kenium | [Add to Discord](https://discord.com/oauth2/authorize?client_id=1202232935311495209) | Audio streaming, Discord integration |
| Soya Music | [Add to Discord](https://discord.com/oauth2/authorize?client_id=997906613082013868&permissions=281357446481&integration_type=0&scope=bot+applications.commands) | Audio streaming, Discord integration |
## 🛠️ Advanced Features
🎛️ Audio Filters
- Equalizer (15-band)
- Bass Boost & Bass Cut
- Nightcore & Vaporwave
- 8D Audio & Rotation
- Karaoke & Channel Mixing
🔄 Queue Management
- Shuffle & Loop modes
- Queue history & navigation
- Auto playlist continuation
- Skip voting systems
- Playlist import/export
📊 Monitoring
- Resource utilization
- Performance metrics
- Automatic issue detection
- Node health tracking
- Load balancing
## 👥 Contributors
## 🤝 Contributing
We welcome contributions from developers of all skill levels! Whether it's adding features, fixing bugs, or improving documentation.
[](CONTRIBUTING.md)
## 💬 Community & Support
Join our thriving community of developers and bot creators!
[](https://discord.gg/K4CVv84VBC)
[](https://github.com/ToddyTheNoobDud/AquaLink/discussions)
Built with 💙 by the Aqualink Team
