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 is a node module used as a way of interfacing with Discord. It is a very useful module for creating bots.

Installation

Requires node 0.12+

npm install --save discord.js

If you don't need voice support:

npm install --save --no-optional discord.js

---

Example: ping-pong

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

var mybot = new Discord.Client();

mybot.on("message", function(message) {
	if(message.content === "ping") {
		mybot.reply(message, "pong");
    }
});

mybot.loginWithToken("token");
// If you still need to login with email and password, use mybot.login("email", "password");

---

Contributing

Feel free to contribute! Just clone the repo and edit the files in the src folder, not the lib folder.

Whenever you come to making a pull request, make sure it's to the indev branch and that you have built the lib files by running grunt --dev

---

Related Projects

A list of other Discord API libraries can be found here

---

Links

Documentation

GitHub

Wiki

Website

NPM

---

Contact

If you have an issue or want to know if a feature exists, read the documentation before contacting me about any issues! If it's badly/wrongly implemented, let me know!

If you would like to contact me, you can create an issue on the GitHub repo, e-mail me via the one available on my NPM profile.

Alternatively, you could just send a DM to hydrabolt in Discord API.