DEV Community

Cover image for A Wonderful Ban Command For Your Discord.js Bot
Gilles Heinesch
Gilles Heinesch

Posted on • Originally published at Medium

A Wonderful Ban Command For Your Discord.js Bot

What is our goal with this new command?

Our goal is to program a good and well-developed ban command. It gives you and your moderators the possibility to ban a Discord server member via your bot with a specific reason. All ban details can be posted in a pre-defined Discord channel (Modlog).
What will the command look like when we are done?

?ban {@USER/UserID} {reason for the ban}

Examples:

  • ?ban @Monkeyyy11#0001 Spam
  • ?ban 238590234135101440 Spam

Let’s start with programming

First of all, we start with the basic setup of our new command.

const args = message.content.split(' ').slice(1); // All arguments behind the command name with the prefix
Enter fullscreen mode Exit fullscreen mode

With this line of code we get all the content behind the prefix with the commandname. In this case, everything behind ?ban.

Example: If you enter the command in a Discord channel ?ban @Monkeyyy11#0001 Spam , args will be @Monkeyyy11#0001 Spam.

const args = message.content.split(' ').slice(1); // All arguments behind the command name with the prefix
const user = message.mentions.users.first(); // returns the user object if an user mention exists
const banReason = args.slice(1).join(' '); // Reason of the ban (Everything behind the mention)
Enter fullscreen mode Exit fullscreen mode

In the second line of code we request the first mention of a Discord user from the message object. If there is an user mention, you will receive the user object of this Discord user.

In the next line we slice the ban reason from our arguments of the command (args in this case).

const args = message.content.split(' ').slice(1); // All arguments behind the command name with the prefix
const user = message.mentions.users.first(); // returns the user object if an user mention exists
const banReason = args.slice(1).join(' '); // Reason of the ban (Everything behind the mention)
// Check if an user mention exists in this message
if (!user) {
try {
// Check if a valid userID has been entered instead of a Discord user mention
if (!message.guild.members.get(args.slice(0, 1).join(' '))) throw new Error('Couldn\' get a Discord user with this userID!');
// If the client (bot) can get a user with this userID, it overwrites the current user variable to the user object that the client fetched
user = message.guild.members.get(args.slice(0, 1).join(' '));
user = user.user;
} catch (error) {
return message.reply('Couldn\' get a Discord user with this userID!');
}
}
Enter fullscreen mode Exit fullscreen mode

Here we have a very nice feature that allows your ban command to enter an userID of a Discord server member instead of mentioning him.

First we check if the message contains an user mention, if not; then check if a valid userID has been entered. If not; the client returns an error in form of a Discord channel message. If yes; the client overwrites the uservariable with the new user object.

const args = message.content.split(' ').slice(1); // All arguments behind the command name with the prefix
const user = message.mentions.users.first(); // returns the user object if an user mention exists
const banReason = args.slice(1).join(' '); // Reason of the ban (Everything behind the mention)
​
// Check if an user mention exists in this message
if (!user) {
try {
// Check if a valid userID has been entered instead of a Discord user mention
if (!message.guild.members.get(args.slice(0, 1).join(' '))) throw new Error('Couldn\' get a Discord user with this userID!');
// If the client (bot) can get a user with this userID, it overwrites the current user variable to the user object that the client fetched
user = message.guild.members.get(args.slice(0, 1).join(' '));
user = user.user;
} catch (error) {
return message.reply('Couldn\' get a Discord user with this userID!');
}
}
if (user === message.author) return message.channel.send('You can\'t ban yourself'); // Check if the user mention or the entered userID is the message author himsmelf
if (!reason) return message.reply('You forgot to enter a reason for this ban!'); // Check if a reason has been given by the message author
if (!message.guild.member(user).bannable) return message.reply('You can\'t ban this user because you the bot has not sufficient permissions!'); // Check if the user is bannable with the bot's permissions
Enter fullscreen mode Exit fullscreen mode

3 different checks have been added here before we continue with further code.

The first if, checks if the user variable is the same user object as the message author object.

The next code line checks if the message author hasn’t forgotten to enter a reason for the ban of the Discord user.

The last line that we’ve added, checks if the bot has even enough permissions to ban this Discord user because otherwise the following code that we will cover as next will not work.

