pegelinux / merbot

A Telegram Group Peace Keeper Bot

merbot

A Telegram Group Peace Keeper Bot

Merbot is Telegram group guardian bot based on telegram-bot.

Merbot is dedicated as a group manager bot, so it's have no unnecessary plugins other than listed below. You can always add plugins as you need.

1. Banhammer. Plugin to manage bans, kicks and white/black lists.

• Enable or disable whitelist mode.
• Allow user to use the bot when whitelist mode is enabled.
• Allow everybody on current chat to use the bot when whitelist mode is enabled.
• Remove user from whitelist.
• Remove chat from whitelist.
• Kick user from chat and kicks it if joins chat again.
• Unban user.
• Kick user from chat group.

2. Channels. Plugin to manage channels. Enable or disable channel.

• Enable current channel.
• Disable current channel.

3. Group Manager. Plugin to manage group chat.

• Read group description.
• {Dis}allow APIs bots.
• Lock/unlock group member.
• Lock/unlock group name.
• Lock/unlock group photo.
• Show group settings.
• Get or revoke invite link.
• Read group rules.
• Set group description.
• Set group name.
• Set group photo.
• Set group rules.

4. Help. Help plugin. Get info from other plugins.

• Show list of plugins.
• Show all commands for every plugin.
• Commands for that plugin.

5. Id. Know your id or the id of a chat members.

• Return your ID and the chat id if you are in one.
• Return the IDs of the current chat members.
• Return the IDs of the chat_id members.
• Return the member @user_name ID from the current chat.
• Search for users with text on first_name, print_name or username on current chat.

6. Invite. Invite other user to the chat group.

7. Plugins. Plugin to manage other plugins. Enable, disable or reload.

• List all plugins.
• Enable plugin.
• Disable plugin.
• Disable plugin only this chat.
• Reloads all plugins.

8. Version. Shows bot version.

Installation

Dependencies

Tested on Ubuntu 14.04, for other OSs check out https://github.com/yagop/telegram-bot/wiki/Installation.

sudo apt-get install libreadline-dev libconfig-dev libssl-dev lua5.2 liblua5.2-dev libevent-dev make unzip git redis-server g++ libjansson-dev libpython-dev expat libexpat1-dev

Installation

After those dependencies, lets install the bot.

cd $HOME
git clone https://github.com/rizaumami/merbot.git
cd merbot
./merbot install
./merbot # Will ask you for a phone number & confirmation code.

If you use Ubuntu, which is use upstart, you can create an upstart script to manage merbot.

./merbot upstart

And then, start merbot by executing sudo start merbot. And stop merbot by sudo stop merbot.

Enable more plugins

See the plugins list with !plugins command.

Enable a disabled plugin by !plugins enable [name].

Disable an enabled plugin by !plugins disable [name].

Those commands require a privileged user, privileged users are defined inside data/config.lua (generated by the bot), stop the bot and edit if necessary.