discord.js

What is discord.js?

discord.js is a powerful Node.js module that allows you to interact with the Discord API very easily. It provides a comprehensive set of features to create bots and manage Discord servers.

What are discord.js's main functionalities?

Creating a Bot

This code demonstrates how to create a simple Discord bot using discord.js. The bot logs 'Ready!' to the console when it is successfully logged in and ready.

const { Client, GatewayIntentBits } = require('discord.js');
const client = new Client({ intents: [GatewayIntentBits.Guilds] });
client.once('ready', () => {
  console.log('Ready!');
});
client.login('your-token-goes-here');

Handling Messages

This code shows how to handle messages in a Discord server. When a user sends a message with the content '!ping', the bot responds with 'Pong!'.

client.on('messageCreate', message => {
  if (message.content === '!ping') {
    message.channel.send('Pong!');
  }
});

Managing Roles

This code demonstrates how to manage roles in a Discord server. When a user sends a message with the content '!addRole', the bot adds a role named 'NewRole' to the user.

client.on('messageCreate', async message => {
  if (message.content === '!addRole') {
    let role = message.guild.roles.cache.find(r => r.name === 'NewRole');
    if (role) {
      await message.member.roles.add(role);
      message.channel.send('Role added!');
    }
  }
});

Sending Embeds

This code shows how to send embedded messages in Discord. When a user sends a message with the content '!embed', the bot responds with a rich embed message.

const { MessageEmbed } = require('discord.js');
client.on('messageCreate', message => {
  if (message.content === '!embed') {
    const embed = new MessageEmbed()
      .setTitle('Sample Embed')
      .setDescription('This is an example of an embed message')
      .setColor(0xff0000);
    message.channel.send({ embeds: [embed] });
  }
});

Other packages similar to discord.js

eris

Eris is another powerful library for interacting with the Discord API. It is known for being lightweight and efficient, making it a good alternative to discord.js. However, it may have a steeper learning curve for beginners.

discord.io

discord.io is a small, lightweight library for interfacing with Discord. It is less feature-rich compared to discord.js and Eris, but it can be a good choice for simpler bots or for those who prefer a minimalistic approach.

README

discord.js

Discord.js is a node module that allows you to interface with the Discord API for creation of things such as bots or loggers.

The aim of this API is to make it really simple to start developing your bots. This API has server, channel and user tracking, as well as tools to make identification really simple.

For more information, click here.

Installation

npm install discord.js

Example usage

/*
 * A basic bot that shows how to connect to a Discord account,
 * how to listen to messages and how to send messages.
 *
 * This bot responds to every "ping" message with a "pong".
 */

var Discord = require( "discord.js" );

// Create the bot
var myBot = new Discord.Client();

// Login with an example email and password
myBot.login( "[e-mail]", "password1" );

// The "ready" event is triggered after the bot successfully connected to
// Discord and is ready to send messages.
myBot.on( "ready", function() {
	console.log( "Bot connected successfully." );
} );

// Add a listener to the "message" event, which triggers upon receiving
// any message
myBot.on( "message", function( message ) {
	// message.content accesses the content of the message as a string.
	// If it is equal to "ping", then the bot should respond with "pong".
	if ( message.content === "ping" ) {
		// Send a message ("pong") to the channel the message was sent in,
		// which is accessed by message.channel.
		this.sendMessage( message.channel, "pong" );
	}
} );

TODO

• Documentation
• Better error handling
• Being able to cache new servers and channels as well as ones that are deleted - this is currently only done when a bot is created