Riffy

Installation

npm install riffy

Features

Example Project

Documentation

Quick Start

Note

This project usesMessageContent intent, so make sure to enable it in your application settings.

Creating a Project

// For CommonJSconst{ Riffy}=require("riffy");// For ES6import{Riffy}from"riffy";

// index.jsconst{ Client, GatewayDispatchEvents}=require("discord.js");const{ Riffy}=require("riffy");constclient=newClient({intents:["Guilds","GuildMessages","GuildVoiceStates","GuildMessageReactions","MessageContent","DirectMessages",],});constnodes=[{host:"localhost",password:"youshallnotpass",port:2333,secure:false,},];client.riffy=newRiffy(client,nodes,{send:(payload)=>{constguild=client.guilds.cache.get(payload.d.guild_id);if(guild)guild.shard.send(payload);},defaultSearchPlatform:"ytmsearch",restVersion:"v4",// Or "v3" based on your Lavalink version.});client.on("ready",()=>{client.riffy.init(client.user.id);console.log(`Logged in as${client.user.tag}`);});client.on("messageCreate",async(message)=>{if(!message.content.startsWith("!")||message.author.bot)return;constargs=message.content.slice(1).trim().split(" ");constcommand=args.shift().toLowerCase();if(command==="play"){constquery=args.join(" ");// Create a player.constplayer=client.riffy.createConnection({guildId:message.guild.id,voiceChannel:message.member.voice.channel.id,textChannel:message.channel.id,deaf:true,});constresolve=awaitclient.riffy.resolve({query:query,requester:message.author,});const{ loadType, tracks, playlistInfo}=resolve;/**         * Important: If you are using Lavalink V3, here are the changes you need to make:         *         * 1. Replace "playlist" with "PLAYLIST_LOADED"         * 2. Replace "search" with "SEARCH_RESULT"         * 3. Replace "track" with "TRACK_LOADED"         */if(loadType==="playlist"){for(consttrackofresolve.tracks){track.info.requester=message.author;player.queue.add(track);}message.channel.send(`Added: \`${tracks.length} tracks\` from \`${playlistInfo.name}\``);if(!player.playing&&!player.paused)returnplayer.play();}elseif(loadType==="search"||loadType==="track"){consttrack=tracks.shift();track.info.requester=message.author;player.queue.add(track);message.channel.send(`Added: \`${track.info.title}\``);if(!player.playing&&!player.paused)returnplayer.play();}else{returnmessage.channel.send("There are no results found.");}}});// This will send log when the lavalink node is connected.client.riffy.on("nodeConnect",(node)=>{console.log(`Node "${node.name}" connected.`);});// This will send log when the lavalink node faced an error.client.riffy.on("nodeError",(node,error)=>{console.log(`Node "${node.name}" encountered an error:${error.message}.`);});// This is the event handler for track start.client.riffy.on("trackStart",async(player,track)=>{constchannel=client.channels.cache.get(player.textChannel);channel.send(`Now playing: \`${track.info.title}\` by \`${track.info.author}\`.`);});// This is the event handler for queue end.client.riffy.on("queueEnd",async(player)=>{constchannel=client.channels.cache.get(player.textChannel);// Set this to true if you want to enable autoplay.constautoplay=false;if(autoplay){player.autoplay(player);}else{player.destroy();channel.send("Queue has ended.");}});// This will update the voice state of the player.client.on("raw",(d)=>{if(![GatewayDispatchEvents.VoiceStateUpdate,GatewayDispatchEvents.VoiceServerUpdate,].includes(d.t))return;client.riffy.updateVoiceState(d);});client.login("Discord-Bot-Token-Here");

Running the Bot

# node.jsnode index.js# bunbun run index.js

Conclusion

Our Team

License