/[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 297 by rakin, Mon Jul 29 17:29:25 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,
82          legacyCommand: true          legacyCommand: true
83      },      },
84      {      {
85            name: 'avatarlookup',
86            shortBrief: "Lookup someone's avatar!",
87            description: "Lookup someone's avatar, using Google Image Search.\nThis command is a subcommand of the `/lookup` slash command.",
88            structure: "<UserID|Mention>",
89            example: "`%%avatarlookup 385753607325075320`\n`",
90            notes: null,
91            slashCommand: true,
92            legacyCommand: true
93        },
94        {
95          name: 'ban',          name: 'ban',
96          shortBrief: "Ban someone in this server.",          shortBrief: "Ban someone in this server.",
97          description: "Ban a user in this server.",          description: "Ban a user in this server.",
# Line 99  export default <CommandHelpData[]> [ Line 119  export default <CommandHelpData[]> [
119          legacyCommand: true          legacyCommand: true
120      },      },
121      {      {
         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  
     },  
     {  
122          name: 'cat',          name: 'cat',
123          shortBrief: "Get a random kitty picture.",          shortBrief: "Get a random kitty picture.",
124          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 139  export default <CommandHelpData[]> [
139          legacyCommand: true          legacyCommand: true
140      },      },
141      {      {
142            name: 'config',
143            shortBrief: "View or change the config options.",
144            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.",
145            structure: "<key> [value]",
146            example: "`%%config spam_filter.enabled false`\n`%%config prefix -`",
147            notes: null,
148            slashCommand: true,
149            legacyCommand: true
150        },
151        {
152          name: 'delqueue',          name: 'delqueue',
153          shortBrief: "Delete a queue job.",          shortBrief: "Delete a queue job.",
154          description: "Delete a queued command by its ID.",          description: "Delete a queued command by its ID.",
# Line 169  export default <CommandHelpData[]> [ Line 189  export default <CommandHelpData[]> [
189          legacyCommand: true          legacyCommand: true
190      },      },
191      {      {
192            name: 'embed',
193            shortBrief: "Build, send and make schemas of embeds!",
194            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.",
195            structure: "<subcommand> <...args>",
196            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\": []}`",
197            notes: null,
198            slashCommand: true,
199            legacyCommand: false
200        },
201        {
202          name: 'emoji',          name: 'emoji',
203          shortBrief: "Get info about an emoji. Must be guild (server) specific emoji.",          shortBrief: "Get info about an emoji. Must be guild (server) specific emoji.",
204          description: null,          description: null,
# Line 179  export default <CommandHelpData[]> [ Line 209  export default <CommandHelpData[]> [
209          legacyCommand: true          legacyCommand: true
210      },      },
211      {      {
212            name: 'eval',
213            shortBrief: "Execute raw Javascript code.\n*This command is owner-only*.",
214            description: null,
215            structure: "<code>",
216            example: "`%%eval console.log(\"Hello world!\")`",
217            notes: null,
218            slashCommand: true,
219            legacyCommand: true
220        },
221        {
222          name: 'expire',          name: 'expire',
223          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.",
224          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 239  export default <CommandHelpData[]> [
239          legacyCommand: true          legacyCommand: true
240      },      },
241      {      {
242            name: 'guildlookup',
243            shortBrief: "Lookup any Public Discord server/guild!",
244            description: "Lookup any Public Discord server/guild!\nThis command is a subcommand of the `/lookup` slash command.",
245            structure: "<UserID|Mention>",
246            example: "`%%guildlookup 385753607325075320`\n`",
247            notes: null,
248            slashCommand: true,
249            legacyCommand: true
250        },
251        {
252            name: 'hash',
253            shortBrief: "Generate a hash of the given text input.",
254            description: null,
255            structure: "<algorithm> <input>",
256            example: "`%%hash sha1 abc`",
257            notes: null,
258            slashCommand: true,
259            legacyCommand: true
260        },
261        {
262          name: 'help',          name: 'help',
263          shortBrief: "Show this help and exit.",          shortBrief: "Show this help and exit.",
264          description: null,          description: null,
# Line 262  export default <CommandHelpData[]> [ Line 322  export default <CommandHelpData[]> [
322          name: 'lock',          name: 'lock',
323          shortBrief: "Lock a specific channel.",          shortBrief: "Lock a specific channel.",
324          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.",
325          structure: "[ChannelID|ChannelMention] [...options]",          structure: "[ChannelID|ChannelMention]",
326          example: "`%%lock 385753607325075320`\n`%%lock #general`\n`%%lock`",          example: "`%%lock 385753607325075320`\n`%%lock #general`\n`%%lock`",
327          notes: null,          notes: null,
         options: {  
             "--no-send": "Do not send a confirmation message to the locked channel",  
         },  
328          slashCommand: true,          slashCommand: true,
329          legacyCommand: true          legacyCommand: true
330      },      },
331      {      {
332          name: 'lockall',          name: 'lockall',
333          shortBrief: "Lock all the channels given in the configuration.",          shortBrief: "Lock all given channels, in-bulk.",
334          description: "Makes the given channels read-only for the general members.",          description: "Makes the given channels read-only for the general members.",
335          structure: "<...ChannelMention|ChannelIDs> [--raid] [-r=ROLEMENTION|ROLEID]",          structure: "<...ChannelMention|ChannelIDs> [--raid]",
336          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`",
337          notes: null,          notes: null,
338          options: {          options: {
339              "--raid": "Lock all raid protected channels",              "--raid": "Lock all raid protected channels",
# Line 285  export default <CommandHelpData[]> [ Line 342  export default <CommandHelpData[]> [
342          legacyCommand: true          legacyCommand: true
343      },      },
344      {      {
345            name: 'lookup',
346            shortBrief: "Lookup something.",
347            description: null,
348            structure: "[ChannelID|ChannelMention]",
349            subcommands: {
350                "user": "Lookup a user around Discord",
351                "guild": "Lookup a Public Discord Server"
352            },
353            example: "`/lookup user user:384624924565405777`",
354            notes: null,
355            slashCommand: true,
356            legacyCommand: false
357        },
358        {
359          name: 'massban',          name: 'massban',
360          shortBrief: 'Mass ban (multiple) users',          shortBrief: 'Mass ban (multiple) users',
361          description: null,          description: null,
# Line 369  export default <CommandHelpData[]> [ Line 440  export default <CommandHelpData[]> [
440      },      },
441      {      {
442          name: 'profile',          name: 'profile',
443          shortBrief: 'Show server profile',          shortBrief: 'Show the server profile.',
444          description: null,          description: null,
445          structure: '[UserID|UserTag|UserMention]',          structure: '[UserID|UserTag|UserMention]',
446          example: '`%%profile`\n`%%profile @Someone`',          example: '`%%profile`\n`%%profile @Someone`',
# Line 428  export default <CommandHelpData[]> [ Line 499  export default <CommandHelpData[]> [
499          legacyCommand: true          legacyCommand: true
500      },      },
501      {      {
502            name: 'shot',
503            shortBrief: "Give a shot to a user.",
504            description: "Give a shot to a user. This command actually doesn't do anything.",
505            structure: "<UserID|UserTag|Mention> [Reason]",
506            example: "`%%shot 385753607325075320`\n`%%shot @Someone You are spamming a lot`",
507            notes: null,
508            slashCommand: true,
509            legacyCommand: true
510        },
511        {
512          name: 'softban',          name: 'softban',
513          shortBrief: "Softban a user.",          shortBrief: "Softban a user.",
514          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 562  export default <CommandHelpData[]> [
562          name: 'unlock',          name: 'unlock',
563          shortBrief: "Unlock a specific channel.",          shortBrief: "Unlock a specific channel.",
564          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.",
565          structure: "[ChannelID|ChannelMention] [...options]",          structure: "[ChannelID|ChannelMention]",
566          example: "`%%unlock 385753607325075320`\n`%%unlock #general`\n`%%unlock`",          example: "`%%unlock 385753607325075320`\n`%%unlock #general`\n`%%unlock`",
567          notes: null,          notes: null,
         options: {  
             "--no-send": "Do not send a confirmation message to the locked channel",  
         },  
568          slashCommand: true,          slashCommand: true,
569          legacyCommand: true          legacyCommand: true
570      },      },
571      {      {
572          name: 'unlockall',          name: 'unlockall',
573          shortBrief: "Unlock all the channels given in the configuration.",          shortBrief: "Unlock all given channels, in bulk.",
574          description: "<...ChannelMention|ChannelIDs> [--raid] [-r=ROLEMENTION|ROLEID]",          description: "<...ChannelMention|ChannelIDs> [--raid]",
575          structure: "[...options]",          structure: "[...options]",
576          example: "`%%unlockall --raid\n`%%unlockall 348764381911364631 634894637314679163795`",          example: "`%%unlockall --raid\n`%%unlockall 348764381911364631 634894637314679163795`",
577          notes: null,          notes: null,
# Line 514  export default <CommandHelpData[]> [ Line 592  export default <CommandHelpData[]> [
592          legacyCommand: true          legacyCommand: true
593      },      },
594      {      {
595            name: 'userlookup',
596            shortBrief: "Lookup any Discord user!",
597            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.",
598            structure: "<UserID|Mention>",
599            example: "`%%userlookup 385753607325075320`\n`",
600            notes: null,
601            slashCommand: true,
602            legacyCommand: true
603        },
604        {
605          name: 'warn',          name: 'warn',
606          shortBrief: "Warn someone in this server.",          shortBrief: "Warn someone in this server.",
607          description: null,          description: null,
# Line 539  export default <CommandHelpData[]> [ Line 627  export default <CommandHelpData[]> [
627              "view": "View information about a warning by ID"              "view": "View information about a warning by ID"
628          }          }
629      },      },
630        {
631            name: 'welcomer',
632            shortBrief: "Configure the welcomer.",
633            description: "Change the settings of the welcomer.",
634            structure: "<option(s)> [...args]",
635            example: "`%%welcomer --enable`",
636            notes: null,
637            slashCommand: false,
638            legacyCommand: true,
639            options: {
640                "--enable": "Enables the welcomer",
641                "--disable": "Disables the welcomer",
642                "--toggle": "Toggles the welcomer",
643                "--msg, --message, --custom": "Set custom welcome message. The welcome message as an argument is required.",
644                "--rm-msg, --remove-message": "Remove the custom welcome message.",
645                "--rand, --randomize": "Toggle random welcome messages.",
646                "--preview": "Preview the welcome message embed.",
647            }
648        },
649  ]  ]
Legend:
Removed from v.107  
changed lines
  Added in v.297
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26