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

1. Install Shoukaku using your favorite package manager.

   npm

   npm i shoukaku@3.4.2

   yarn

   yarn add shoukaku@3.4.2

   pnpm

   pnpm add shoukaku@3.4.2

   bun

   bun add shoukaku@3.4.2

2. Initialize the library using one of the connectors.

   Discord.JS

   const { Client } = require('discord.js');
   const { Shoukaku, Connectors } = require('shoukaku');
   const Nodes = [{
       name: 'Localhost',
       url: 'localhost:6969',
       auth: 'marin_kitagawa'
   }];
   const client = new Client();
   const shoukaku = new Shoukaku(new Connectors.DiscordJS(client), Nodes);
   // ALWAYS handle error, logging it will do
   shoukaku.on('error', (_, error) => console.error(error));
   client.login('token');
   // If you want shoukaku to be available on client, then bind it to it, here is one example of it
   client.shoukaku = shoukaku;

   Eris

   const { Client } = require('discord.js');
   const { Shoukaku, Connectors } = require('shoukaku');
   const Nodes = [{
       name: 'Localhost',
       url: 'localhost:6969',
       auth: 'marin_kitagawa'
   }];
   const client = new Client();
   const shoukaku = new Shoukaku(new Connectors.Eris(client), Nodes);
   // ALWAYS handle error, logging it will do
   shoukaku.on('error', (_, error) => console.error(error));
   client.login('token');
   // If you want shoukaku to be available on client, then bind it to it, here is one example of it
   client.shoukaku = shoukaku;

   Oceanic.JS

   const { Client } = require('discord.js');
   const { Shoukaku, Connectors } = require('shoukaku');
   const Nodes = [{
       name: 'Localhost',
       url: 'localhost:6969',
       auth: 'marin_kitagawa'
   }];
   const client = new Client();
   const shoukaku = new Shoukaku(new Connectors.OceanicJS(client), Nodes);
   // ALWAYS handle error, logging it will do
   shoukaku.on('error', (_, error) => console.error(error));
   client.login('token');
   // If you want shoukaku to be available on client, then bind it to it, here is one example of it
   client.shoukaku = shoukaku;

   Do not ever do this!

   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);
   });

Further reading

• Lavalink Docs