Laurentina

Laurentina is Audio Controller and Queue Wrapper for Shoukaku and Discord.js to Manage Music Playback.

© Arknights

Features

Audio controller and Queue Wrapper

• Play
• Search
• Add to queue
• Skip
• Pause
• Resume
• Stop
• Loop
• Shuffle
• Get Queue
• Clear Queue

Download

Get the latest package from NPM.

Version

1.0.5

Usage

• Binding Laurentina

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

const nodes = [
    {
        "name": "Node 1",
        "url": "localhost:2333",
        "auth": "the_unchained",
    }
];

const client = new Client({
    intents: [
        // ...
    ]
});

const shoukaku = new Shoukaku(new Connectors.DiscordJS(client), nodes);
const laurentina = new Laurentina(client, shoukaku, nodes);

// Bind shoukaku and laurentina to client
client.shoukaku = shoukaku;
client.laurentina = laurentina;

client.login("token");

• Play a song

let controller = client.laurentina.getController("guildID");

if (!controller) {
    controller = await client.laurentina.join(
        "guildID",
        "voiceChannelID", // Voice channel where the user connected
        "textChannelID", // Text channel where the command sent
    ),
}

const result = await controller.search("scsearch", "Gojimaji-P - おちゃめ機能");

if (!result?.length) return;

const track = result.shift();

await controller.play(track);

• Add to Queue (Auto)

let controller = client.laurentina.getController("guildID");

if (!controller) return;

const result = await controller.search("ytsearch", "Kobo Kanaeru - Entah");

if (!result?.length) return;

const track_one = result.shift();
const track_two = result.shift();

controller.play(track_one);

// Calling `play` multiple time will automatically add it to queue
controller.play(track_two);

• Add to Queue (Manual)

let controller = client.laurentina.getController("guildID");

if (!controller) return;

const result = await controller.search("ytsearch", "Roshidere - Kawaikute gomen");

if (!result?.length) return;

const track = result.shift();

controller.add(track);

• Skip

const controller = client.laurentina.getController("guildID");

if (!controller) return;

await controller.skip();

• Pause

const controller = client.laurentina.getController("guildID");

if (!controller) return;

controller.pause();

• Resume

const controller = client.laurentina.getController("guildID");

if (!controller) return;

controller.resume();

• Stop

const controller = client.laurentina.getController("guildID");

if (!controller) return;

controller.stop();

• Loop

const controller = client.laurentina.getController("guildID");

if (!controller) return;

const loopMode = controller.toggleLoop();

• Shuffle

const controller = client.laurentina.getController("guildID");

if (!controller) return;

const shuffleMode = controller.toggleShuffle();

• Get Queue

const controller = client.laurentina.getController("guildID");

if (!controller) return;

const queue = controller.getQueue();

• Clear Queue

const controller = client.laurentina.getController("guildID");

if (!controller) return;

controller.clearQueue();

Contributor

TEGRAXD - Tegar B. Suganda

License

MIT License

Copyright (c) 2024 TEGRAXD

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.