@mklabs/discord-li v1.0.0

discord-li

Little routing framework for discord bots

Usage

Install

npm install @mklabs/discord-li

Usage

// Load up the discord.js library
const Discord = require('discord.js');
const path    = require('path');

// Here we load the config.json file that contains our token and our prefix values.
// config.token contains the bot's token
// config.prefix contains the message prefix.
const config  = require('./config.json');

// This is your Discord client
const client = new Discord.Client();

// This is your router, it needs a client a config file (see gist) and an
// additional path to store your commands.
const router = require('discord-li')(client, config, path.join(__dirname, 'commands'));

client.on('ready', () => {
  console.log(`Bot has started, with ${client.users.size} users, in ${client.channels.size} channels of ${client.guilds.size} guilds.`);
  // Example of changing the bot's playing game to something useful. `client.user` is what the
  // docs refer to as the 'ClientUser'.
  client.user.setActivity(`Serving ${client.guilds.size} servers`);
});

client.on('guildCreate', guild => {
  // This event triggers when the bot joins a guild.
  console.log(`New guild joined: ${guild.name} (id: ${guild.id}). This guild has ${guild.memberCount} members!`);
  client.user.setActivity(`Serving ${client.guilds.size} servers`);
});

client.on('guildDelete', guild => {
  // this event triggers when the bot is removed from a guild.
  console.log(`I have been removed from: ${guild.name} (id: ${guild.id})`);
  client.user.setActivity(`Serving ${client.guilds.size} servers`);
});

client.on('message', router);

Then each command can live in its own file in lib/commands for instance, or wherever you like (third argument when creating the router).

// In lib/commands/ping.js
module.exports = async (client, message, command, args) => {
  // Calculates ping between sending a message and editing it, giving a nice round-trip latency.
  // The second ping is an average latency between the bot and the websocket server (one-way, not round-trip)
  const m = await message.channel.send('Ping?');
  m.edit(`Pong! Latency is ${m.createdTimestamp - message.createdTimestamp}ms. API Latency is ${Math.round(client.ping)}ms`);
};

Each command function should take (client, message, command, args) => {}

Where:

• client is the discord client
• message is the original message
• command is the actual command (ex: ping)
• args are every arguments after the command as an array

Thanks

• @eslachance for The Perfect Lil' Bot. Awesome starting point.

I strongly recommend to check above gist to see all the comments and examples in setting up your own little bot.

                                        \o/