Sign inSign up

performanc/nodelink

By performanc

•Updated 19 days ago

Performant LavaLink alternative written with Node.Js

Image
Integration & delivery
Web servers
1

6.7K

performanc/nodelink repository overview

Performant LavaLink replacement written in Node.js.

⁠Features

  • Lightweight
  • Real-time audio processing
  • Direct source access
  • Anonymous by default

⁠Dependencies

⁠Installation

⁠1. Clone the repository
$ git clone https://github.com/PerformanC/NodeLink
$ cd NodeLink
⁠2. Install the dependencies
$ npm i
  • NOTE: If you to use pure JavaScript, replace sodium-native with libsodium-wrappers. Keep in mind that pure JavaScript will offer a worse performance.
$ npm start
⁠Using with Docker

For information on how to install NodeLink using Docker, see the NodeLink Docker guide⁠.

⁠Usage

NodeLink is compatible with most LavaLink clients, as it implements most of the LavaLink API. However, some clients may not be compatible with NodeLink, as it implements changes some behaviors and endpoints.

ClientPlatformv2 supported?NodeLink Features?NodeLink major version
Lavalink-Client⁠JVMYesNov1 and v2
Lavalink.kt⁠KotlinNoNov1
DisGoLink⁠GoYesNov1 and v2
Lavalink.py⁠PythonYesNov1 and v2
Mafic⁠PythonYesNov1 and v2
Wavelink⁠PythonYesNov1 and v2
Pomice⁠PythonYesNov1 and v2
Hikari-ongaku⁠PythonYesNov1 and v2
Moonlink.js⁠TypescriptYesPartialv1 and v2
Magmastream⁠TypescriptNoNov1
Lavacord⁠TypescriptYesNov1 and v2
Shoukaku⁠TypescriptYesNov1 and v2
Lavalink-Client⁠TypescriptNoNov1
FastLink⁠Node.jsYesYesv1 and v2
Rainlink⁠Node.jsYesYesv1 and v2
Riffy⁠Node.jsYesNov1 and v2
DisCatSharp⁠.NETYesNov1 and v2
Lavalink4NET⁠.NETYesNov1 and v2
Nomia⁠.NETYesNov1 and v2
CogLink⁠CYesNov1 and v2
Lavalink-rs⁠Rust, PythonYesNov1 and v2
nyxx_lavalink⁠DartNoNov1

⁠Documentation

NodeLink only documents the differences between LavaLink and NodeLink⁠. For the rest of the documentation, please refer to LavaLink's documentation⁠.

⁠Troubleshoot

⁠"Expected 200, received 403." error

In some regions like Europe, you may receive a 403 error when trying to connect to YouTube. The real reason is unknown, but The PerformanC team managed to create a proper workaround for this issue.

To fix this issue, you must login to your Google/YouTube account. The proccess of retrieving the neccessary information is explained in config.js⁠ file.

⁠Support

Any question or issue related to NodeLink or other PerformanC projects can be can be made in PerformanC's Discord server⁠.

For verified issues, please also create a GitHub issue for tracking the issue.

⁠Contributing & Code of Conduct

NodeLink follows the PerformanC's contribution guidelines⁠. It is necessary to follow the guidelines to contribute to NodeLink and other PerformanC projects.

⁠License

NodeLink is licensed under BSD 2-Clause License⁠. You can read more about it on Open Source Initiative⁠.

Tag summary

Content type

Image

Digest

sha256:e15a9ae33…

Size

113 MB

Last updated

19 days ago

docker pull performanc/nodelink