HELLOOOOOOOOOOO WORLD! 👋

Welcome to the NodeLink documentation!

If you are here, you are probably looking for an audio server that flows with your code. You want something that feels natural, something that you can tinker with, break, and fix again.

You are in the right place.

NodeLink was born from a simple desire: to understand and master every detail of an audio server. It is 100% Node.js, lightweight, modular, and built with passion.

NodeLink? Why though? Seriously, why?

We love the existing options. Truly. But sometimes, you just want to build in the language you speak every day.

We built NodeLink because we wanted a server that felt like home. We wanted to peek under the hood, see the gears turning, and understand the magic of audio processing without switching contexts.

The Real Truth

It's about control and knowledge.

You can go deeper into anything here. If you don't know how something works, go deep. Learn it. Imagine it. Search for it. Run after it. Find it.

If you don't seek knowledge, it won't just fall into your hands.

We built this so you can read the code, understand the stack traces, and realize that you can do anything. Don't let anyone tell you otherwise. The code is open. The door is open. Come in and build something amazing. 💙

Let's get you running

Enough talking, let's make some noise. NodeLink requires only Node.js, which runs on Linux, Windows, and macOS.

winget install OpenJS.NodeJS
winget install Git.Git

# Install Git
sudo apt update && sudo apt install git -y

# Install Node.js 22.x
curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash -
sudo apt-get install -y nodejs

brew install node
brew install git

git clone https://github.com/PerformanC/NodeLink.git
cd NodeLink

npm install

yarn install

pnpm install

bun install

cp config.default.js config.js
npm run start

Copy-Item config.default.js -Destination config.js
npm run start

copy config.default.js config.js
npm run start

Where to go next?