Custom Help Command

commands/util/help.js

@@ -0,0 +1,66 @@
+const { Command } = require('discord.js-commando');
+const { stripIndents } = require('common-tags');
+const { RichEmbed } = require('discord.js');
+
+module.exports = class HelpCommand extends Command {
+    constructor(client) {
+        super(client, {
+            name: 'help',
+            aliases: [
+                'commands'
+            ],
+            group: 'util',
+            memberName: 'help',
+            description: 'Displays a list of available commands, or detailed information for a specified command.',
+            guarded: true,
+            args: [
+                {
+                    key: 'command',
+                    prompt: 'Which command would you like to view the help for?',
+                    type: 'string',
+                    default: ''
+                }
+            ]
+        });
+    }
+
+    async run(msg, args) {
+        const { command } = args;
+        const commands = this.client.registry.findCommands(command, false, msg);
+        if (command) {
+            if (commands.length === 1) {
+                msg.say(stripIndents`
+                    __Command **${commands[0].name}**:__ *${commands[0].description}*
+                    ${commands[0].guildOnly ? 'Usable Only in Servers' : 'Usable in Server and DM'}
+                    **Format:** ${msg.anyUsage(`${commands[0].name}${commands[0].format ? ` ${commands[0].format}` : ''}`)}
+                    **Aliases:** ${commands[0].aliases.join(', ') || 'None'}
+                    **Group:** ${commands[0].group.name}
+                    ${commands[0].details || 'None'}
+                `);
+            } else if (commands.length > 1) {
+                msg.say('Multiple Commands Found. Please be more specific.');
+            } else {
+                msg.say(
+                    `Could not identify command. Use ${msg.usage(
+					    null, msg.channel.type === 'dm' ? null : undefined, msg.channel.type === 'dm' ? null : undefined
+					)} to view a list of commands you can use.`
+				);
+            }
+        } else {
+            const embed = new RichEmbed()
+                .setTitle(`Commands Available in ${msg.guild ? msg.guild.name : 'this DM'}`)
+                .setDescription(`Use ${this.usage('<command>', null, null)} to view detailed information about a specific command.`)
+                .setColor(0x00AE86);
+            for (const group of this.client.registry.groups.array()) {
+                embed.addField(group.name,
+                    group.commands.filter(c => c.isUsable(msg)).map(c => `\`${c.name}\``).join(', ') || 'None Available');
+            }
+            try {
+                await msg.author.send({embed});
+                return msg.say(':mailbox_with_mail: Send you a DM with information.');
+            } catch (err) {
+                return msg.say('Failed to send DM. You probably have DMs disabled.');
+            }
+        }
+    }
+};

index.js

@@ -32,7 +32,9 @@ client.registry
         ['roleplay', 'Roleplay']
     ])
     .registerDefaultGroups()
-    .registerDefaultCommands()
+    .registerDefaultCommands({
+        help: false
+    })
     .registerCommandsIn(path.join(__dirname, 'commands'));
     
 client.on('guildMemberAdd', (member) => {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "xiaobot",
-  "version": "17.2.3",
+  "version": "17.2.4",
   "description": "A Discord Bot",
   "main": "shardingmanager.js",
   "scripts": {