botkit-discord

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

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 (nummberRating.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

• Magic-8 Ball
• More to come...

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

Event	Description
ambient	a channel the bot is in has a new message
direct_message	the bot received a direct message from a user
direct_mention	the bot was addressed directly in a channel ("@bot hello")
mention	the bot was mentioned by someone in a message ("hello @bot")

Bot Activity Events

Event	Description
disconnect	Bot has disconnected or failed to login
ready	Bot 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"

API

For convenience the following methods from discord.js ibrary is available on the controller.api during specific contexts

• joinVoiceChannel
• leaveVoiceChannel

Embeds

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

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:

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.

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