|
1 | 1 | # Usage Guide |
| 2 | + |
2 | 3 | This document provides detailed instructions on how to use the Code Module Cop bot for managing Telegram groups. |
3 | 4 |
|
4 | 5 | ## Commands |
| 6 | + |
5 | 7 | ### General Commands |
6 | | -- /start: Start interacting with the bot and receive a welcome message. |
7 | | -- /help: Get assistance and see the list of available commands. |
8 | | -## Moderation Commands |
9 | | -- /warn [reason]: Issue a warning to a user. If a user accumulates three warnings, they will be automatically banned. |
10 | | -- /rmWarn: Removes warnings from users. |
11 | | -- /mute [time]: Mute a user for a specified duration. Time can be specified in minutes (m), hours (h), or indefinitely. |
12 | | -- /unMute: Unsilences users. |
13 | | -- /ban: Ban a user from the group permanently. |
14 | | -- /unBan: Removes users from the banned list. |
15 | | -- /purge: Deletes messages that have been replicated. |
16 | | -## Role Management Commands |
17 | | -- /approved: Grants users special permissions, such as using forbidden words and pinning messages. |
18 | | -- /unApproved: Revokes special permissions from users. |
19 | | -- /approvedList: Return All Approved user |
| 8 | +- **/start**: Start interacting with the bot. |
| 9 | +- **/help**: Get help and see the list of available commands. |
| 10 | +- **/commands**: List all commands of the bot. |
| 11 | +- **/date**: Get the current date and time. |
| 12 | +- **/joke**: Get a random joke. |
| 13 | +- **/viewsupportcontact**: View support contact details. |
| 14 | +- **/botinfo**: Get information about the bot. |
| 15 | + |
20 | 16 | ### Group Management Commands |
21 | | -- /lock: Locks the group with additional options to lock gifs, stickers, or forwards. |
22 | | -- /unLock: Unlocks the group with additional options to unlock gifs or stickers. |
23 | | -- /blacklist: Returns the current blacklist. |
24 | | -- /abl [word]: Adds a letter or word to the blacklist (e.g., /abl test). |
25 | | -- /rmbl [word]: Removes a word from the blacklist (e.g., /rmbl test). |
26 | | -### Information Commands |
27 | | -- /date: Provides today’s date in Gregorian and solar calendars. |
28 | | -- /future: Sends a predefined message about future plans. |
29 | | -- /rules: Returns the group's rules and allows adding (/rules test) or deleting all rules (/rules r). |
30 | | -## Examples |
31 | | -### Mute a User for 10 Minutes |
| 17 | +- **/rules**: View the group rules. |
| 18 | +- **/codetime**: Says a random word sarcastically or offensively to you or people in the group. |
| 19 | +- **/future**: Get insights about the future. |
| 20 | +- **/groupinfo**: View information about the group. |
| 21 | +- **/report**: Report an issue or a user. |
| 22 | +- **/cancel**: Cancel the current report. |
| 23 | +- **/link**: Generate or view group links. |
| 24 | +- **/adminlist**: View the list of group admins. |
| 25 | +- **/grant**: Grant admin privileges to a user. |
| 26 | +- **/revoke**: Revoke admin privileges from a user. |
| 27 | +- **/pin**: Pin a message in the group. |
| 28 | +- **/unpin**: Unpin the pinned message. |
| 29 | +- **/purge**: Delete a range of messages. |
| 30 | +- **/welcome**: Returns the current group welcome message. |
| 31 | + |
| 32 | +### Moderation Commands |
| 33 | +- **/approved**: Approve a user for special privileges. |
| 34 | +- **/disapproved**: Remove approval for a user. |
| 35 | +- **/approvedlist**: View the list of approved users. |
| 36 | +- **/ban**: Ban a user from the group. |
| 37 | +- **/unban**: Unban a previously banned user. |
| 38 | +- **/warn**: Issue a warning to a user. |
| 39 | +- **/rmwarn**: Remove a warning from a user. |
| 40 | +- **/warns**: Check warnings for a user. |
| 41 | +- **/warnslist**: View the list of all warnings. |
| 42 | +- **/mute**: Mute a user in the group. |
| 43 | +- **/unmute**: Unmute a previously muted user. |
| 44 | + |
| 45 | +### Blacklist Commands |
| 46 | +- **/blacklist**: Add a word or phrase to the blacklist. |
| 47 | +- **/abl**: Add multiple words to the blacklist. |
| 48 | +- **/rmbl**: Remove a word or phrase from the blacklist. |
| 49 | +- **/clrbl**: Clear the blacklist. |
| 50 | + |
| 51 | +### Shahin and Aran-Specific Commands |
| 52 | +- **/shahin**: Trigger Shahin-specific functionality. |
| 53 | +- **/aran**: Trigger Aran-specific functionality. |
32 | 54 |
|
33 | | -#### To mute a user for 10 minutes, use: |
| 55 | +--- |
| 56 | + |
| 57 | +## Example Commands |
| 58 | + |
| 59 | +### Mute a User for 10 Minutes |
| 60 | +To mute a user for 10 minutes: |
34 | 61 |
|
35 | 62 | ```plaintext |
36 | 63 | /mute 10m |
37 | 64 | (You must reply to the user you want to mute.) |
38 | 65 | ``` |
39 | | -#### Issue a Warning to a User |
40 | | -To issue a warning to a user with a reason, use: |
| 66 | + |
| 67 | +### Issue a Warning to a User |
| 68 | +To issue a warning to a user with a reason: |
41 | 69 |
|
42 | 70 | ```plaintext |
43 | 71 | /warn Spamming the chat |
44 | 72 | (You must reply to the user you want to warn.) |
45 | 73 | ``` |
46 | | -#### Ban a User |
47 | | -To ban a user from the group, use: |
| 74 | + |
| 75 | +### Ban a User |
| 76 | +To ban a user from the group: |
48 | 77 |
|
49 | 78 | ```plaintext |
50 | 79 | /ban |
51 | 80 | (You must reply to the user you want to ban.) |
52 | 81 | ``` |
53 | | -#### Unban a User |
54 | | -To unban a user from the group, use: |
| 82 | + |
| 83 | +### Unban a User |
| 84 | +To unban a user from the group: |
55 | 85 |
|
56 | 86 | ```plaintext |
57 | | -/unBan |
| 87 | +/unban |
58 | 88 | (You must specify the user to unban.) |
59 | | -``` |
| 89 | +``` |
0 commit comments