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

botkit-discord

Package Overview
Dependencies
Maintainers
1
Versions
13
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

botkit-discord

A Botkit connector for Discord with support for text, voice, attachments, embedded messages, and more.

  • 0.1.2
  • npm
  • Socket score

Version published
Weekly downloads
34
decreased by-20.93%
Maintainers
1
Weekly downloads
 
Created
Source

botkit-discord

🤖👾 A Botkit connector for Discord with support for text, voice, attachments, embedded messages, and more.

This Botkit platform connector is intended to be used for Discord. Underneath the hood, this connector is utilizing discord.js. Currently the connector supports the following features:

  • Text: DM Channel, Group DM Channel, Guild Text Message
  • Voice: Audio Playback and Joining Audio Channels
  • Embedded Messages: Visually rich messages
  • File attachments: Attach files to be downloaded by receiver
  • Various Notifications: Presences, Guild Member Add/Remove/Update, Guild Role Changes, Channel Add/Delete/Create

Example Gif

Install

$ npm install botkit-discord

Basic Usage

const BotkitDiscord = require('botkit-discord');
const config = {
    token: '**' // Discord bot token
}

const discordBot = BotkitDiscord(config);

discordBot.hears('hello','direct_message',(bot, message) => {
    bot.reply(message, 'how goes there :)!');
});

discordBot.hears('.*', 'direct_mention', (bot, message) => {
    bot.reply(message, 'leave me to be please.');
});

Advance Usage

const BotkitDiscord = require('botkit-discord');
const config = {
    token: '**' // Discord bot token
}

// Let's join the user's voice channel if we recieve a "b!play"
// play a song and leave, get rating from user, and save result
// if no rating is stored, we can end convoersation
discordBot.hears('b!play', 'ambient', (bot, message) => {
	bot.api.joinVoiceChannel().then(connection => {
		dispatcher = connection.play('./music/funny.mp3')
		dispatcher.setVolume(0.5)
		dispatcher.on('finish', () => {
			bot.createConversation(message, (err, convo) => {
				convo.addQuestion('How would rate that from a scale of 0 to 5?', (response, convo) => {
					const numberRating = response.text.match(/[0-5]/g);
					if (numberRating.length < 1) {
						convo.say('Uhh... not a valid rating, try again later!');
						convo.next();
					}
					convo.say('Oh wow! Thanks for letting me know!');
					db.save(message.member.id, numberRating[0]);
					convo.next();
				});
			});
		})
		bot.api.leaveVoiceChannel();
	}).catch(err => {
		// If the user is not in a voice channel, tell them to join one
		bot.reply('Dude, you\'ll need to join a voice channel and try again');
	});
});

Example Projects

Refer to Botkit documentation to utilize all of the other Botkit features.

Events

When you want your bot to respond to particular events that may be relevant, you can use the .on method.

discordBot.on(EVENT_NAME, event => {
    // do stuff
});

Incoming Events

EventDescription
ambienta channel the bot is in has a new message
direct_messagethe bot received a direct message from a user
direct_mentionthe bot was addressed directly in a channel ("@bot hello")
mentionthe bot was mentioned by someone in a message ("hello @bot")

Bot Activity Events

EventDescription
disconnectBot has disconnected or failed to login
readyBot is connected

Discord.js Events

Along with standard events, all Discord.js events have been migrated for your use. Please refer to the docs for usage.

Server Greeting Referenced in Docs

discordBot.on('guildMemberAdd', member => {
  const channel = member.guild.channels.find(ch => ch.name === 'member-log');
  if (!channel) return;
  channel.send(`Welcome to the server, ${member}`);
});
  • "channelCreate"
  • "channelDelete"
  • "channelPinsUpdate"
  • "channelUpdate"
  • "clientUserGuildSettingsUpdate"
  • "clientUserSettingsUpdate"
  • "debug"
  • "disconnect"
  • "emojiCreate"
  • "emojiDelete"
  • "emojiUpdate"
  • "error"
  • "guildBanAdd"
  • "guildBanRemove"
  • "guildCreate"
  • "guildDelete"
  • "guildMemberAdd"
  • "guildMemberAvailable"
  • "guildMemberRemove"
  • "guildMembersChunk"
  • "guildMemberSpeaking"
  • "guildMemberUpdate"
  • "guildUnavailable"
  • "guildUpdate"
  • "message"
  • "messageDelete"
  • "messageDeleteBulk"
  • "messageReactionAdd"
  • "messageReactionRemove"
  • "messageReactionRemoveAll"
  • "messageUpdate"
  • "presenceUpdate"
  • "rateLimit"
  • "ready"
  • "reconnecting"
  • "resume"
  • "roleCreate"
  • "roleDelete"
  • "roleUpdate"
  • "typingStart"
  • "typingStop"
  • "userNoteUpdate"
  • "userUpdate"
  • "voiceStateUpdate"
  • "warn"

Audio/Voice Functionalities

This connector utilizes the built-in discord.js audio functionality, but requires additional steps to work properly:

  1. First install a desired audio enconder either node-opus or opusscript (discord.js recommends node-opus for performance reasons, but opusscript works for development purposes)
    • npm install node-opus
    • npm install opusscript
  2. Next install FFMPEG, you can choose any of the following methods:
    1. (Mac) Install through homebrew: brew update && brew install ffmpeg
    2. (Linux) Install through apt update && apt install ffmpeg
    3. (All) Download and install the binaries manually through the FFMPEG site

For convenience, you'll be able to use the voice functionality if the sender of the message is already in a voice channel. This will be available in the .api properties of the bot object passed as a parameter in the event handler.

  • joinVoiceChannel()
  • leaveVoiceChannel()

Example Usage:

discordBot.hears('!audio', 'ambient', (bot, message) => {
    if (!bot.api.joinVoiceChannel) {
       return bot.reply(message, 'I would if you were in a voice channel!');
    }

    bot.api.joinVoiceChannel().then(connection => {
        dispatcher = connection.play('./music/troll.mp3')
        dispatcher.setVolume(0.5)
     }).catch(err => {
        console.log(`Failed to play audio: ${err}`);
     });
})

Embeds

To use embeds, it's preferred to use the Discord.js RichEmbed builder, discordBot.RichEmbed().

image

discordBot.hears('!rpg', ['direct_message', 'ambient'], (bot, message) => {
	const embed = new discordBot.RichEmbed()
	embed.setAuthor(
		"Quick RPG Stats",
		"https://rpglink.com/icon/here"
	);

	embed.addField("Power Level 👊", "Equivalent to a Goblin Archer 🏹");
	embed.addField("Skills Acquired 🥕", "🏹 Archery, 🍳 Cooking");
	embed.setColor('GREEN');
	bot.reply(message, embed)
});

Atachments

It's recommended to use the attachment helper, discordBot.Attachment:

image

discordBot.hears('!file', ['direct_message', 'ambient'], (bot, message) => {
	const attachment = new discordBot.Attachment('./temp.js', "Awesome Script!")
	bot.reply(message, attachment)
});

License

Ⓒ MIT Brandon Him / brh55

Please let me know if you plan on forking or would like professional support. Open-source is a hobby, but it would be great as a full-time gig :)

This wouldn't be possible without all the tremendous effort and contributors behind discord.js.

Keywords

FAQs

Package last updated on 07 Jun 2019

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