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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 73 by rakin, Mon Jul 29 17:28:29 2024 UTC revision 295 by rakin, Mon Jul 29 17:29:24 2024 UTC
# Line 52  export default <CommandHelpData[]> [ Line 52  export default <CommandHelpData[]> [
52          legacyCommand: true          legacyCommand: true
53      },      },
54      {      {
55            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            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          name: 'avatar',          name: 'avatar',
76          shortBrief: "Show someone's avatar.",          shortBrief: "Show someone's avatar.",
77          description: null,          description: null,
78          structure: "[UserID|UserTag|Mention]=CURRENT_USER",          structure: "[UserID|UserTag|Mention=CURRENT_USER]",
79          example: "`%%avatar 385753607325075320`\n`%%avatar`",          example: "`%%avatar 385753607325075320`\n`%%avatar`",
80          notes: null,          notes: null,
81          slashCommand: true,          slashCommand: true,
# Line 89  export default <CommandHelpData[]> [ Line 109  export default <CommandHelpData[]> [
109          legacyCommand: true          legacyCommand: true
110      },      },
111      {      {
         name: 'bean',  
         shortBrief: "Bean someone in this server.",  
         description: "Bean someone. It doesn't do anything except pretending.",  
         structure: "<UserID|UserTag|Mention> [Reason]",  
         example: "`%%bean 385753607325075320`\n`%%bean @Someone You are spamming a lot`",  
         notes: null,  
         slashCommand: true,  
         legacyCommand: true  
     },  
     {  
112          name: 'cat',          name: 'cat',
113          shortBrief: "Get a random kitty picture.",          shortBrief: "Get a random kitty picture.",
114          description: "Fetches a random cat picture from `thecatapi.com` API.",          description: "Fetches a random cat picture from `thecatapi.com` API.",
# Line 119  export default <CommandHelpData[]> [ Line 129  export default <CommandHelpData[]> [
129          legacyCommand: true          legacyCommand: true
130      },      },
131      {      {
132            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          name: 'delqueue',          name: 'delqueue',
143          shortBrief: "Delete a queue job.",          shortBrief: "Delete a queue job.",
144          description: "Delete a queued command by its ID.",          description: "Delete a queued command by its ID.",
# Line 159  export default <CommandHelpData[]> [ Line 179  export default <CommandHelpData[]> [
179          legacyCommand: true          legacyCommand: true
180      },      },
181      {      {
182            name: 'embed',
183            shortBrief: "Build, send and make schemas of embeds!",
184            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            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          name: 'emoji',          name: 'emoji',
193          shortBrief: "Get info about an emoji. Must be guild (server) specific emoji.",          shortBrief: "Get info about an emoji. Must be guild (server) specific emoji.",
194          description: null,          description: null,
# Line 169  export default <CommandHelpData[]> [ Line 199  export default <CommandHelpData[]> [
199          legacyCommand: true          legacyCommand: true
200      },      },
201      {      {
202            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          name: 'expire',          name: 'expire',
213          shortBrief: "Echo (re-send) a message and delete it after the given time.",          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.",          description: "Re-send a message from the bot and delete it automatically after the given time interval.",
# Line 189  export default <CommandHelpData[]> [ Line 229  export default <CommandHelpData[]> [
229          legacyCommand: true          legacyCommand: true
230      },      },
231      {      {
232            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            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          name: 'help',          name: 'help',
253          shortBrief: "Show this help and exit.",          shortBrief: "Show this help and exit.",
254          description: null,          description: null,
# Line 252  export default <CommandHelpData[]> [ Line 312  export default <CommandHelpData[]> [
312          name: 'lock',          name: 'lock',
313          shortBrief: "Lock a specific channel.",          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.",          description: "Makes the given channel read-only for the general members. If no channel is present, the current channel will be locked.",
315          structure: "[ChannelID|ChannelMention] [...options]",          structure: "[ChannelID|ChannelMention]",
316          example: "`%%lock 385753607325075320`\n`%%lock #general`\n`%%lock`",          example: "`%%lock 385753607325075320`\n`%%lock #general`\n`%%lock`",
317          notes: null,          notes: null,
         options: {  
             "--no-send": "Do not send a confirmation message to the locked channel",  
         },  
318          slashCommand: true,          slashCommand: true,
319          legacyCommand: true          legacyCommand: true
320      },      },
321      {      {
322          name: 'lockall',          name: 'lockall',
323          shortBrief: "Lock all the channels given in the configuration.",          shortBrief: "Lock all given channels, in-bulk.",
324          description: "Makes the given channels read-only for the general members.",          description: "Makes the given channels read-only for the general members.",
325          structure: "[...options]",          structure: "<...ChannelMention|ChannelIDs> [--raid]",
326          example: "`%%lockall --no-send\n`%%lockall`\n`%%lockall --everyone`",          example: "`%%lockall 2572562578247841786\n`%%lockall 2572562578247841786 2572562578247841782 2572562578247841783`\n`%%lockall 2572562578247841786 2572562578247841785`",
327          notes: null,          notes: null,
328          options: {          options: {
329              "--no-send": "Do not send a confirmation message to the locked channel",              "--raid": "Lock all raid protected channels",
330          },          },
331          slashCommand: true,          slashCommand: true,
332          legacyCommand: true          legacyCommand: true
333      },      },
334      {      {
335            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          name: 'massban',          name: 'massban',
350          shortBrief: 'Mass ban (multiple) users',          shortBrief: 'Mass ban (multiple) users',
351          description: null,          description: null,
# Line 359  export default <CommandHelpData[]> [ Line 430  export default <CommandHelpData[]> [
430      },      },
431      {      {
432          name: 'profile',          name: 'profile',
433          shortBrief: 'Show server profile',          shortBrief: 'Show the server profile.',
434          description: null,          description: null,
435          structure: '[UserID|UserTag|UserMention]',          structure: '[UserID|UserTag|UserMention]',
436          example: '`%%profile`\n`%%profile @Someone`',          example: '`%%profile`\n`%%profile @Someone`',
# Line 378  export default <CommandHelpData[]> [ Line 449  export default <CommandHelpData[]> [
449          legacyCommand: true          legacyCommand: true
450      },      },
451      {      {
452            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          name: 'schedule',          name: 'schedule',
463          shortBrief: "Echo (re-send) a message after the given time.",          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.",          description: "Re-send a message from the bot automatically after the given time interval.",
# Line 408  export default <CommandHelpData[]> [ Line 489  export default <CommandHelpData[]> [
489          legacyCommand: true          legacyCommand: true
490      },      },
491      {      {
492            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            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          name: 'stats',          name: 'stats',
513          shortBrief: "Show the server stats.",          shortBrief: "Show the server stats.",
514          description: null,          description: null,
# Line 428  export default <CommandHelpData[]> [ Line 529  export default <CommandHelpData[]> [
529          legacyCommand: true          legacyCommand: true
530      },      },
531      {      {
532            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          name: 'unban',          name: 'unban',
543          shortBrief: "Unban a user from this server.",          shortBrief: "Unban a user from this server.",
544          description: null,          description: null,
# Line 441  export default <CommandHelpData[]> [ Line 552  export default <CommandHelpData[]> [
552          name: 'unlock',          name: 'unlock',
553          shortBrief: "Unlock a specific channel.",          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.",          description: "Makes the given channel writable for the general members. If no channel is present, the current channel is unlocked.",
555          structure: "[ChannelID|ChannelMention] [...options]",          structure: "[ChannelID|ChannelMention]",
556          example: "`%%unlock 385753607325075320`\n`%%unlock #general`\n`%%unlock`",          example: "`%%unlock 385753607325075320`\n`%%unlock #general`\n`%%unlock`",
557          notes: null,          notes: null,
         options: {  
             "--no-send": "Do not send a confirmation message to the locked channel",  
         },  
558          slashCommand: true,          slashCommand: true,
559          legacyCommand: true          legacyCommand: true
560      },      },
561      {      {
562          name: 'unlockall',          name: 'unlockall',
563          shortBrief: "Unlock all the channels given in the configuration.",          shortBrief: "Unlock all given channels, in bulk.",
564          description: "Makes the given channels writable for the general members.",          description: "<...ChannelMention|ChannelIDs> [--raid]",
565          structure: "[...options]",          structure: "[...options]",
566          example: "`%%unlockall --no-send\n`%%unlockall`\n`%%unlockall --everyone`",          example: "`%%unlockall --raid\n`%%unlockall 348764381911364631 634894637314679163795`",
567          notes: null,          notes: null,
568          options: {          options: {
569              "--no-send": "Do not send a confirmation message to the locked channel",              "--raid": "Unlock all Raid-protected channels"
             "--raid": "Unlock all Raid-locked channels"  
570          },          },
571          slashCommand: true,          slashCommand: true,
572          legacyCommand: true          legacyCommand: true
# Line 475  export default <CommandHelpData[]> [ Line 582  export default <CommandHelpData[]> [
582          legacyCommand: true          legacyCommand: true
583      },      },
584      {      {
585          name: 'warn',          name: 'userlookup',
586          shortBrief: "Warn someone in this server.",          shortBrief: "Lookup any Discord user!",
587          description: null,          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|UserTag|Mention> [Reason]",          structure: "<UserID|Mention>",
589          example: "`%%warn 385753607325075320`\n`%%warn @Someone You are spamming a lot`",          example: "`%%userlookup 385753607325075320`\n`",
590          notes: null,          notes: null,
591          slashCommand: true,          slashCommand: true,
592          legacyCommand: true          legacyCommand: true
593      },      },
594      {      {
595          name: 'warndel',          name: 'warn',
596          shortBrief: "Delete a warning.",          shortBrief: "Warn someone in this server.",
597          description: null,          description: null,
598          structure: "<ID>",          structure: "<UserID|UserTag|Mention> [Reason]",
599          example: "`%%warndel 39`",          example: "`%%warn 385753607325075320`\n`%%warn @Someone You are spamming a lot`",
600          notes: null,          notes: null,
601          slashCommand: true,          slashCommand: true,
602          legacyCommand: true          legacyCommand: true
603      },      },
604      {      {
605          name: 'warning',          name: 'warning',
606          shortBrief: "Show a warning.",          shortBrief: "Operations with warnings.",
607          description: null,          description: null,
608          structure: "<ID>",          structure: "<ID>",
609          example: "`%%warning 39`",          example: "`%%warning list @Someone`\n`%%warning clear @Someone`\n`%%warning remove 24`\n`%%warning view 35`",
610          notes: null,          notes: null,
611          slashCommand: true,          slashCommand: true,
612          legacyCommand: true          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      },      },
620      {      {
621          name: 'warnings',          name: 'welcomer',
622          shortBrief: "Show all warnings.",          shortBrief: "Configure the welcomer.",
623          description: "Show all warnings in this server. Passing an user will only show their warnings.",          description: "Change the settings of the welcomer.",
624          structure: "[UserId|UserTag|Mention]",          structure: "<option(s)> [...args]",
625          example: "`%%warnings`\n`%%warnings 948489127957979253978538`",          example: "`%%welcomer --enable`",
626          notes: null,          notes: null,
627          slashCommand: true,          slashCommand: false,
628          legacyCommand: true          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  ]  ]
Legend:
Removed from v.73  
changed lines
  Added in v.295
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26