Getting Started

Shoukaku is a stable, powerful and updated wrapper around Lavalink. It is Discord library agnostic, and can add support for new Discord libraries using connectors.

Set up Shoukaku

Install Shoukaku using your favorite package manager.

npm i shipgirlproject/Shoukaku#master

yarn add shipgirlproject/Shoukaku#master

pnpm add shipgirlproject/Shoukaku#master

bun add shipgirlproject/Shoukaku#master

Import the library

import { Client } from "discord.js";
import { Shoukaku, Connectors } from "shoukaku";

const { Client } = require("discord.js");
const { Shoukaku, Connectors } = require("shoukaku");

Configure nodes

const Nodes = [
    {
        name: "Localhost",
        url: "localhost:6969",
        auth: "re_aoharu", // password
    },
];

Initialize the library using one of the connectors.

const client = new Client();
const shoukaku = new Shoukaku(new Connectors.DiscordJS(client), Nodes);

const client = new Client();
const shoukaku = new Shoukaku(new Connectors.Eris(client), Nodes);

const client = new Client();
const shoukaku = new Shoukaku(new Connectors.OceanicJS(client), Nodes);

const client = new Client();
const shoukaku = new Shoukaku(new Connectors.Seyfert(client), Nodes);

Shoukaku will never initialized if you don’t start her before you call client.login()

client.on('ready', () => {
    client.shoukaku = new Shoukaku(new Connectors.DiscordJS(client), Nodes);
});

Handle error events

Always handle “error” events or your program may crash due to uncaught error
```
shoukaku.on("error", (_, error) => console.error(error));
```
Login to Discord
```
client.login("token");
```
Tip
If you want shoukaku to be available on client, then bind it to it
client.shoukaku = shoukaku;

Other Resources

Lavalink Docs
Example implementation using Discord.JS: Kongou
Get support on the Discord server
API Reference (TypeDoc)
API Reference (Starlight)