Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thedevs-network/the-guard-bot

The Guard, a Telegram bot to moderate groups.
https://github.com/thedevs-network/the-guard-bot

bot telegram telegram-bot

Last synced: 5 days ago
JSON representation

The Guard, a Telegram bot to moderate groups.

Host: GitHub
URL: https://github.com/thedevs-network/the-guard-bot
Owner: thedevs-network
License: agpl-3.0
Created: 2017-07-21T14:34:26.000Z (over 7 years ago)
Default Branch: develop
Last Pushed: 2023-11-25T14:32:15.000Z (12 months ago)
Last Synced: 2024-08-01T19:48:07.695Z (3 months ago)
Topics: bot, telegram, telegram-bot
Language: JavaScript
Homepage: https://t.me/thedevs_bot
Size: 949 KB
Stars: 491
Watchers: 32
Forks: 162
Open Issues: 8
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        


  

  
The Guard Bot


The Guard is a Telegram bot made to help admins manage their groups.

Initially created to moderate [The Devs Network](https://thedevs.network).

## Table of Contents

* [Key Features](#key-features)

* [Setup](#setup)

* [Commands](#commands)

* [Plugins](#plugins)

* [Support](#support)

* [License](#license)

## Key Features

* Synchronized across 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 control the group

* Commands work with replying, mentioning and ID

* Removes commands and temporary bot messages

* Ability to create custom commands

* Supports plugins

Overall, keeps the groups clean and healthy to use.

## Setup

You need [Node.js](https://nodejs.org/) (>= 18) to run this bot.

1. Create a bot via [@BotFather](https://t.me/BotFather) and grab a **token**.

2. Clone this repository or [download zip](https://github.com/TheDevs-Network/the-guard-bot/archive/master.zip).

3. Install dependencies via `npm install`.

4. Copy `example.config.js` to `config.js` and edit it.

5. Start the bot via `npm start`.

### Setup with Docker

You need to have [docker](https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/#install-from-a-package) installed on your machine.

1. Create a bot via [@BotFather](https://t.me/BotFather) and grab a **token**.

2. Clone this repository or [download zip](https://github.com/TheDevs-Network/the-guard-bot/archive/master.zip).

3. Copy `example.config.js` to `config.js` and edit it.

4. Run `docker build -t the_guard_bot .` to build image.

5. Run `docker run -v $(pwd)/data:/app/data --rm -itd the_guard_bot` to start the bot.

Now you can add the bot as **administrator** to your groups.

## Commands

Command                 | Role       | Available at | Description

----------------------- | ---------- | ------------ | -----------------

`/admin`                | _Master_   | _Everywhere_ | Makes the user admin in the bot and groups.

`/unadmin`              | _Master_   | _Everywhere_ | Demotes the user from admin list.

`/leave `     | _Master_   | _Everywhere_ | Make the bot to leave the group cleanly.

`/hidegroup`            | _Master_   | _Groups_     | Revoke invite link and hide the group from `/groups` list.

`/showgroup`            | _Master_   | _Groups_     | Make the group accessible via `/groups` list.

`/del [reason]`         | _Admin_    | _Everywhere_ | Deletes replied-to message.

`/warn `        | _Admin_    | _Groups_     | Warns the user.

`/unwarn`               | _Admin_    | _Everywhere_ | Removes the last warn from the user.

`/nowarns`              | _Admin_    | _Everywhere_ | Clears warns for the user.

`/permit`               | _Admin_    | _Everywhere_ | Permits the user to advertise once, within 24 hours.

`/ban `         | _Admin_    | _Groups_     | Bans the user from groups.

`/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.

`/removecommand ` | _Admin_    | _In-Bot_     | Remove a custom command.

`/staff`                | _Everyone_ | _Everywhere_ | Shows a list of admins.

`/link`                 | _Everyone_ | _Everywhere_ | Shows the current group's link.

`/groups`               | _Everyone_ | _Everywhere_ | Shows a list of groups which the bot is admin in.

`/report [reason]`      | _Everyone_ | _Groups_     | Reports the replied-to message to admins, reason is optional. Also can be prepended by `@` or `!` instead, and it is aliased by `admin` and `admins`.

`/commands`             | _Everyone_ | _In-Bot_     | Shows a list of available commands.

`/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 **replying**, **mentioning** or **ID** of a user.

If used by reply, `/ban` and `/warn` would remove the replied-to message.

## Plugins

The guard is extensible in form of plugins where custom features and commands can be easily added to it.

See the [Plugins page on the Wiki](https://github.com/thedevs-network/the-guard-bot/wiki/Plugins) for more information.

## Support

If you need help with using the Bot or setting it up, join our [Support Chat](https://t.me/theguardsupport).

[**Roadmap**](https://github.com/TheDevs-Network/the-guard-bot/projects/1)

## License

> Important Note: Under the AGPL-3.0 license, if you're running your own instance, you should add a link to the source [(this repository)](https://github.com/TheDevs-Network/the-guard-bot) in your bot's bio. If you're modifying this source and making your own bot, you should link to the source of your own version of the bot according to the AGPL-3.0 license. Check [LICENSE](LICENSE) for more info.

---

`The Guard` icon is from [Entypo+](http://entypo.com/) by Daniel Bruce.