Installation

Requirements

• Node.js 18.17 or newer. Raya uses the built-in fetch.
• A Lavalink v4 server (or NodeLink). Lavalink v3 is not supported.
• A Discord bot with the Guilds and Guild Voice States intents.

Install the package

npm

npm install raya.js

pnpm

pnpm add raya.js

yarn

yarn add raya.js

bun

bun add raya.js

Raya works with both module systems:

ESM / TypeScript

import { Raya, Connectors } from 'raya.js';
// default import works too
import Raya from 'raya.js';

CommonJS

const { Raya, Connectors } = require('raya.js');

Set up Lavalink

1. Download Lavalink.jar from the Lavalink releases and install Java 17 or newer.

2. Create an application.yml next to it. Pick a strong password and add the plugins you need:

   application.yml

   server:
     port: 2333
   lavalink:
     server:
       password: "youshallnotpass"
     plugins:
       # YouTube support
       - dependency: "dev.lavalink.youtube:youtube-plugin:VERSION"
       # Spotify, Apple Music, Deezer and more
       - dependency: "com.github.topi314.lavasrc:lavasrc-plugin:VERSION"

3. Start it:

   java -jar Lavalink.jar

4. Use the same host, port and password in Raya’s nodes option.

Which sources work?

YouTube needs the youtube-source plugin. Spotify, Apple Music, Deezer, Yandex, Tidal, JioSaavn, VK and Qobuz need LavaSrc. SoundCloud and Bandcamp are built in. See Search and sources.

Next

Head to the quick start to play your first track.