/[sudobot]/trunk/src/utils/Help.ts
ViewVC logotype

Annotation of /trunk/src/utils/Help.ts

Parent Directory Parent Directory | Revision Log Revision Log


Revision 295 - (hide annotations)
Mon Jul 29 17:29:24 2024 UTC (8 months, 1 week ago) by rakin
File MIME type: application/typescript
File size: 22889 byte(s)
feat: update help command
1 rakin 51 import { CommandHelpData } from "../types/CommandHelpData";
2 rakin 11
3 rakin 72 export default <CommandHelpData[]> [
4     {
5     name: 'about',
6     shortBrief: "Show information about the bot.",
7     description: null,
8     structure: "",
9     example: "`%%about`",
10     notes: null,
11     slashCommand: true,
12     legacyCommand: true
13     },
14     {
15     name: 'addqueue',
16     shortBrief: "Add a queue job.",
17     description: 'Adds a queued command to the bot\'s memory and after the given amount of time it gets executed.',
18     structure: "<time> <command>",
19     example: "`%%addqueue 15m echo Hello world`\n`%%addqueue 12h kick 875275828247255`",
20     notes: null,
21     slashCommand: false,
22     legacyCommand: true
23     },
24     {
25     name: 'addsnippet',
26     shortBrief: "Adds a snippet.",
27     description: null,
28     structure: "<Name> <Content>",
29     example: "`%%addsnippet roles There are 2 roles`\n`%%addsnippet roles There are 2 roles\nAdmin - Administrator\nMod - Moderator`",
30     notes: null,
31     slashCommand: true,
32     legacyCommand: true
33     },
34     {
35     name: 'afk',
36     shortBrief: "Keeps track of your mentions and tells other users that you're AFK.",
37     description: null,
38     structure: "[Reason]",
39     example: "`%%afk`\n`%%afk Having dinner`",
40     notes: null,
41     slashCommand: true,
42     legacyCommand: true
43     },
44     {
45     name: 'announce',
46     shortBrief: "Announce something in the given channel.",
47     description: "Announce something in the given channel. The channel should be set in the configuration.",
48     structure: "<Content>",
49     example: "`%%announce Hello there!\nWe've just finished our job!\n@everyone`",
50     notes: null,
51     slashCommand: true,
52     legacyCommand: true
53     },
54     {
55 rakin 272 name: 'antijoin',
56     shortBrief: "Enable the AntiJoin shield.",
57     description: "Enables the AntiJoin shield.\nWhile AntiJoin is active, users will not be able to join the server (they will be kicked). This is useful when handling a raid.",
58     structure: "",
59     example: "`%%antijoin",
60     notes: null,
61     slashCommand: true,
62     legacyCommand: true
63     },
64     {
65 rakin 107 name: 'appeal',
66     shortBrief: "Send a message to staff members about a punishment appeal.",
67     description: null,
68     structure: "",
69     example: "`%%appeal`",
70     notes: null,
71     slashCommand: true,
72     legacyCommand: false
73     },
74     {
75 rakin 72 name: 'avatar',
76     shortBrief: "Show someone's avatar.",
77     description: null,
78 rakin 273 structure: "[UserID|UserTag|Mention=CURRENT_USER]",
79 rakin 72 example: "`%%avatar 385753607325075320`\n`%%avatar`",
80     notes: null,
81     slashCommand: true,
82     legacyCommand: true
83     },
84     {
85     name: 'ban',
86     shortBrief: "Ban someone in this server.",
87     description: "Ban a user in this server.",
88     structure: "<UserID|UserTag|Mention> [-d=DAYS] [Reason]",
89     example: "`%%ban 385753607325075320`\n`%%ban @Someone You are spamming a lot`\n`%%ban @Someone -d 5`\n`%%ban 385753607325075320 -d 5 You are spamming a lot`",
90     notes: null,
91     options: {
92     "-d": "The number of days old messages to delete. It must be in range 0-7. An argument is required.",
93 rakin 47 },
94 rakin 72 slashCommand: true,
95     legacyCommand: true
96     },
97     {
98     name: 'ballot',
99     shortBrief: "Create/view a ballot (poll) message.",
100     description: null,
101     subcommands: {
102     "create": "Create a ballot message. Argument 1 should be the ballot message content.",
103     "view": "View a ballot message stats. Argument 1 should be the ballot ID."
104 rakin 47 },
105 rakin 72 structure: "<subcommand> <subcommand-arguments>",
106     example: "`%%ballot create What do you think guys?`\n`%%ballot view 15`",
107     notes: null,
108     slashCommand: true,
109     legacyCommand: true
110     },
111     {
112     name: 'cat',
113     shortBrief: "Get a random kitty picture.",
114     description: "Fetches a random cat picture from `thecatapi.com` API.",
115     structure: "",
116     example: "`%%cat`",
117     notes: null,
118     slashCommand: true,
119     legacyCommand: true
120     },
121     {
122     name: 'clear',
123     shortBrief: "Clear all messages from a user.",
124     description: "Clear all messages from a user, in the current channel. This might take a while.",
125     structure: "<UserID|UserTag|UserMention>",
126     example: "`%%clear 83474924191884727`\n`%%clear @Someone`",
127     notes: null,
128     slashCommand: true,
129     legacyCommand: true
130     },
131     {
132 rakin 272 name: 'config',
133     shortBrief: "View or change the config options.",
134     description: "Configure the bot settings. This command is for advanced users.\nIf the user only gives one argument (setting key), then the value of the setting key will be shown. Otherwise the setting key will be modified with the given parameters.",
135     structure: "<key> [value]",
136     example: "`%%config spam_filter.enabled false`\n`%%config prefix -`",
137     notes: null,
138     slashCommand: true,
139     legacyCommand: true
140     },
141     {
142 rakin 72 name: 'delqueue',
143     shortBrief: "Delete a queue job.",
144     description: "Delete a queued command by its ID.",
145     structure: "<QueueID>",
146     example: "`%%delqueue 80`",
147     notes: null,
148     slashCommand: false,
149     legacyCommand: true
150     },
151     {
152     name: 'delsnippet',
153     shortBrief: "Deletes a snippet.",
154     description: null,
155     structure: "<Name>",
156     example: "`%%delsnippet roles`",
157     notes: null,
158     slashCommand: true,
159     legacyCommand: true
160     },
161     {
162     name: 'dog',
163     shortBrief: "Get a random doggy picture.",
164     description: "Fetches a random cat picture from `thedogapi.com` API.",
165     structure: "",
166     example: "`%%dog`",
167     notes: null,
168     slashCommand: true,
169     legacyCommand: true
170     },
171     {
172     name: 'echo',
173     shortBrief: "Echo (re-send) a message.",
174     description: "Re-send a message from the bot.",
175     structure: "<content> [channelMention]",
176     example: "`%%echo Something\nVery Cool`\n`%%echo Something\nVery Cool #general`",
177     notes: null,
178     slashCommand: true,
179     legacyCommand: true
180     },
181     {
182 rakin 272 name: 'embed',
183     shortBrief: "Build, send and make schemas of embeds!",
184 rakin 273 description: "Build, send and make schemas of embeds. Schemas are special kind of text which can be used in various commands to represent an embed.\n\n**Subcommands**:\n\n`send` - Build and send an embed from the given input.\n`schema` - Builds an embed and returns back the JSON schema of the embed so that you can use it in other places!\n`build` - Builds an embed from a JSON schema.",
185 rakin 272 structure: "<subcommand> <...args>",
186     example: "`/embed send title:Hello world description:This is an embed, awesome!`\n`/embed schema title:Hello world description:This is an embed, awesome!`\n`/embed build json_schema:embed:{\"title\": \"Hello world\", \"description\": \"This is an embed, awesome!\", \"fields\": []}`",
187     notes: null,
188     slashCommand: true,
189     legacyCommand: false
190     },
191     {
192 rakin 72 name: 'emoji',
193     shortBrief: "Get info about an emoji. Must be guild (server) specific emoji.",
194     description: null,
195     structure: "<GuildEmoji|GuildEmojiName>",
196     example: "`%%emoji check`\n`%%emoji error`",
197     notes: null,
198     slashCommand: false,
199     legacyCommand: true
200     },
201     {
202 rakin 272 name: 'eval',
203     shortBrief: "Execute raw Javascript code.\n*This command is owner-only*.",
204     description: null,
205     structure: "<code>",
206     example: "`%%eval console.log(\"Hello world!\")`",
207     notes: null,
208     slashCommand: true,
209     legacyCommand: true
210     },
211     {
212 rakin 72 name: 'expire',
213     shortBrief: "Echo (re-send) a message and delete it after the given time.",
214     description: "Re-send a message from the bot and delete it automatically after the given time interval.",
215     structure: "<timeInterval> <content> [channelMention]",
216     example: "`%%echo 25m Something\nVery Cool`\n`%%echo 1h Something\nVery Cool #general`",
217     notes: null,
218     slashCommand: true,
219     legacyCommand: true
220     },
221     {
222     name: 'expiresc',
223     shortBrief: "Schedule a message and delete it after the given time.",
224     description: "Schedule a message from the bot and delete it automatically after the given time interval.",
225     structure: "<scheduleTimeInterval> <expireTimeInterval> <content> [channelMention]",
226     example: "`%%echo 25m 5h Something\nVery Cool`\n`%%echo 1h 7d Something\nVery Cool #general`",
227     notes: null,
228     slashCommand: true,
229     legacyCommand: true
230     },
231     {
232 rakin 295 name: 'guildlookup',
233     shortBrief: "Lookup any Public Discord server/guild!",
234     description: "Lookup any Public Discord server/guild!\nThis command is a subcommand of the `/lookup` slash command.",
235     structure: "<UserID|Mention>",
236     example: "`%%guildlookup 385753607325075320`\n`",
237     notes: null,
238     slashCommand: true,
239     legacyCommand: true
240     },
241     {
242 rakin 272 name: 'hash',
243     shortBrief: "Generate a hash of the given text input.",
244     description: null,
245     structure: "<algorithm> <input>",
246     example: "`%%hash sha1 abc`",
247     notes: null,
248     slashCommand: true,
249     legacyCommand: true
250     },
251     {
252 rakin 72 name: 'help',
253     shortBrief: "Show this help and exit.",
254     description: null,
255     structure: "[command]",
256     example: "`%%help`\n`%%help mute`",
257     notes: null,
258     slashCommand: true,
259     legacyCommand: true
260     },
261     {
262     name: 'history',
263     shortBrief: "Show moderation history for a user.",
264     description: null,
265     structure: "<UserMention|UserID>",
266     example: "`%%history 27372628277272625`\n`%%history @Someone`",
267     notes: null,
268     slashCommand: true,
269     legacyCommand: true
270     },
271     {
272     name: 'httpcat',
273     shortBrief: "Get some funny cat memes related to HTTP.",
274     description: "Get some funny cat memes related to HTTP status codes, using http.cat API.",
275     structure: "<status>",
276     example: "`%%httpcat 403`",
277     notes: null,
278     slashCommand: true,
279     legacyCommand: true
280     },
281     {
282     name: 'httpdog',
283     shortBrief: "Get some funny dog memes related to HTTP.",
284     description: "Get some funny dog memes related to HTTP status codes, using http.dog API.",
285     structure: "<status>",
286     example: "`%%httpdog 403`",
287     notes: null,
288     slashCommand: true,
289     legacyCommand: true
290     },
291     {
292     name: 'joke',
293     shortBrief: "Fetch a random joke from The Joke API.",
294     description: null,
295     structure: "",
296     example: "`%%joke`",
297     notes: null,
298     slashCommand: true,
299     legacyCommand: true
300     },
301     {
302     name: 'kick',
303     shortBrief: "Kick someone from this server.",
304     description: null,
305     structure: "<UserID|UserTag|Mention> [Reason]",
306     example: "`%%kick 385753607325075320`\n`%%kick @Someone You are spamming a lot`",
307     notes: null,
308     slashCommand: true,
309     legacyCommand: true
310     },
311     {
312     name: 'lock',
313     shortBrief: "Lock a specific channel.",
314     description: "Makes the given channel read-only for the general members. If no channel is present, the current channel will be locked.",
315 rakin 272 structure: "[ChannelID|ChannelMention]",
316 rakin 72 example: "`%%lock 385753607325075320`\n`%%lock #general`\n`%%lock`",
317     notes: null,
318     slashCommand: true,
319     legacyCommand: true
320     },
321     {
322     name: 'lockall',
323 rakin 272 shortBrief: "Lock all given channels, in-bulk.",
324 rakin 72 description: "Makes the given channels read-only for the general members.",
325 rakin 272 structure: "<...ChannelMention|ChannelIDs> [--raid]",
326     example: "`%%lockall 2572562578247841786\n`%%lockall 2572562578247841786 2572562578247841782 2572562578247841783`\n`%%lockall 2572562578247841786 2572562578247841785`",
327 rakin 72 notes: null,
328     options: {
329 rakin 107 "--raid": "Lock all raid protected channels",
330 rakin 30 },
331 rakin 72 slashCommand: true,
332     legacyCommand: true
333     },
334     {
335 rakin 295 name: 'lookup',
336     shortBrief: "Lookup something.",
337     description: null,
338     structure: "[ChannelID|ChannelMention]",
339     subcommands: {
340     "user": "Lookup a user around Discord",
341     "guild": "Lookup a Public Discord Server"
342     },
343     example: "`/lookup user user:384624924565405777`",
344     notes: null,
345     slashCommand: true,
346     legacyCommand: false
347     },
348     {
349 rakin 72 name: 'massban',
350     shortBrief: 'Mass ban (multiple) users',
351     description: null,
352     structure: '<...UserIDs|UserMentions> [Reason]',
353     example: '`%%massban 8247282727258725258 @someone Mass Banning`',
354     notes: null,
355     slashCommand: true,
356     legacyCommand: true
357     },
358     {
359     name: 'mute',
360     shortBrief: "Mute someone in this server.",
361     description: null,
362     structure: "<UserID|UserTag|Mention> [-t=DURATION] [Reason]",
363     example: "`%%mute 385753607325075320`\n`%%mute @Someone You are spamming a lot`\n`%%mute @Someone -t 10m You are spamming a lot`",
364     options: {
365     "-t": "Set the mute duration"
366 rakin 11 },
367 rakin 72 notes: null,
368     slashCommand: true,
369     legacyCommand: true
370     },
371     {
372     name: 'mvsnippet',
373     shortBrief: "Rename a snippet.",
374     description: null,
375     structure: "<oldName> <newName>",
376     example: "`%%mvsnippet abc bca`",
377     notes: null,
378     slashCommand: true,
379     legacyCommand: true
380     },
381     {
382     name: 'note',
383     shortBrief: "Take a note about an user.",
384     description: null,
385     structure: "<UserID|UserTag|UserMention> <note>",
386     example: "`%%note @Someone Simple note.`",
387     notes: null,
388     slashCommand: true,
389     legacyCommand: true
390     },
391     {
392     name: 'notedel',
393     shortBrief: "Delete a note.",
394     description: null,
395     structure: "<NoteID>",
396     example: "`%%notedel 922`",
397     notes: null,
398     slashCommand: true,
399     legacyCommand: true
400     },
401     {
402     name: 'noteget',
403     shortBrief: "Get a note.",
404     description: null,
405     structure: "<NoteID>",
406     example: "`%%noteget 922`",
407     notes: null,
408     slashCommand: true,
409     legacyCommand: true
410     },
411     {
412     name: 'notes',
413     shortBrief: "Get all notes for a specific user.",
414     description: null,
415     structure: "<UserID|UserTag|UserMention>",
416     example: "`%%notes @Someone`",
417     notes: null,
418     slashCommand: true,
419     legacyCommand: true
420     },
421     {
422     name: 'pixabay',
423     shortBrief: "Fetch images from Pixabay.",
424     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.",
425     structure: "<subcommand> [query]",
426     example: "`%%pixabay image`\n`%%pixabay photo birds`",
427     notes: null,
428     slashCommand: true,
429     legacyCommand: true
430     },
431     {
432     name: 'profile',
433 rakin 272 shortBrief: 'Show the server profile.',
434 rakin 72 description: null,
435     structure: '[UserID|UserTag|UserMention]',
436     example: '`%%profile`\n`%%profile @Someone`',
437     notes: null,
438     slashCommand: true,
439     legacyCommand: true
440     },
441     {
442     name: 'queues',
443     shortBrief: "Show a list of all queue jobs.",
444     description: null,
445     structure: "",
446     example: "`%%queues`",
447     notes: null,
448     slashCommand: true,
449     legacyCommand: true
450     },
451     {
452 rakin 107 name: 'rolelist',
453     shortBrief: 'List all roles in the server',
454     description: null,
455     structure: "[Page] [Role]",
456     example: "`%%rolelist`",
457     notes: null,
458     slashCommand: true,
459     legacyCommand: false
460     },
461     {
462 rakin 72 name: 'schedule',
463     shortBrief: "Echo (re-send) a message after the given time.",
464     description: "Re-send a message from the bot automatically after the given time interval.",
465     structure: "<timeInterval> <content> [channelMention]",
466     example: "`%%echo 25m Something\nVery Cool`\n`%%echo 1h Something\nVery Cool #general`",
467     notes: null,
468     slashCommand: true,
469     legacyCommand: true
470     },
471     {
472     name: 'send',
473     shortBrief: "Send a DM to a user.",
474     description: null,
475     structure: "<UserID|UserTag|Mention> <content>",
476     example: "`%%send 278358918549759428 Hello world`\n`%%send @Someone Hello world`",
477     notes: null,
478     slashCommand: true,
479     legacyCommand: true
480     },
481     {
482     name: 'setchperms',
483     shortBrief: "Set channel permissions in bulk.",
484     description: null,
485     structure: "<...ChannelIDs|ChannelMentions> <Role> <PermissionKey> <null|true|false>",
486     example: "`%%setchperms 827483719415287387 24872512882472142 #general @everyone SEND_MESSAGES false`",
487     notes: null,
488     slashCommand: true,
489     legacyCommand: true
490     },
491     {
492 rakin 272 name: 'shot',
493     shortBrief: "Give a shot to a user.",
494     description: "Give a shot to a user. This command actually doesn't do anything.",
495     structure: "<UserID|UserTag|Mention> [Reason]",
496     example: "`%%shot 385753607325075320`\n`%%shot @Someone You are spamming a lot`",
497     notes: null,
498     slashCommand: true,
499     legacyCommand: true
500     },
501     {
502 rakin 107 name: 'softban',
503     shortBrief: "Softban a user.",
504     description: "A softban means banning and unbanning a user immediately so that their messages gets deleted.",
505     structure: "<UserID|UserTag|UserMention> [-d=DAYS] [Reason]",
506     example: "`%%softban @Someone`\n`%%softban 44347362235774742 Hello world`",
507     notes: null,
508     slashCommand: true,
509     legacyCommand: true
510     },
511     {
512 rakin 72 name: 'stats',
513     shortBrief: "Show the server stats.",
514     description: null,
515     structure: "",
516     example: "`%%stats",
517     notes: null,
518     slashCommand: true,
519     legacyCommand: true
520     },
521     {
522     name: 'system',
523     shortBrief: "Show the system status.",
524     description: null,
525     structure: "",
526     example: "`%%system",
527     notes: null,
528     slashCommand: true,
529     legacyCommand: true
530     },
531     {
532 rakin 107 name: 'tempban',
533     shortBrief: "Temporarily ban a user.",
534     description: null,
535     structure: "<UserID|UserTag|UserMention> <Time> [-d=DAYS] [Reason]",
536     example: "`%%softban @Someone 20m`\n`%%softban 44347362235774742 50m Hello world`",
537     notes: null,
538     slashCommand: true,
539     legacyCommand: true
540     },
541     {
542 rakin 72 name: 'unban',
543     shortBrief: "Unban a user from this server.",
544     description: null,
545     structure: "<UserID>",
546     example: "`%%unban 2946255269594753792`",
547     notes: null,
548     slashCommand: true,
549     legacyCommand: true
550     },
551     {
552     name: 'unlock',
553     shortBrief: "Unlock a specific channel.",
554     description: "Makes the given channel writable for the general members. If no channel is present, the current channel is unlocked.",
555 rakin 272 structure: "[ChannelID|ChannelMention]",
556 rakin 72 example: "`%%unlock 385753607325075320`\n`%%unlock #general`\n`%%unlock`",
557     notes: null,
558     slashCommand: true,
559     legacyCommand: true
560     },
561     {
562     name: 'unlockall',
563 rakin 272 shortBrief: "Unlock all given channels, in bulk.",
564     description: "<...ChannelMention|ChannelIDs> [--raid]",
565 rakin 72 structure: "[...options]",
566 rakin 107 example: "`%%unlockall --raid\n`%%unlockall 348764381911364631 634894637314679163795`",
567 rakin 72 notes: null,
568     options: {
569 rakin 107 "--raid": "Unlock all Raid-protected channels"
570 rakin 11 },
571 rakin 72 slashCommand: true,
572     legacyCommand: true
573     },
574     {
575     name: 'unmute',
576     shortBrief: "Unmute someone in this server.",
577     description: null,
578     structure: "<UserID|UserTag|Mention>",
579     example: "`%%unmute 385753607325075320`\n`%%unmute @Someone You are spamming a lot`",
580     notes: null,
581     slashCommand: true,
582     legacyCommand: true
583     },
584     {
585 rakin 295 name: 'userlookup',
586     shortBrief: "Lookup any Discord user!",
587     description: "Lookup any Discord user! Doesn't matter if they are in the server or not.\nThis command is a subcommand of the `/lookup` slash command.",
588     structure: "<UserID|Mention>",
589     example: "`%%userlookup 385753607325075320`\n`",
590     notes: null,
591     slashCommand: true,
592     legacyCommand: true
593     },
594     {
595 rakin 72 name: 'warn',
596     shortBrief: "Warn someone in this server.",
597     description: null,
598     structure: "<UserID|UserTag|Mention> [Reason]",
599     example: "`%%warn 385753607325075320`\n`%%warn @Someone You are spamming a lot`",
600     notes: null,
601     slashCommand: true,
602     legacyCommand: true
603     },
604     {
605     name: 'warning',
606 rakin 107 shortBrief: "Operations with warnings.",
607 rakin 72 description: null,
608     structure: "<ID>",
609 rakin 107 example: "`%%warning list @Someone`\n`%%warning clear @Someone`\n`%%warning remove 24`\n`%%warning view 35`",
610 rakin 72 notes: null,
611     slashCommand: true,
612 rakin 107 legacyCommand: true,
613     subcommands: {
614     "list": "List all warnings for a user",
615     "clear": "Clear all warnings for a user",
616     "remove": "Remove a warning by ID",
617     "view": "View information about a warning by ID"
618     }
619 rakin 72 },
620 rakin 272 {
621     name: 'welcomer',
622     shortBrief: "Configure the welcomer.",
623     description: "Change the settings of the welcomer.",
624     structure: "<option(s)> [...args]",
625     example: "`%%welcomer --enable`",
626     notes: null,
627 rakin 279 slashCommand: false,
628 rakin 272 legacyCommand: true,
629     options: {
630     "--enable": "Enables the welcomer",
631     "--disable": "Disables the welcomer",
632     "--toggle": "Toggles the welcomer",
633     "--msg, --message, --custom": "Set custom welcome message. The welcome message as an argument is required.",
634     "--rm-msg, --remove-message": "Remove the custom welcome message.",
635     "--rand, --randomize": "Toggle random welcome messages.",
636     "--preview": "Preview the welcome message embed.",
637     }
638     },
639 rakin 72 ]

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26