trunk/commands/help.js

const { MessageActionRow, MessageButton } = require("discord.js");
const MessageEmbed = require("../src/MessageEmbed");
const { escapeRegex } = require("../src/util");

module.exports = {
    version: "1.1.0-beta1",
    commands: [
        {
            name: 'addsnippet',
            shortBrief: "Adds a snippet.",
            description: null,
            structure: "<Name> <Content>",
            example: "`%%addsnippet roles There are 2 roles`\n`%%addsnippet roles There are 2 roles\nAdmin - Administrator\nMod - Moderator`",
            notes: null
        },
        {
            name: 'announce',
            shortBrief: "Announce something in the given channel.",
            description: "Announce something in the given channel. The channel should be set in the configuration.",
            structure: "<Content>",
            example: "`%%announce Hello there!\nWe've just finished our job!\n@everyone`",
            notes: null
        },
        {
            name: 'ban',
            shortBrief: "Ban someone in this server.",
            description: null,
            structure: "<UserID|Mention> [Reason]",
            example: "`%%ban 385753607325075320`\n`%%ban @Someone You are spamming a lot`",
            notes: null
        },
        {
            name: 'bean',
            shortBrief: "Bean someone in this server.",
            description: "Bean someone. It doesn't do anything except pretending.",
            structure: "<UserID|Mention> [Reason]",
            example: "`%%bean 385753607325075320`\n`%%bean @Someone You are spamming a lot`",
            notes: null
        },
        {
            name: 'cat',
            shortBrief: "Get a random kitty picture.",
            description: "Fetches a random cat picture from `thecatapi.com` API.",
            structure: "",
            example: "`%%cat`",
            notes: null
        },
        {
            name: 'delsnippet',
            shortBrief: "Deletes a snippet.",
            description: null,
            structure: "<Name>",
            example: "`%%delsnippet roles`",
            notes: null
        },
        {
            name: 'dog',
            shortBrief: "Get a random doggy picture.",
            description: "Fetches a random cat picture from `thedogapi.com` API.",
            structure: "",
            example: "`%%dog`",
            notes: null
        },
        {
            name: 'echo',
            shortBrief: "Echo (re-send) a message.",
            description: "Re-send a message from the bot.",
            structure: "<content> [channelMention]",
            example: "`%%echo Something\nVery Cool`\n`%%echo Something\nVery Cool #general`",
            notes: null
        },
        {
            name: 'general-role',
            shortBrief: "Set the general role.",
            description: null,
            structure: "<RoleID|RoleMention>",
            example: "`%%general-role 937923625698638`\n`%%general-role @General`",
            notes: null
        },
        {
            name: 'help',
            shortBrief: "Show this help and exit.",
            description: null,
            structure: "[command]",
            example: "`%%help`\n`%%help mute`",
            notes: null
        },
        {
            name: 'httpcat',
            shortBrief: "Get some funny cat memes related to HTTP.",
            description: "Get some funny cat memes related to HTTP status codes, using http.cat API.",
            structure: "<status>",
            example: "`%%httpcat 403`",
            notes: null
        },
        {
            name: 'httpdog',
            shortBrief: "Get some funny dog memes related to HTTP.",
            description: "Get some funny dog memes related to HTTP status codes, using http.dog API.",
            structure: "<status>",
            example: "`%%httpdog 403`",
            notes: null
        },
        {
            name: 'kick',
            shortBrief: "Kick someone from this server.",
            description: null,
            structure: "<UserID|Mention> [Reason]",
            example: "`%%kick 385753607325075320`\n`%%kick @Someone You are spamming a lot`",
            notes: null
        },
        {
            name: 'lock',
            shortBrief: "Lock a specific channel.",
            description: "Makes the given channel read-only for the general members. If no channel is present, the current channel will be locked.",
            structure: "[ChannelID|ChannelMention] [...options]",
            example: "`%%lock 385753607325075320`\n`%%lock #general`\n`%%lock`",
            notes: null,
            options: {
                "--no-send": "Do not send a confirmation message to the locked channel",
                "--everyone": "Lock the channels for @everyone rather than the general role",
            }
        },
        {
            name: 'lockall',
            shortBrief: "Lock all the channels given in the configuration.",
            description: "Makes the given channels read-only for the general members.",
            structure: "[...options]",
            example: "`%%lockall --no-send\n`%%lockall`\n`%%lockall --everyone`",
            notes: null,
            options: {
                "--no-send": "Do not send a confirmation message to the locked channel",
                "--everyone": "Lock the channels for @everyone rather than the general role",
            }
        },
        {
            name: 'mod-role',
            shortBrief: "Set the moderator role.",
            description: null,
            structure: "<RoleID|RoleMention>",
            example: "`%%mod-role 937923625698638`\n`%%mod-role @Moderator`",
            notes: null
        },
        {
            name: 'mute',
            shortBrief: "Mute someone in this server.",
            description: null,
            structure: "<UserID|Mention> [-t=DURATION] [Reason]",
            example: "`%%mute 385753607325075320`\n`%%mute @Someone You are spamming a lot`\n`%%mute @Someone -t 10m You are spamming a lot`",
            options: {
                "-t": "Set the mute duration"
            },
            notes: null
        },
        {
            name: 'muted-role',
            shortBrief: "Set the muted role.",
            description: null,
            structure: "<RoleID|RoleMention>",
            example: "`%%muted-role 937923625698638`\n`%%muted-role @Muted`",
            notes: null
        },
        {
            name: 'mvsnippet',
            shortBrief: "Rename a snippet.",
            description: null,
            structure: "<oldName> <newName>",
            example: "`%%mvsnippet abc bca`",
            notes: null
        },
        {
            name: 'note',
            shortBrief: "Take a note about an user.",
            description: null,
            structure: "<UserID|UserMention> <note>",
            example: "`%%note @Someone Simple note.`",
            notes: null
        },
        {
            name: 'notedel',
            shortBrief: "Delete a note.",
            description: null,
            structure: "<NoteID>",
            example: "`%%notedel 922`",
            notes: null
        },
        {
            name: 'noteget',
            shortBrief: "Get a note.",
            description: null,
            structure: "<NoteID>",
            example: "`%%noteget 922`",
            notes: null
        },
        {
            name: 'notes',
            shortBrief: "Get all notes for a specific user.",
            description: null,
            structure: "<UserID|UserMention>",
            example: "`%%notes @Someone`",
            notes: null
        },
        {
            name: 'pixabay',
            shortBrief: "Fetch images from Pixabay.",
            description: "Search & fetch images from Pixabay API.\n\nAvailable Subcommands:\n\tphoto - Fetch photos only.\n\tvector - Fetch vectors only.\n\tillustration - Fetch illustrations only\n\timage - Fetch any image.",
            structure: "<subcommand> [query]",
            example: "`%%pixabay image`\n`%%pixabay photo birds`",
            notes: null
        },
        {
            name: 'prefix',
            shortBrief: "Change the bot prefix.",
            description: null,
            structure: "<NewPrefix>",
            example: "`%%prefix -`",
            notes: null
        },
        {
            name: 'setconfig',
            shortBrief: "Change the bot configuration keys.",
            description: null,
            structure: "<key> <value>",
            example: "`%%setconfig debug true`",
            notes: null
        },
        {
            name: 'spamfilter',
            shortBrief: "Change the spam filter configuration keys.",
            description: null,
            structure: "<key> <value>",
            example: "`%%spamfilter include #general`",
            notes: null
        },
        {
            name: 'unban',
            shortBrief: "Unban a user from this server.",
            description: null,
            structure: "<UserID>",
            example: "`%%unban 2946255269594753792`",
            notes: null
        },
        {
            name: 'unlock',
            shortBrief: "Unlock a specific channel.",
            description: "Makes the given channel writable for the general members. If no channel is present, the current channel is unlocked.",
            structure: "[ChannelID|ChannelMention] [...options]",
            example: "`%%unlock 385753607325075320`\n`%%unlock #general`\n`%%unlock`",
            notes: null,
            options: {
                "--no-send": "Do not send a confirmation message to the locked channel",
                "--everyone": "Unlock the channels for @everyone rather than the general role",
            }
        },
        {
            name: 'unlockall',
            shortBrief: "Unlock all the channels given in the configuration.",
            description: "Makes the given channels writable for the general members.",
            structure: "[...options]",
            example: "`%%unlockall --no-send\n`%%unlockall`\n`%%unlockall --everyone`",
            notes: null,
            options: {
                "--no-send": "Do not send a confirmation message to the locked channel",
                "--everyone": "Lock the channels for @everyone rather than the general role",
                "--raid": "Unlock all Raid-locked channels"
            }
        },
        {
            name: 'unmute',
            shortBrief: "Unmute someone in this server.",
            description: null,
            structure: "<UserID|Mention>",
            example: "`%%unmute 385753607325075320`\n`%%unmute @Someone You are spamming a lot`",
            notes: null
        },
        {
            name: 'warn',
            shortBrief: "Warn someone in this server.",
            description: null,
            structure: "<UserID|Mention> [Reason]",
            example: "`%%warn 385753607325075320`\n`%%warn @Someone You are spamming a lot`",
            notes: null
        },
        {
            name: 'warndel',
            shortBrief: "Delete a warning.",
            description: null,
            structure: "<ID>",
            example: "`%%warndel 39`",
            notes: null
        },
        {
            name: 'warning',
            shortBrief: "Show a warning.",
            description: null,
            structure: "<ID>",
            example: "`%%warning 39`",
            notes: null
        },
        {
            name: 'warnings',
            shortBrief: "Show all warnings.",
            description: "Show all warnings in this server. Passing an user will only show their warnings.",
            structure: "[UserId|Mention]",
            example: "`%%warnings`\n`%%warnings 948489127957979253978538`",
            notes: null
        },
    ],
    async render() {
        let string = '';

        for (let cmd of this.commands) {
            string += `\n\n**${cmd.name}**\n${cmd.shortBrief}`;
        }

        return string;
    },
    async handle(msg, cm) {
        if (typeof cm.args[0] === 'undefined') {
            // await msg.reply({
            //     embeds: [
            //         new MessageEmbed()
            //         .setColor('#f14a60')
            //         .setDescription(`This command requires at least one argument.`)
            //     ]
            // });

            await msg.reply({
                embeds: [
                    new MessageEmbed()
                    .setDescription("The command list. Run `" + app.config.get('prefix') + "help <commandName>` for more information about a specific command.\n" + await this.render())
                    .setTitle('Help')
                ],
            });

            return;
        }

        const cmd = this.commands.find(c => c.name === cm.args[0]);

        if (!cmd) {
            await msg.reply({
                embeds: [
                    new MessageEmbed()
                    .setColor('#f14a60')
                    .setDescription(`Invalid command \`${cm.args[0]}\`.`)
                ]
            });

            return;
        }

        let fields = [
            {
                name: "Usage",
                value: `\`${app.config.get('prefix')}${cmd.name}\`` + (cmd.structure.trim() !== '' ? ` \`${cmd.structure}\`` : '')
            },
            {
                name: 'Examples',
                value: cmd.example.replace(/\%\%/g, app.config.get('prefix'))
            }
        ];

        if (cmd.options !== undefined) {
            let str = '';

            for (let opt in cmd.options)
                str += `\`${opt}\` - ${cmd.options[opt]}\n`;

            str = str.substring(0, str.length - 1);

            fields.push({
                name: 'Options',
                value: str
            });
        }

        if (cmd.notes !== null) {
            fields.push({
                name: "Notes",
                value: cmd.notes
            });
        }

        await msg.reply({
            embeds: [
                new MessageEmbed()
                .setTitle(`${app.config.get('prefix')}${cmd.name}`)
                .setDescription(cmd.description !== null ? cmd.description : cmd.shortBrief)
                .addFields(fields)
            ]
        });
    }
};
1	rakin	11	const { MessageActionRow, MessageButton } = require("discord.js");
2			const MessageEmbed = require("../src/MessageEmbed");
3			const { escapeRegex } = require("../src/util");
4
5			module.exports = {
6	rakin	24	version: "1.1.0-beta1",
7	rakin	11	commands: [
8			{
9			name: 'addsnippet',
10			shortBrief: "Adds a snippet.",
11			description: null,
12			structure: "<Name> <Content>",
13			example: "`%%addsnippet roles There are 2 roles`\n`%%addsnippet roles There are 2 roles\nAdmin - Administrator\nMod - Moderator`",
14			notes: null
15			},
16			{
17			name: 'announce',
18			shortBrief: "Announce something in the given channel.",
19			description: "Announce something in the given channel. The channel should be set in the configuration.",
20			structure: "<Content>",
21			example: "`%%announce Hello there!\nWe've just finished our job!\n@everyone`",
22			notes: null
23			},
24			{
25			name: 'ban',
26			shortBrief: "Ban someone in this server.",
27			description: null,
28			structure: "<UserID\|Mention> [Reason]",
29			example: "`%%ban 385753607325075320`\n`%%ban @Someone You are spamming a lot`",
30			notes: null
31			},
32			{
33			name: 'bean',
34			shortBrief: "Bean someone in this server.",
35			description: "Bean someone. It doesn't do anything except pretending.",
36			structure: "<UserID\|Mention> [Reason]",
37			example: "`%%bean 385753607325075320`\n`%%bean @Someone You are spamming a lot`",
38			notes: null
39			},
40			{
41			name: 'cat',
42			shortBrief: "Get a random kitty picture.",
43			description: "Fetches a random cat picture from `thecatapi.com` API.",
44			structure: "",
45			example: "`%%cat`",
46			notes: null
47			},
48			{
49			name: 'delsnippet',
50			shortBrief: "Deletes a snippet.",
51			description: null,
52			structure: "<Name>",
53			example: "`%%delsnippet roles`",
54			notes: null
55			},
56			{
57			name: 'dog',
58			shortBrief: "Get a random doggy picture.",
59			description: "Fetches a random cat picture from `thedogapi.com` API.",
60			structure: "",
61			example: "`%%dog`",
62			notes: null
63			},
64			{
65			name: 'echo',
66			shortBrief: "Echo (re-send) a message.",
67			description: "Re-send a message from the bot.",
68			structure: "<content> [channelMention]",
69			example: "`%%echo Something\nVery Cool`\n`%%echo Something\nVery Cool #general`",
70			notes: null
71			},
72			{
73			name: 'general-role',
74			shortBrief: "Set the general role.",
75			description: null,
76			structure: "<RoleID\|RoleMention>",
77			example: "`%%general-role 937923625698638`\n`%%general-role @General`",
78			notes: null
79			},
80			{
81			name: 'help',
82			shortBrief: "Show this help and exit.",
83			description: null,
84			structure: "[command]",
85			example: "`%%help`\n`%%help mute`",
86			notes: null
87			},
88			{
89			name: 'httpcat',
90			shortBrief: "Get some funny cat memes related to HTTP.",
91			description: "Get some funny cat memes related to HTTP status codes, using http.cat API.",
92			structure: "<status>",
93			example: "`%%httpcat 403`",
94			notes: null
95			},
96			{
97			name: 'httpdog',
98			shortBrief: "Get some funny dog memes related to HTTP.",
99			description: "Get some funny dog memes related to HTTP status codes, using http.dog API.",
100			structure: "<status>",
101			example: "`%%httpdog 403`",
102			notes: null
103			},
104			{
105			name: 'kick',
106			shortBrief: "Kick someone from this server.",
107			description: null,
108			structure: "<UserID\|Mention> [Reason]",
109			example: "`%%kick 385753607325075320`\n`%%kick @Someone You are spamming a lot`",
110			notes: null
111			},
112			{
113			name: 'lock',
114			shortBrief: "Lock a specific channel.",
115			description: "Makes the given channel read-only for the general members. If no channel is present, the current channel will be locked.",
116			structure: "[ChannelID\|ChannelMention] [...options]",
117			example: "`%%lock 385753607325075320`\n`%%lock #general`\n`%%lock`",
118			notes: null,
119			options: {
120			"--no-send": "Do not send a confirmation message to the locked channel",
121			"--everyone": "Lock the channels for @everyone rather than the general role",
122			}
123			},
124			{
125			name: 'lockall',
126			shortBrief: "Lock all the channels given in the configuration.",
127			description: "Makes the given channels read-only for the general members.",
128			structure: "[...options]",
129			example: "`%%lockall --no-send\n`%%lockall`\n`%%lockall --everyone`",
130			notes: null,
131			options: {
132			"--no-send": "Do not send a confirmation message to the locked channel",
133			"--everyone": "Lock the channels for @everyone rather than the general role",
134			}
135			},
136			{
137			name: 'mod-role',
138			shortBrief: "Set the moderator role.",
139			description: null,
140			structure: "<RoleID\|RoleMention>",
141			example: "`%%mod-role 937923625698638`\n`%%mod-role @Moderator`",
142			notes: null
143			},
144			{
145			name: 'mute',
146			shortBrief: "Mute someone in this server.",
147			description: null,
148			structure: "<UserID\|Mention> [-t=DURATION] [Reason]",
149			example: "`%%mute 385753607325075320`\n`%%mute @Someone You are spamming a lot`\n`%%mute @Someone -t 10m You are spamming a lot`",
150			options: {
151			"-t": "Set the mute duration"
152			},
153			notes: null
154			},
155			{
156			name: 'muted-role',
157			shortBrief: "Set the muted role.",
158			description: null,
159			structure: "<RoleID\|RoleMention>",
160			example: "`%%muted-role 937923625698638`\n`%%muted-role @Muted`",
161			notes: null
162			},
163			{
164			name: 'mvsnippet',
165			shortBrief: "Rename a snippet.",
166			description: null,
167			structure: "<oldName> <newName>",
168			example: "`%%mvsnippet abc bca`",
169			notes: null
170			},
171			{
172			name: 'note',
173			shortBrief: "Take a note about an user.",
174			description: null,
175			structure: "<UserID\|UserMention> <note>",
176			example: "`%%note @Someone Simple note.`",
177			notes: null
178			},
179			{
180			name: 'notedel',
181			shortBrief: "Delete a note.",
182			description: null,
183			structure: "<NoteID>",
184			example: "`%%notedel 922`",
185			notes: null
186			},
187			{
188			name: 'noteget',
189			shortBrief: "Get a note.",
190			description: null,
191			structure: "<NoteID>",
192			example: "`%%noteget 922`",
193			notes: null
194			},
195			{
196			name: 'notes',
197			shortBrief: "Get all notes for a specific user.",
198			description: null,
199			structure: "<UserID\|UserMention>",
200			example: "`%%notes @Someone`",
201			notes: null
202			},
203			{
204			name: 'pixabay',
205			shortBrief: "Fetch images from Pixabay.",
206			description: "Search & fetch images from Pixabay API.\n\nAvailable Subcommands:\n\tphoto - Fetch photos only.\n\tvector - Fetch vectors only.\n\tillustration - Fetch illustrations only\n\timage - Fetch any image.",
207			structure: "<subcommand> [query]",
208			example: "`%%pixabay image`\n`%%pixabay photo birds`",
209			notes: null
210			},
211			{
212			name: 'prefix',
213			shortBrief: "Change the bot prefix.",
214			description: null,
215			structure: "<NewPrefix>",
216			example: "`%%prefix -`",
217			notes: null
218			},
219			{
220			name: 'setconfig',
221			shortBrief: "Change the bot configuration keys.",
222			description: null,
223			structure: "<key> <value>",
224			example: "`%%setconfig debug true`",
225			notes: null
226			},
227			{
228			name: 'spamfilter',
229			shortBrief: "Change the spam filter configuration keys.",
230			description: null,
231			structure: "<key> <value>",
232			example: "`%%spamfilter include #general`",
233			notes: null
234			},
235			{
236			name: 'unban',
237			shortBrief: "Unban a user from this server.",
238			description: null,
239			structure: "<UserID>",
240			example: "`%%unban 2946255269594753792`",
241			notes: null
242			},
243			{
244			name: 'unlock',
245	rakin	16	shortBrief: "Unlock a specific channel.",
246	rakin	11	description: "Makes the given channel writable for the general members. If no channel is present, the current channel is unlocked.",
247			structure: "[ChannelID\|ChannelMention] [...options]",
248			example: "`%%unlock 385753607325075320`\n`%%unlock #general`\n`%%unlock`",
249			notes: null,
250			options: {
251			"--no-send": "Do not send a confirmation message to the locked channel",
252	rakin	16	"--everyone": "Unlock the channels for @everyone rather than the general role",
253	rakin	11	}
254			},
255			{
256			name: 'unlockall',
257			shortBrief: "Unlock all the channels given in the configuration.",
258			description: "Makes the given channels writable for the general members.",
259			structure: "[...options]",
260			example: "`%%unlockall --no-send\n`%%unlockall`\n`%%unlockall --everyone`",
261			notes: null,
262			options: {
263			"--no-send": "Do not send a confirmation message to the locked channel",
264			"--everyone": "Lock the channels for @everyone rather than the general role",
265	rakin	21	"--raid": "Unlock all Raid-locked channels"
266	rakin	11	}
267			},
268			{
269			name: 'unmute',
270	rakin	16	shortBrief: "Unmute someone in this server.",
271	rakin	11	description: null,
272			structure: "<UserID\|Mention>",
273			example: "`%%unmute 385753607325075320`\n`%%unmute @Someone You are spamming a lot`",
274			notes: null
275			},
276			{
277			name: 'warn',
278			shortBrief: "Warn someone in this server.",
279			description: null,
280			structure: "<UserID\|Mention> [Reason]",
281			example: "`%%warn 385753607325075320`\n`%%warn @Someone You are spamming a lot`",
282			notes: null
283			},
284			{
285			name: 'warndel',
286			shortBrief: "Delete a warning.",
287			description: null,
288			structure: "<ID>",
289			example: "`%%warndel 39`",
290			notes: null
291			},
292			{
293			name: 'warning',
294			shortBrief: "Show a warning.",
295			description: null,
296			structure: "<ID>",
297			example: "`%%warning 39`",
298			notes: null
299			},
300			{
301			name: 'warnings',
302			shortBrief: "Show all warnings.",
303			description: "Show all warnings in this server. Passing an user will only show their warnings.",
304			structure: "[UserId\|Mention]",
305			example: "`%%warnings`\n`%%warnings 948489127957979253978538`",
306			notes: null
307			},
308			],
309			async render() {
310			let string = '';
311
312			for (let cmd of this.commands) {
313			string += `\n\n${cmd.name}\n${cmd.shortBrief}`;
314			}
315
316			return string;
317			},
318			async handle(msg, cm) {
319			if (typeof cm.args[0] === 'undefined') {
320			// await msg.reply({
321			// embeds: [
322			// new MessageEmbed()
323			// .setColor('#f14a60')
324			// .setDescription(`This command requires at least one argument.`)
325			// ]
326			// });
327
328			await msg.reply({
329			embeds: [
330			new MessageEmbed()
331			.setDescription("The command list. Run `" + app.config.get('prefix') + "help <commandName>` for more information about a specific command.\n" + await this.render())
332			.setTitle('Help')
333			],
334			});
335
336			return;
337			}
338
339			const cmd = this.commands.find(c => c.name === cm.args[0]);
340
341			if (!cmd) {
342			await msg.reply({
343			embeds: [
344			new MessageEmbed()
345			.setColor('#f14a60')
346			.setDescription(`Invalid command \`${cm.args[0]}\`.`)
347			]
348			});
349
350			return;
351			}
352
353			let fields = [
354			{
355			name: "Usage",
356			value: `\`${app.config.get('prefix')}${cmd.name}\`` + (cmd.structure.trim() !== '' ? ` \`${cmd.structure}\`` : '')
357			},
358			{
359			name: 'Examples',
360			value: cmd.example.replace(/\%\%/g, app.config.get('prefix'))
361			}
362			];
363
364			if (cmd.options !== undefined) {
365			let str = '';
366
367			for (let opt in cmd.options)
368			str += `\`${opt}\` - ${cmd.options[opt]}\n`;
369
370			str = str.substring(0, str.length - 1);
371
372			fields.push({
373			name: 'Options',
374			value: str
375			});
376			}
377
378			if (cmd.notes !== null) {
379			fields.push({
380			name: "Notes",
381			value: cmd.notes
382			});
383			}
384
385			await msg.reply({
386			embeds: [
387			new MessageEmbed()
388			.setTitle(`${app.config.get('prefix')}${cmd.name}`)
389			.setDescription(cmd.description !== null ? cmd.description : cmd.shortBrief)
390			.addFields(fields)
391			]
392			});
393			}
394			};