/[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 107 by rakin, Mon Jul 29 17:28:37 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',          name: 'appeal',
66          shortBrief: "Send a message to staff members about a punishment appeal.",          shortBrief: "Send a message to staff members about a punishment appeal.",
67          description: null,          description: null,
# Line 65  export default <CommandHelpData[]> [ Line 75  export default <CommandHelpData[]> [
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 99  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 129  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 169  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 179  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 199  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 262  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: "<...ChannelMention|ChannelIDs> [--raid] [-r=ROLEMENTION|ROLEID]",          structure: "<...ChannelMention|ChannelIDs> [--raid]",
326          example: "`%%lockall 2572562578247841786\n`%%lockall 2572562578247841786 2572562578247841782 2572562578247841783`\n`%%lockall 2572562578247841786 2572562578247841785 -r @General`",          example: "`%%lockall 2572562578247841786\n`%%lockall 2572562578247841786 2572562578247841782 2572562578247841783`\n`%%lockall 2572562578247841786 2572562578247841785`",
327          notes: null,          notes: null,
328          options: {          options: {
329              "--raid": "Lock all raid protected channels",              "--raid": "Lock all raid protected channels",
# Line 285  export default <CommandHelpData[]> [ Line 332  export default <CommandHelpData[]> [
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 369  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 428  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',          name: 'softban',
503          shortBrief: "Softban a user.",          shortBrief: "Softban a user.",
504          description: "A softban means banning and unbanning a user immediately so that their messages gets deleted.",          description: "A softban means banning and unbanning a user immediately so that their messages gets deleted.",
# Line 481  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: "<...ChannelMention|ChannelIDs> [--raid] [-r=ROLEMENTION|ROLEID]",          description: "<...ChannelMention|ChannelIDs> [--raid]",
565          structure: "[...options]",          structure: "[...options]",
566          example: "`%%unlockall --raid\n`%%unlockall 348764381911364631 634894637314679163795`",          example: "`%%unlockall --raid\n`%%unlockall 348764381911364631 634894637314679163795`",
567          notes: null,          notes: null,
# Line 514  export default <CommandHelpData[]> [ Line 582  export default <CommandHelpData[]> [
582          legacyCommand: true          legacyCommand: true
583      },      },
584      {      {
585            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          name: 'warn',          name: 'warn',
596          shortBrief: "Warn someone in this server.",          shortBrief: "Warn someone in this server.",
597          description: null,          description: null,
# Line 539  export default <CommandHelpData[]> [ Line 617  export default <CommandHelpData[]> [
617              "view": "View information about a warning by ID"              "view": "View information about a warning by ID"
618          }          }
619      },      },
620        {
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            slashCommand: false,
628            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.107  
changed lines
  Added in v.295
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26