mir/the-guard-bot
2
0
Fork 0
mirror of https://github.com/thedevs-network/the-guard-bot synced 2025-08-31 14:15:25 +00:00
Code Issues Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Pouria Ezzati
2017-11-02 09:58:25 +03:30
committed by GitHub
parent 70317189bd
commit b6e57b4e29
1 changed files with 16 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -19,18 +19,31 @@ You need [Node.js](https://nodejs.org/) (> 8.1) to run this bot.
Now you can add the bot as **administrator** to your groups. Now you can add the bot as **administrator** to your groups.
## Features
* Synchronized database accross multiple groups.
* Adding admins to the bot.
* Auto-remove and warn channels and groups ads.
* Kick bots added by users.
* Warn and ban users to controll the group.
* Commands work with replying, mentioning and ID.
* Removes commands and temporary bot messages.
* Ability to create custom commands.
* Supports plugins.
Overally, keeps the groups clean and healthy to use.
## Commands ## Commands
Command | Role | Available at | Description Command | Role | Available at | Description
----------------------- | ---------- | ------------ | ----------------- ----------------------- | ---------- | ------------ | -----------------
`/admin` | _Master_ | _Everywhere_ | Makes the user admin. `/admin` | _Master_ | _Everywhere_ | Makes the user admin in the bot and groups.
`/unadmin` | _Master_ | _Everywhere_ | Demotes the user from admin list. `/unadmin` | _Master_ | _Everywhere_ | Demotes the user from admin list.
`/leave <name\|id>` | _Master_ | _Everywhere_ | Make the bot to leave the group cleanly. `/leave <name\|id>` | _Master_ | _Everywhere_ | Make the bot to leave the group cleanly.
`/warn <reason>` | _Admin_ | _Groups_ | Warns the user. `/warn <reason>` | _Admin_ | _Groups_ | Warns the user.
`/unwarn` | _Admin_ | _Everywhere_ | Removes the last warn from the user. `/unwarn` | _Admin_ | _Everywhere_ | Removes the last warn from the user.
`/nowarns` | _Admin_ | _Everywhere_ | Clears warns for the user. `/nowarns` | _Admin_ | _Everywhere_ | Clears warns for the user.
`/getwarns` | _Admin_ | _Everywhere_ | Shows a list of warns for the user.
`/ban <reason>` | _Admin_ | _Groups_ | Bans the user from groups. `/ban <reason>` | _Admin_ | _Groups_ | Bans the user from groups.
`/unban` | _Admin_ | _Everywhere_ | Removes the user from ban list. `/unban` | _Admin_ | _Everywhere_ | Removes the user from ban list.
`/user` | _Admin_ | _Everywhere_ | Shows the status of the user.
`/addcommand` | _Admin_ | _In-Bot_ | Create a custom command. `/addcommand` | _Admin_ | _In-Bot_ | Create a custom command.
`/removecommand <name>` | _Admin_ | _In-Bot_ | Remove a custom command. `/removecommand <name>` | _Admin_ | _In-Bot_ | Remove a custom command.
`/staff` | _Everyone_ | _Everywhere_ | Shows a list of admins. `/staff` | _Everyone_ | _Everywhere_ | Shows a list of admins.
@@ -40,7 +53,7 @@ Command | Role | Available at | Description
`/commands` | _Everyone_ | _In-Bot_ | Shows a list of available commands. `/commands` | _Everyone_ | _In-Bot_ | Shows a list of available commands.
`/help` \| `/start` | _Everyone_ | _In-Bot_ | How to use the bot. `/help` \| `/start` | _Everyone_ | _In-Bot_ | How to use the bot.
All commands and actions are synchronized across all of the groups managed by the owner and they work with both **replying** and **mentioning** a user. All commands and actions are synchronized across all of the groups managed by the owner and they work with **replying**, **mentioning** or **ID** of a user.
If used by reply, `/ban` and `/warn` would remove the replied-to message. If used by reply, `/ban` and `/warn` would remove the replied-to message.