rexwu1104/lavalink

Standalone audio sending node based on Lavaplayer.

Lavalink

A standalone audio sending node based on Lavaplayer and JDA-Audio. Allows for sending audio without it ever reaching any of your shards.

Being used in production by FredBoat, Dyno, LewdBot, and more.

A basic example bot is available.

Features

• Powered by Lavaplayer
• Minimal CPU/memory footprint
• Twitch/YouTube stream support
• Event system
• Seeking
• Volume control
• REST API for resolving lavaplayer tracks (used for non-JVM clients)
• Statistics (good for load balancing)
• Basic authentication
• Prometheus metrics
• Docker images

Requirements

• Java 11* LTS or newer required.
• OpenJDK or Zulu running on Linux AMD64 is officially supported.

Support for Darwin (Mac), Windows AMD64, and Linux ARM (Raspberry Pi) is provided on a best-effort basis. This is dependent on Lavaplayer's native libraries.

Support for other JVMs is also best-effort. Periodic CPU utilization stats are prone not to work everywhere.

*Java 11 appears to have some issues with Discord's TLS 1.3. Java 14 has other undiagnosed HTTPS problems. Use Java 13. Docker images have been updated. See #258, #260

Changelog

Please see here

Versioning policy

• The public API ("API" in a very broad sense) of Lavalink can be categorized into two main domains:

  • Client Domain: The API exposed to clients, consisting of both the WebSocket protocol and any public HTTP endpoints
  • Server Domain: The server application with its runtime environment, its configuration, etc.

• A change that is breaking to one domain might not be breaking at all to another.

  Examples:

  • Removing an endpoint: This is a breaking change for the client domain but is not for running the server itself.
  • Upgrading the minimum Java version: This is a breaking change for the server domain, but client implementations couldn't care less about it.

Given the above, the following versioning pattern lends itself well to the Lavalink project:

api.major.minor.patch

• API: Bumped when breaking changes are committed to the client domain of Lavalink

  Examples: Removing an endpoint, altering the output of an endpoint in a non-backward-compatible manner

• Major: Bumped when breaking changes are committed to the Lavalink server domain

  Examples: Bumping the required Java version, altering the configuration in a non-backward-compatible manner

• Minor: New features in any domain

  Examples: New optional endpoint or opcode, additional configuration options, change of large subsystems or dependencies

• Patch: Bug fixes in any domain

Examples: Fixing a race condition, fixing unexpected exceptions, fixing output that is not according to specs, etc.

While major, minor and patch will do an optimum effort to adhere to Semantic Versioning, prepending it with an additional API version makes life easier for developers in two ways: It is a clear way for the Lavalink project to communicate the relevant breaking changes to client developers, and in return, client developers can use the API version to communicate to their users about the compatibility of their clients to the Lavalink server.

Client libraries:

• Lavalink-Client (JDA or generic, Java)
• Lavalink.kt (Kord, JDA, generic, Kotlin (Coroutines))
• Lavalink.py (discord.py, Python)
• Lavapy (discord.py, Python)
• pylava (discord.py, Python)
• playlink (Javascript/Typescript)
• SandySounds (JavaScript)
• Gorilink (JavaScript)
• eris-lavalink (eris, JavaScript)
• LavaClient (JavaScript)
• Shoukaku (discord.js, JavaScript)
• SpringLink (discord.js, JavaScript)
• erela.js (JavaScript)
• Lavacord (JavaScript)
• Lavacoffee (JavaScript)
• LavaJS (discord.js, JavaScript/TypeScript)
• @skyra/audio (discord.js, JavaScript/TypeScript)
• EvoLava (EvolveJS, Javascript/Typescript)
• SharpLink (Discord.Net, .NET)
• Victoria (Discord.NET, .NET)
• Lavalink.NET (.NET)
• DSharpPlus.Lavalink (DSharpPlus, .NET)
• Lavalink4NET (Discord.Net, DSharpPlus, .NET)
• gavalink (Go)
• waterlink (Go)
• Magma (discord.py, Python)
• WaveLink (discord.py, Python)
• Lavalink-rs (All tokio Libraries, Rust)
• lavasnek_rs (All asyncio Libraries, Python)
• Pomice (discord.py, Python)
• lavaplayer-py (All asyncio libs, Python)
• Or create your own

Server configuration

Download binaries from the CI server or the GitHub releases.

Put an application.yml file in your working directory. (Example here)

Run with java -jar Lavalink.jar

Docker images are available on the Docker Hub.