/[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 72 by rakin, Mon Jul 29 17:28:29 2024 UTC revision 279 by rakin, Mon Jul 29 17:29:20 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: 'hash',
233            shortBrief: "Generate a hash of the given text input.",
234            description: null,
235            structure: "<algorithm> <input>",
236            example: "`%%hash sha1 abc`",
237            notes: null,
238            slashCommand: true,
239            legacyCommand: true
240        },
241        {
242          name: 'help',          name: 'help',
243          shortBrief: "Show this help and exit.",          shortBrief: "Show this help and exit.",
244          description: null,          description: null,
# Line 252  export default <CommandHelpData[]> [ Line 302  export default <CommandHelpData[]> [
302          name: 'lock',          name: 'lock',
303          shortBrief: "Lock a specific channel.",          shortBrief: "Lock a specific channel.",
304          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.",
305          structure: "[ChannelID|ChannelMention] [...options]",          structure: "[ChannelID|ChannelMention]",
306          example: "`%%lock 385753607325075320`\n`%%lock #general`\n`%%lock`",          example: "`%%lock 385753607325075320`\n`%%lock #general`\n`%%lock`",
307          notes: null,          notes: null,
         options: {  
             "--no-send": "Do not send a confirmation message to the locked channel",  
         },  
308          slashCommand: true,          slashCommand: true,
309          legacyCommand: true          legacyCommand: true
310      },      },
311      {      {
312          name: 'lockall',          name: 'lockall',
313          shortBrief: "Lock all the channels given in the configuration.",          shortBrief: "Lock all given channels, in-bulk.",
314          description: "Makes the given channels read-only for the general members.",          description: "Makes the given channels read-only for the general members.",
315          structure: "[...options]",          structure: "<...ChannelMention|ChannelIDs> [--raid]",
316          example: "`%%lockall --no-send\n`%%lockall`\n`%%lockall --everyone`",          example: "`%%lockall 2572562578247841786\n`%%lockall 2572562578247841786 2572562578247841782 2572562578247841783`\n`%%lockall 2572562578247841786 2572562578247841785`",
317          notes: null,          notes: null,
318          options: {          options: {
319              "--no-send": "Do not send a confirmation message to the locked channel",              "--raid": "Lock all raid protected channels",
320          },          },
321          slashCommand: true,          slashCommand: true,
322          legacyCommand: true          legacyCommand: true
# Line 359  export default <CommandHelpData[]> [ Line 406  export default <CommandHelpData[]> [
406      },      },
407      {      {
408          name: 'profile',          name: 'profile',
409          shortBrief: 'Show server profile',          shortBrief: 'Show the server profile.',
410          description: null,          description: null,
411          structure: '[UserID|UserTag|UserMention]',          structure: '[UserID|UserTag|UserMention]',
412          example: '`%%profile`\n`%%profile @Someone`',          example: '`%%profile`\n`%%profile @Someone`',
# Line 378  export default <CommandHelpData[]> [ Line 425  export default <CommandHelpData[]> [
425          legacyCommand: true          legacyCommand: true
426      },      },
427      {      {
428            name: 'rolelist',
429            shortBrief: 'List all roles in the server',
430            description: null,
431            structure: "[Page] [Role]",
432            example: "`%%rolelist`",
433            notes: null,
434            slashCommand: true,
435            legacyCommand: false
436        },
437        {
438          name: 'schedule',          name: 'schedule',
439          shortBrief: "Echo (re-send) a message after the given time.",          shortBrief: "Echo (re-send) a message after the given time.",
440          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 465  export default <CommandHelpData[]> [
465          legacyCommand: true          legacyCommand: true
466      },      },
467      {      {
468            name: 'shot',
469            shortBrief: "Give a shot to a user.",
470            description: "Give a shot to a user. This command actually doesn't do anything.",
471            structure: "<UserID|UserTag|Mention> [Reason]",
472            example: "`%%shot 385753607325075320`\n`%%shot @Someone You are spamming a lot`",
473            notes: null,
474            slashCommand: true,
475            legacyCommand: true
476        },
477        {
478            name: 'softban',
479            shortBrief: "Softban a user.",
480            description: "A softban means banning and unbanning a user immediately so that their messages gets deleted.",
481            structure: "<UserID|UserTag|UserMention> [-d=DAYS] [Reason]",
482            example: "`%%softban @Someone`\n`%%softban 44347362235774742 Hello world`",
483            notes: null,
484            slashCommand: true,
485            legacyCommand: true
486        },
487        {
488          name: 'stats',          name: 'stats',
489          shortBrief: "Show the server stats.",          shortBrief: "Show the server stats.",
490          description: null,          description: null,
# Line 428  export default <CommandHelpData[]> [ Line 505  export default <CommandHelpData[]> [
505          legacyCommand: true          legacyCommand: true
506      },      },
507      {      {
508            name: 'tempban',
509            shortBrief: "Temporarily ban a user.",
510            description: null,
511            structure: "<UserID|UserTag|UserMention> <Time> [-d=DAYS] [Reason]",
512            example: "`%%softban @Someone 20m`\n`%%softban 44347362235774742 50m Hello world`",
513            notes: null,
514            slashCommand: true,
515            legacyCommand: true
516        },
517        {
518          name: 'unban',          name: 'unban',
519          shortBrief: "Unban a user from this server.",          shortBrief: "Unban a user from this server.",
520          description: null,          description: null,
# Line 441  export default <CommandHelpData[]> [ Line 528  export default <CommandHelpData[]> [
528          name: 'unlock',          name: 'unlock',
529          shortBrief: "Unlock a specific channel.",          shortBrief: "Unlock a specific channel.",
530          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.",
531          structure: "[ChannelID|ChannelMention] [...options]",          structure: "[ChannelID|ChannelMention]",
532          example: "`%%unlock 385753607325075320`\n`%%unlock #general`\n`%%unlock`",          example: "`%%unlock 385753607325075320`\n`%%unlock #general`\n`%%unlock`",
533          notes: null,          notes: null,
         options: {  
             "--no-send": "Do not send a confirmation message to the locked channel",  
         },  
534          slashCommand: true,          slashCommand: true,
535          legacyCommand: true          legacyCommand: true
536      },      },
537      {      {
538          name: 'unlockall',          name: 'unlockall',
539          shortBrief: "Unlock all the channels given in the configuration.",          shortBrief: "Unlock all given channels, in bulk.",
540          description: "Makes the given channels writable for the general members.",          description: "<...ChannelMention|ChannelIDs> [--raid]",
541          structure: "[...options]",          structure: "[...options]",
542          example: "`%%unlockall --no-send\n`%%unlockall`\n`%%unlockall --everyone`",          example: "`%%unlockall --raid\n`%%unlockall 348764381911364631 634894637314679163795`",
543          notes: null,          notes: null,
544          options: {          options: {
545              "--no-send": "Do not send a confirmation message to the locked channel",              "--raid": "Unlock all Raid-protected channels"
             "--raid": "Unlock all Raid-locked channels"  
546          },          },
547          slashCommand: true,          slashCommand: true,
548          legacyCommand: true          legacyCommand: true
# Line 485  export default <CommandHelpData[]> [ Line 568  export default <CommandHelpData[]> [
568          legacyCommand: true          legacyCommand: true
569      },      },
570      {      {
         name: 'warndel',  
         shortBrief: "Delete a warning.",  
         description: null,  
         structure: "<ID>",  
         example: "`%%warndel 39`",  
         notes: null,  
         slashCommand: true,  
         legacyCommand: true  
     },  
     {  
571          name: 'warning',          name: 'warning',
572          shortBrief: "Show a warning.",          shortBrief: "Operations with warnings.",
573          description: null,          description: null,
574          structure: "<ID>",          structure: "<ID>",
575          example: "`%%warning 39`",          example: "`%%warning list @Someone`\n`%%warning clear @Someone`\n`%%warning remove 24`\n`%%warning view 35`",
576          notes: null,          notes: null,
577          slashCommand: true,          slashCommand: true,
578          legacyCommand: true          legacyCommand: true,
579            subcommands: {
580                "list": "List all warnings for a user",
581                "clear": "Clear all warnings for a user",
582                "remove": "Remove a warning by ID",
583                "view": "View information about a warning by ID"
584            }
585      },      },
586      {      {
587          name: 'warnings',          name: 'welcomer',
588          shortBrief: "Show all warnings.",          shortBrief: "Configure the welcomer.",
589          description: "Show all warnings in this server. Passing an user will only show their warnings.",          description: "Change the settings of the welcomer.",
590          structure: "[UserId|UserTag|Mention]",          structure: "<option(s)> [...args]",
591          example: "`%%warnings`\n`%%warnings 948489127957979253978538`",          example: "`%%welcomer --enable`",
592          notes: null,          notes: null,
593          slashCommand: true,          slashCommand: false,
594          legacyCommand: true          legacyCommand: true,
595            options: {
596                "--enable": "Enables the welcomer",
597                "--disable": "Disables the welcomer",
598                "--toggle": "Toggles the welcomer",
599                "--msg, --message, --custom": "Set custom welcome message. The welcome message as an argument is required.",
600                "--rm-msg, --remove-message": "Remove the custom welcome message.",
601                "--rand, --randomize": "Toggle random welcome messages.",
602                "--preview": "Preview the welcome message embed.",
603            }
604      },      },
605  ]  ]
Legend:
Removed from v.72  
changed lines
  Added in v.279
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26