<p align="center"> <img src="https://github.com/1Lucas1apk/lab/blob/master/mwc2h6q%20-%20Imgur.png?raw=true" alt="NodeLink Banner"/> </p> <h1 align="center">NodeLink</h1> <p align="center"> <b>A modern Lavalink alternative built entirely in Node.js</b><br> Lightweight, modular, and optimized for real-time performance. </p> <p align="center"> <a href="https://nodelink.js.org">📚 Documentation</a> • <a href="https://nodelink.js.org/docs/api/rest">API Reference</a> • <a href="https://nodelink.js.org/docs/differences">NodeLink vs Lavalink</a> • <a href="https://nodelink.js.org/docs/troubleshooting">Troubleshooting</a> </p>

Prerequisites

Node.js v22 or higher (v24 recommended)
Git

Overview

NodeLink is an alternative audio server built in Node.js, designed for those who value control and efficiency. 🌿 It doesn’t try to reinvent the wheel — it just makes it spin with less weight. Easy to configure, naturally scalable, and with smooth playback, it provides a solid foundation for music bots and real-time audio systems.

Created by Brazilian developers, NodeLink was born from the desire for a simpler, open, and truly accessible audio server for everyone.

Full documentation available at nodelink.js.org 💚

Features

100% Node.js implementation – No external runtime required
Lavalink-compatible API – Works with most existing clients
Optimized decoding ⚡ – Powered by WebAssembly and native modules
Worker-based architecture – Each player can run in its own process for true isolation
Real-time audio filters – Equalizer, timescale, tremolo, compressor, echo, chorus, phaser, and more
Low memory footprint – Efficient even with multiple active players
Prometheus metrics – Production-ready monitoring with detailed statistics
Multiple source support – 15+ sources including YouTube, Spotify, Apple Music, Deezer, and more

Quick Start

# Clone the repository
git clone https://github.com/PerformanC/NodeLink.git
cd NodeLink

# Install dependencies
npm install

# Copy the default configuration file
cp config.default.js config.js

# Start the server
npm run start

Once started, NodeLink runs a Lavalink-compatible WebSocket server, ready for immediate use.

Docker

NodeLink also supports Docker for easy deployment:

# Using Docker Compose
docker-compose up -d

# Or using Docker directly
docker build -t nodelink .
docker run -p 2333:2333 nodelink

See the Docker guide: nodelink.js.org/docs/advenced/docker

Usage

NodeLink is compatible with most Lavalink clients, as it implements nearly the entire original API. However, some clients may not work properly, since NodeLink changes certain behaviors and endpoints.

| Client | ------------------------------------------------------------------- | Lava | Lavalink.kt | DisGoLink | Lavalink.py | Mafic | Wavelink | Pomice | lava-lyra | Hikari-ongaku | Moonlink.js | Magmastream | Lavacord | Shoukaku | Hoshimi | Lavalink-Client | Rainlink | Poru | Blue.ts | Platform | v3 supported? | NodeLink Features? | NodeLink major version | Notes | | ------------ | ------------- | ------------------ | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | link-Client | JVM | unknown | No | v1 and v2 | | | Kotlin | unknown | No | v1 | | | Go | unknown | No | v1 and v2 | | | Python | unknown | No | v1 and v2 | | | Python | unknown | No | v1 and v2 | | | Python | Yes | No | v1, v2, v3 | | | Python | unknown | No | v1 and v2 | | | Python | Yes | Yes | v3 | | | Python | unknown | No | v1 and v2 | | | TypeScript | Yes | Yes | v1, v2, v3 | | | TypeScript | unknown | No | v1 | | | TypeScript | unknown | No | v1 and v2 | | | TypeScript | Yes | No | v1, v2, v3 | | | TypeScript | Yes | No | v1, v2, v3 | ;P | | TypeScript | Yes | Yes | v1, v3 | | | TypeScript | unknown | No | v1 and v2 | | | TypeScript | unknown | No | v1 and v2 | | | TypeScript | unknown | No | v1 and v2 |

NodeLink

Install / Use

README