const args = message.content.split(' ').slice(1); // All arguments behind the command name with the prefix
const user = message.mentions.users.first(); // returns the user object if an user mention exists
const banReason = args.slice(1).join(' '); // Reason of the ban (Everything behind the mention)
​
// Check if an user mention exists in this message
if (!user) {
try {
// Check if a valid userID has been entered instead of a Discord user mention
if (!message.guild.members.get(args.slice(0, 1).join(' '))) throw new Error('Couldn\' get a Discord user with this userID!');
// If the client (bot) can get a user with this userID, it overwrites the current user variable to the user object that the client fetched
user = message.guild.members.get(args.slice(0, 1).join(' '));
user = user.user;
} catch (error) {
return message.reply('Couldn\' get a Discord user with this userID!');
}
}
if (user === message.author) return message.channel.send('You can\'t ban yourself'); // Check if the user mention or the entered userID is the message author himsmelf
if (!reason) return message.reply('You forgot to enter a reason for this ban!'); // Check if a reason has been given by the message author
if (!message.guild.member(user).bannable) return message.reply('You can\'t ban this user because you the bot has not sufficient permissions!'); // Check if the user is bannable with the bot's permissions
​
await message.guild.ban(user) // Bans the user
​
const Discord = require('discord.js'); // We need Discord for our next RichEmbeds
const banConfirmationEmbed = new Discord.RichEmbed()
.setColor('RED')
.setDescription(`✅ ${user.tag} has been successfully banned!`);
message.channel.send({
embed: banConfirmationEmbed
}); // Sends a confirmation embed that the user has been successfully banned
Enter fullscreen mode Exit fullscreen mode

With the new code in line 24, we ban the Discord user from the current Discord server where we enter the bot command.

After this, we send a confirmation RichEmbed in the current channel where we entered our command to confirm that the user has been successfully banned.

const args = message.content.split(' ').slice(1); // All arguments behind the command name with the prefix
​
const user = message.mentions.users.first(); // returns the user object if an user mention exists
const banReason = args.slice(1).join(' '); // Reason of the ban (Everything behind the mention)
​
// Check if an user mention exists in this message
if (!user) {
try {
// Check if a valid userID has been entered instead of a Discord user mention
if (!message.guild.members.get(args.slice(0, 1).join(' '))) throw new Error('Couldn\' get a Discord user with this userID!');
// If the client (bot) can get a user with this userID, it overwrites the current user variable to the user object that the client fetched
user = message.guild.members.get(args.slice(0, 1).join(' '));
user = user.user;
} catch (error) {
return message.reply('Couldn\' get a Discord user with this userID!');
}
}
if (user === message.author) return message.channel.send('You can\'t ban yourself'); // Check if the user mention or the entered userID is the message author himsmelf
if (!reason) return message.reply('You forgot to enter a reason for this ban!'); // Check if a reason has been given by the message author
if (!message.guild.member(user).bannable) return message.reply('You can\'t ban this user because you the bot has not sufficient permissions!'); // Check if the user is bannable with the bot's permissions
​
await message.guild.ban(user) // Bans the user
​
const Discord = require('discord.js'); // We need Discord for our next RichEmbeds
const banConfirmationEmbed = new Discord.RichEmbed()
.setColor('RED')
.setDescription(`✅ ${user.tag} has been successfully banned!`);
message.channel.send({
embed: banConfirmationEmbed
}); // Sends a confirmation embed that the user has been successfully banned
​
​
const modlogChannelID = ''; // Discord channel ID where you want to have logged the details about the ban
if (modlogChannelID.length !== 0) {
if (!client.channels.get(modlogChannelID )) return undefined; // Check if the modlogChannelID is a real Discord server channel that really exists
​
const banConfirmationEmbedModlog = new Discord.RichEmbed()
.setAuthor(`Banned by **${msg.author.username}#${msg.author.discriminator}**`, msg.author.displayAvatarURL)
.setThumbnail(user.displayAvatarURL)
.setColor('RED')
.setTimestamp()
.setDescription(`**Action**: Ban
**User**: ${user.username}#${user.discriminator} (${user.id})
**Reason**: ${reason}`);
client.channels.get(modlogChannelID).send({
embed: banConfirmationEmbedModlog
}); // Sends the RichEmbed in the modlogchannel
}
Enter fullscreen mode Exit fullscreen mode

In the new code that we’ve added, we give your bot the possibility to modlog all details of the ban in a Discord channel of your choice.

Conclusion

I hope I could help you a little bit with your bot and the setup of your ban command. If you have any questions, just comment below!
Photo by Temple Cerulean on Unsplash
Photo by Temple Cerulean on Unsplash

Discussion (1)

Collapse
leowalk77 profile image
Léo Walk

Good morning and thank you very much for this great command. I'm from Brazil and a beginner in this incredible world of programming. As a matter of fact, I don't know anything. 😅

That's why I discovered your post, because I was looking for a ban command to add to my Bot. 😏

So far I've only added about three commands that are welcome, the one you shared with me and a third one that whenever I release new videos on my Youtube channel, it shares there on my server dedicated to old games. 😎

I had a bit of difficulty adding your code because I forgot to create a file named ban.js and add it to the commands folder. 😅

Before, I had inserted your command in Bot's root file and when I started it there on Replit site, it gave an error. But it was just removing your command from that file and creating one for it in JS format and inserting it in the Commands folder that it started working again. 🙏

Now it remains to be seen if the command will work. The only thing I added was my server ID, since in one of the final command lines there was a space for that. 😏