omidtarh / foxb

merbot

A Telegram Group Peace Keeper Bot

Bot Commands

Name	Description	Usage
banhammer.lua	Plugin to manage bans, kicks and white/black lists.	!whitelist <enable>/<disable> : Enable or disable whitelist mode !whitelist user <user_id> : Allow user to use the bot when whitelist mode is enabled !whitelist user <username> : Allow user to use the bot when whitelist mode is enabled !whitelist chat : Allow everybody on current chat to use the bot when whitelist mode is enabled !whitelist delete user <user_id> : Remove user from whitelist !whitelist delete chat : Remove chat from whitelist !ban user <user_id> : Kick user from chat and kicks it if joins chat again !ban user <username> : Kick user from chat and kicks it if joins chat again !ban delete <user_id> : Unban user !kick: Kick replied user !kickme: Bot kick user !kick <user_id> : Kick user from chat group by id !kick <username> : Kick user from chat group by username !superban user <user_id> : Kick user from all chat and kicks it if joins again !superban user <username> : Kick user from all chat and kicks it if joins again !superban delete <user_id> : Unban user
channels.lua	Plugin to manage channels. Enable or disable channel.	!channel enable : enable current channel !channel disable : disable current channel
groupmanager.lua	Plugin to manage group chat.	!group create <group_name> : Create a new group (admin only) !group set about <description> : Set group description !group about : Read group description !group link get : Get invite link. !group link revoke : Revoke (remove and replace by newly generated) invite link. !group set rules <rules> : Set group rules !group rules : Read group rules !group set name <new_name> : Set group name !group set photo : Set group photo !group <lock|unlock> name : Lock/unlock group name !group <lock|unlock> photo : Lock/unlock group photo !group <lock|unlock> member : Lock/unlock group member !group <lock|unlock> spam : Enable/disable spam protection !group settings : Show group settings
help.lua	Help plugin. Get info from other plugins.	!help : Show list of plugins. !help all : Show all commands for every plugin. !help [plugin name] : Commands for that plugin.
id.lua	Know your id or the id of a chat members.	!id : Return your ID and the chat id if you are in one. !id(s) chat : Return the IDs of the chat members.
invite.lua	Invite other user to the chat group	!invite name [user_name] !invite id [user_id]
moderation.lua	Moderation plugin.	!promote <username> : Promote user as moderator !demote <username> : Demote user from moderator !modlist : List of moderators !modadd : Add group to moderation list !modrem : Remove group from moderation list !adminprom <username> : Promote user as admin (must be done from a group) !admindem <username> : Demote user from admin (must be done from a group)
plugins.lua	Plugin to manage other plugins. Enable, disable or reload.	!plugins : list all plugins. !plugins enable [plugin] : enable plugin. !plugins disable [plugin] : disable plugin. !plugins disable [plugin] chat : disable plugin only this chat. !plugins reload : reloads all plugins.
stats.lua	Plugin to update user stats.	!stats : Returns a list of username message number
version.lua	Shows bot version	!version : Shows bot version

Installation

# Tested on Debian 8, for other OSs check out https://github.com/yagop/telegram-bot/wiki/Installation
sudo apt update
sudo apt upgrade
sudo apt install libreadline-dev libconfig-dev libssl-dev lua5.2 liblua5.2-dev libevent-dev libjansson-dev libpython-dev make unzip git redis-server g++

# After those dependencies, lets install the bot
cd $HOME
git clone https://github.com/rizaumami/merbot.git
cd merbot
./launch.sh install
./launch.sh # Will ask you for a phone number & confirmation code.

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.