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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 51 - (hide annotations)
Mon Jul 29 17:28:23 2024 UTC (8 months, 1 week ago) by rakin
Original Path: trunk/src/utils/help.ts
File MIME type: application/typescript
File size: 15809 byte(s)
Release version 2.0
1 rakin 51 import { CommandHelpData } from "../types/CommandHelpData";
2 rakin 11
3 rakin 51 export default {
4     version: "2.0.0-beta1",
5     commands: <CommandHelpData[]> [
6 rakin 11 {
7 rakin 47 name: 'about',
8     shortBrief: "Show information about the bot.",
9     description: null,
10     structure: "",
11     example: "`%%about`",
12     notes: null
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     },
22     {
23 rakin 11 name: 'addsnippet',
24     shortBrief: "Adds a snippet.",
25     description: null,
26     structure: "<Name> <Content>",
27     example: "`%%addsnippet roles There are 2 roles`\n`%%addsnippet roles There are 2 roles\nAdmin - Administrator\nMod - Moderator`",
28     notes: null
29     },
30     {
31 rakin 30 name: 'afk',
32     shortBrief: "Keeps track of your mentions and tells other users that you're AFK.",
33     description: null,
34     structure: "[Reason]",
35     example: "`%%afk`\n`%%afk Having dinner`",
36     notes: null
37     },
38     {
39 rakin 11 name: 'announce',
40     shortBrief: "Announce something in the given channel.",
41     description: "Announce something in the given channel. The channel should be set in the configuration.",
42     structure: "<Content>",
43     example: "`%%announce Hello there!\nWe've just finished our job!\n@everyone`",
44     notes: null
45     },
46     {
47     name: 'ban',
48     shortBrief: "Ban someone in this server.",
49 rakin 49 description: "Ban a user in this server.",
50     structure: "<UserID|UserTag|Mention> [-d=DAYS] [Reason]",
51 rakin 37 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`",
52 rakin 49 notes: null,
53     options: {
54     "-d": "The number of days old messages to delete. It must be in range 0-7. An argument is required.",
55     }
56 rakin 11 },
57     {
58     name: 'bean',
59     shortBrief: "Bean someone in this server.",
60     description: "Bean someone. It doesn't do anything except pretending.",
61 rakin 49 structure: "<UserID|UserTag|Mention> [Reason]",
62 rakin 11 example: "`%%bean 385753607325075320`\n`%%bean @Someone You are spamming a lot`",
63     notes: null
64     },
65     {
66     name: 'cat',
67     shortBrief: "Get a random kitty picture.",
68     description: "Fetches a random cat picture from `thecatapi.com` API.",
69     structure: "",
70     example: "`%%cat`",
71     notes: null
72     },
73     {
74 rakin 26 name: 'clear',
75     shortBrief: "Clear all messages from a user.",
76     description: "Clear all messages from a user, in the current channel. This might take a while.",
77 rakin 49 structure: "<UserID|UserTag|UserMention>",
78 rakin 26 example: "`%%clear 83474924191884727`\n`%%clear @Someone`",
79     notes: null
80     },
81     {
82 rakin 48 name: 'delqueue',
83     shortBrief: "Delete a queue job.",
84     description: "Delete a queued command by its ID.",
85 rakin 47 structure: "<QueueID>",
86     example: "`%%delqueue 80`",
87     notes: null
88     },
89     {
90 rakin 11 name: 'delsnippet',
91     shortBrief: "Deletes a snippet.",
92     description: null,
93     structure: "<Name>",
94     example: "`%%delsnippet roles`",
95     notes: null
96     },
97     {
98     name: 'dog',
99     shortBrief: "Get a random doggy picture.",
100     description: "Fetches a random cat picture from `thedogapi.com` API.",
101     structure: "",
102     example: "`%%dog`",
103     notes: null
104     },
105     {
106     name: 'echo',
107     shortBrief: "Echo (re-send) a message.",
108     description: "Re-send a message from the bot.",
109     structure: "<content> [channelMention]",
110     example: "`%%echo Something\nVery Cool`\n`%%echo Something\nVery Cool #general`",
111     notes: null
112     },
113     {
114 rakin 45 name: 'expire',
115     shortBrief: "Echo (re-send) a message and delete it after the given time.",
116     description: "Re-send a message from the bot and delete it automatically after the given time interval.",
117     structure: "<timeInterval> <content> [channelMention]",
118     example: "`%%echo 25m Something\nVery Cool`\n`%%echo 1h Something\nVery Cool #general`",
119     notes: null
120     },
121     {
122     name: 'expiresc',
123     shortBrief: "Schedule a message and delete it after the given time.",
124     description: "Schedule a message from the bot and delete it automatically after the given time interval.",
125     structure: "<scheduleTimeInterval> <expireTimeInterval> <content> [channelMention]",
126     example: "`%%echo 25m 5h Something\nVery Cool`\n`%%echo 1h 7d Something\nVery Cool #general`",
127     notes: null
128     },
129     {
130 rakin 11 name: 'general-role',
131     shortBrief: "Set the general role.",
132     description: null,
133     structure: "<RoleID|RoleMention>",
134     example: "`%%general-role 937923625698638`\n`%%general-role @General`",
135     notes: null
136     },
137     {
138     name: 'help',
139     shortBrief: "Show this help and exit.",
140     description: null,
141     structure: "[command]",
142     example: "`%%help`\n`%%help mute`",
143     notes: null
144     },
145     {
146 rakin 26 name: 'history',
147     shortBrief: "Show moderation history for a user.",
148     description: null,
149     structure: "<UserMention|UserID>",
150     example: "`%%history 27372628277272625`\n`%%history @Someone`",
151     notes: null
152     },
153     {
154 rakin 11 name: 'httpcat',
155     shortBrief: "Get some funny cat memes related to HTTP.",
156     description: "Get some funny cat memes related to HTTP status codes, using http.cat API.",
157     structure: "<status>",
158     example: "`%%httpcat 403`",
159     notes: null
160     },
161     {
162     name: 'httpdog',
163     shortBrief: "Get some funny dog memes related to HTTP.",
164     description: "Get some funny dog memes related to HTTP status codes, using http.dog API.",
165     structure: "<status>",
166     example: "`%%httpdog 403`",
167     notes: null
168     },
169     {
170 rakin 49 name: 'joke',
171     shortBrief: "Fetch a random joke from The Joke API.",
172     description: null,
173     structure: "",
174     example: "`%%joke`",
175     notes: null
176     },
177     {
178 rakin 11 name: 'kick',
179     shortBrief: "Kick someone from this server.",
180     description: null,
181 rakin 49 structure: "<UserID|UserTag|Mention> [Reason]",
182 rakin 11 example: "`%%kick 385753607325075320`\n`%%kick @Someone You are spamming a lot`",
183     notes: null
184     },
185     {
186     name: 'lock',
187     shortBrief: "Lock a specific channel.",
188     description: "Makes the given channel read-only for the general members. If no channel is present, the current channel will be locked.",
189     structure: "[ChannelID|ChannelMention] [...options]",
190     example: "`%%lock 385753607325075320`\n`%%lock #general`\n`%%lock`",
191     notes: null,
192     options: {
193     "--no-send": "Do not send a confirmation message to the locked channel",
194     }
195     },
196     {
197     name: 'lockall',
198     shortBrief: "Lock all the channels given in the configuration.",
199     description: "Makes the given channels read-only for the general members.",
200     structure: "[...options]",
201     example: "`%%lockall --no-send\n`%%lockall`\n`%%lockall --everyone`",
202     notes: null,
203     options: {
204     "--no-send": "Do not send a confirmation message to the locked channel",
205     }
206     },
207     {
208     name: 'mod-role',
209     shortBrief: "Set the moderator role.",
210     description: null,
211     structure: "<RoleID|RoleMention>",
212     example: "`%%mod-role 937923625698638`\n`%%mod-role @Moderator`",
213     notes: null
214     },
215     {
216     name: 'mute',
217     shortBrief: "Mute someone in this server.",
218     description: null,
219 rakin 49 structure: "<UserID|UserTag|Mention> [-t=DURATION] [Reason]",
220 rakin 11 example: "`%%mute 385753607325075320`\n`%%mute @Someone You are spamming a lot`\n`%%mute @Someone -t 10m You are spamming a lot`",
221     options: {
222     "-t": "Set the mute duration"
223     },
224     notes: null
225     },
226     {
227     name: 'muted-role',
228     shortBrief: "Set the muted role.",
229     description: null,
230     structure: "<RoleID|RoleMention>",
231     example: "`%%muted-role 937923625698638`\n`%%muted-role @Muted`",
232     notes: null
233     },
234     {
235     name: 'mvsnippet',
236     shortBrief: "Rename a snippet.",
237     description: null,
238     structure: "<oldName> <newName>",
239     example: "`%%mvsnippet abc bca`",
240     notes: null
241     },
242     {
243     name: 'note',
244     shortBrief: "Take a note about an user.",
245     description: null,
246 rakin 49 structure: "<UserID|UserTag|UserMention> <note>",
247 rakin 11 example: "`%%note @Someone Simple note.`",
248     notes: null
249     },
250     {
251     name: 'notedel',
252     shortBrief: "Delete a note.",
253     description: null,
254     structure: "<NoteID>",
255     example: "`%%notedel 922`",
256     notes: null
257     },
258     {
259     name: 'noteget',
260     shortBrief: "Get a note.",
261     description: null,
262     structure: "<NoteID>",
263     example: "`%%noteget 922`",
264     notes: null
265     },
266     {
267     name: 'notes',
268     shortBrief: "Get all notes for a specific user.",
269     description: null,
270 rakin 49 structure: "<UserID|UserTag|UserMention>",
271 rakin 11 example: "`%%notes @Someone`",
272     notes: null
273     },
274     {
275     name: 'pixabay',
276     shortBrief: "Fetch images from Pixabay.",
277     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.",
278     structure: "<subcommand> [query]",
279     example: "`%%pixabay image`\n`%%pixabay photo birds`",
280     notes: null
281     },
282     {
283     name: 'prefix',
284     shortBrief: "Change the bot prefix.",
285     description: null,
286     structure: "<NewPrefix>",
287     example: "`%%prefix -`",
288     notes: null
289     },
290     {
291 rakin 49 name: 'queues',
292     shortBrief: "Show a list of all queue jobs.",
293     description: null,
294     structure: "",
295     example: "`%%queues`",
296     notes: null
297     },
298     {
299 rakin 45 name: 'schedule',
300     shortBrief: "Echo (re-send) a message after the given time.",
301     description: "Re-send a message from the bot automatically after the given time interval.",
302     structure: "<timeInterval> <content> [channelMention]",
303     example: "`%%echo 25m Something\nVery Cool`\n`%%echo 1h Something\nVery Cool #general`",
304     notes: null
305     },
306     {
307 rakin 11 name: 'setconfig',
308     shortBrief: "Change the bot configuration keys.",
309     description: null,
310     structure: "<key> <value>",
311     example: "`%%setconfig debug true`",
312     notes: null
313     },
314     {
315 rakin 27 name: 'send',
316     shortBrief: "Send a DM to a user.",
317     description: null,
318 rakin 49 structure: "<UserID|UserTag|Mention> <content>",
319 rakin 27 example: "`%%send 278358918549759428 Hello world`\n`%%send @Someone Hello world`",
320     notes: null
321     },
322     {
323 rakin 11 name: 'spamfilter',
324     shortBrief: "Change the spam filter configuration keys.",
325     description: null,
326     structure: "<key> <value>",
327     example: "`%%spamfilter include #general`",
328     notes: null
329     },
330     {
331 rakin 31 name: 'stats',
332     shortBrief: "Show the server stats.",
333     description: null,
334     structure: "",
335     example: "`%%stats",
336     notes: null
337     },
338     {
339 rakin 11 name: 'unban',
340     shortBrief: "Unban a user from this server.",
341     description: null,
342     structure: "<UserID>",
343     example: "`%%unban 2946255269594753792`",
344     notes: null
345     },
346     {
347     name: 'unlock',
348 rakin 16 shortBrief: "Unlock a specific channel.",
349 rakin 11 description: "Makes the given channel writable for the general members. If no channel is present, the current channel is unlocked.",
350     structure: "[ChannelID|ChannelMention] [...options]",
351     example: "`%%unlock 385753607325075320`\n`%%unlock #general`\n`%%unlock`",
352     notes: null,
353     options: {
354     "--no-send": "Do not send a confirmation message to the locked channel",
355     }
356     },
357     {
358     name: 'unlockall',
359     shortBrief: "Unlock all the channels given in the configuration.",
360     description: "Makes the given channels writable for the general members.",
361     structure: "[...options]",
362     example: "`%%unlockall --no-send\n`%%unlockall`\n`%%unlockall --everyone`",
363     notes: null,
364     options: {
365     "--no-send": "Do not send a confirmation message to the locked channel",
366 rakin 21 "--raid": "Unlock all Raid-locked channels"
367 rakin 11 }
368     },
369     {
370     name: 'unmute',
371 rakin 16 shortBrief: "Unmute someone in this server.",
372 rakin 11 description: null,
373 rakin 49 structure: "<UserID|UserTag|Mention>",
374 rakin 11 example: "`%%unmute 385753607325075320`\n`%%unmute @Someone You are spamming a lot`",
375     notes: null
376     },
377     {
378     name: 'warn',
379     shortBrief: "Warn someone in this server.",
380     description: null,
381 rakin 49 structure: "<UserID|UserTag|Mention> [Reason]",
382 rakin 11 example: "`%%warn 385753607325075320`\n`%%warn @Someone You are spamming a lot`",
383     notes: null
384     },
385     {
386     name: 'warndel',
387     shortBrief: "Delete a warning.",
388     description: null,
389     structure: "<ID>",
390     example: "`%%warndel 39`",
391     notes: null
392     },
393     {
394     name: 'warning',
395     shortBrief: "Show a warning.",
396     description: null,
397     structure: "<ID>",
398     example: "`%%warning 39`",
399     notes: null
400     },
401     {
402     name: 'warnings',
403     shortBrief: "Show all warnings.",
404     description: "Show all warnings in this server. Passing an user will only show their warnings.",
405 rakin 49 structure: "[UserId|UserTag|Mention]",
406 rakin 11 example: "`%%warnings`\n`%%warnings 948489127957979253978538`",
407     notes: null
408     },
409 rakin 51 ]
410     }

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26