Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

poru

Package Overview
Dependencies
Maintainers
1
Versions
48
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

poru

A stable and powerfull lavalink client around node.js

  • 3.7.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
294
increased by24.05%
Maintainers
1
Weekly downloads
 
Created
Source

Discord npm Github Stars GitHub issues Snyk Vulnerabilities for npm package NPM

Table of contents

Installation

// Using npm
npm install poru

// Using yarn
yarn add poru

About

To use you need a configured Lavalink instance.

  • Stable client
  • support typescript
  • 100% Compatible with Lavalink
  • Object-oriented
  • 100% Customizable
  • Easy to setup
  • Inbuilt Queue System
  • Inbuilt support for spotify,apple music and deezer

Implementation

Poru Music Example bot as guide for beginning.

Implementation Repo:

Note : Send pr to add your repo here

URLFeaturesAdditional Information
Poru MusicBasic exampleworks with latest djs version

Example usage basic bot

const { Client, GatewayIntentBits } = require("discord.js");
const { Poru } = require("poru");
const nodes = [
  {
    name: "main_node",
    host: "localhost",
    port: 8080,
    password: "iloveyou3000",
  },
];
const PoruOptions = {
  reconnectTime: 0,
  resumeKey: "MyPlayers",
  resumeTimeout: 60,
  defaultPlatform: "ytsearch",
};
const client = new Client({
  intents: [
    GatewayIntentBits.Guilds,
    GatewayIntentBits.GuildMessages,
    GatewayIntentBits.GuildVoiceStates,
    GatewayIntentBits.MessageContent,
  ],
});
client.poru = new Poru(client, nodes, PoruOptions);

client.poru.on("trackStart", (player, track) => {
  const channel = client.channels.cache.get(player.textChannel);
  return channel.send(`Now playing \`${track.title}\``);
});

client.on("ready", () => {
  console.log("Ready!");
  client.poru.init(client);
});

client.on("interactionCreate", async (interaction) => {
  if (!interaction.isChatInputCommand()) return;
  if (!interaction.member.voice.channel)
    return interaction.reply({
      content: `Please connect with voice channel `,
      ephemeral: true,
    });

  const track = interaction.options.getString("track");

  const res = await client.poru.resolve(track);

  if (res.loadType === "LOAD_FAILED") {
    return interaction.reply("Failed to load track.");
  } else if (res.loadType === "NO_MATCHES") {
    return interaction.reply("No source found!");
  }

  //create connection with discord voice channnel
  const player = client.poru.createConnection({
    guildId: interaction.guild.id,
    voiceChannel: interaction.member.voice.channelId,
    textChannel: interaction.channel.id,
    selfDeaf: true,
  });

  if (res.loadType === "PLAYLIST_LOADED") {
    for (const track of res.tracks) {
      track.info.requester = interaction.user;
      player.queue.add(track);
    }

    interaction.reply(
      `${res.playlistInfo.name} has been loaded with ${res.tracks.length}`
    );
  } else {
    const track = res.tracks[0];
    track.info.requester = interaction.user;
    player.queue.add(track);
    interacton.reply(`Queued Track \n \`${track.title}\``);
  }

  if (!player.isPlaying && player.isConnected) player.play();
});

client.login("TOKEN");

Need Help?

Feel free to join our discord server, Give us suggestions and advice about errors and new features. with ❤️ by Paras .

Keywords

FAQs

Package last updated on 25 Oct 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc