#Bot nex
##Short introduction
This bot has been created to help people in the administration of a group, with a lot of useful tools(bk).
This bot born as an Otouto v3.1 (@mokubot), but has been turned in an administration bot. kir mikhaiy
Installation
# Tested on Ubuntu 14.04, Ubuntu 15.04, Debian 7, Linux Mint 17.2
sudo apt-get update
sudo apt-get upgrade
sudo apt-get install libreadline-dev libssl-dev lua5.2 liblua5.2-dev git make unzip redis-server curl
# We are going now to install LuaRocks and the required Lua modules
wget http://luarocks.org/releases/luarocks-2.2.2.tar.gz
tar zxpf luarocks-2.2.2.tar.gz
cd luarocks-2.2.2
./configure
sudo luarocks install luasocket
sudo luarocks install luasec
sudo luarocks install redis-lua
sudo luarocks install lua-term
sudo luarocks install serpent
sudo luarocks install dkjson
cd ..
# Clone the repository and give the permissions to start the launch script
git https://github.com/behradhg/GroupButler
cd GroupButler && sudo chmod 777 launch.sh
Other things to check before run the bot:
First of all, take a look to your bot settings:
• Make sure that privacy is disabled (more info in the official Bots FAQ page). Write
/setprivacy
to BotFather to check the current setting.
Before you do anything, open config.lua in a text editor and make the following changes:
• Set bot_api_key to the authentication token you received from the BotFather.
• Set admin as your Telegram ID under
admin.owner
field. You can set other admins by placing their IDs underadmin.admins
, as a table key withtrue
value.• If it asks for the sudo password during/after the installation, insert it.
Before start the bot, you have to start the Redis process.
# Start Redis
sudo service redis-server start
If you are updating the bot from a version older than 4.0
, you must force your groups to run /restore
command if they want their rules/welcome message/extras back. This because some things with the database changed after the 4.0 update.
To restore the bot stats, use /restorebot
command.
##MUST READ!!!
Before stop the bot, if you don't want to loose your redis datas, you have to perform a save.
There are three ways to do this: use $stop
command to stop the bot (datas will be saved automatically), use $save
command to save datas (and then stop the bot), or open a terminal and run redis-cli bgsave
or redis-cli save
(and then stop the bot).
Please remember to do one of this easy things in order to avoid to loose important informations.
You may want to perform a save each minute, for this you need to change the boolean value of the cron
function in plugins/admin.lua
from false
to cron
(or the name of the cron function).
In this way, a cron job will run every minute and will perform a redis background save.
##Start the process
To start the bot, run ./launch.sh
. To stop the bot, press Ctrl+c twice.
You may also start the bot with lua bot.lua
, but then it will not restart automatically.
##Something that you should known before run the bot
- You can change some settings of the bot. All the settings are placed in
config.lua
, in thebot_settings
tablecache_time.adminlist
: the permanence in seconds of the adminlist in the cache. The bot caches the adminlist to avoid to hit Telegram limitstesting_mode
: set it tofalse
if you want the bot to ignore testing plugins. A plugin is a test plugin when thetest
key in the returned table is not anil
value or afalse
boolean valuemultipurpose_mode
: set it totrue
if you want to load the plugins placed inplugins/multipurpose
folder. At the moment, this directory is emptynotify_bug
: iftrue
, the bot will send a message that notifies that a bug has occured to the current user, when a plugin is executed and an error happenslog_api_errors
: iftrue
, the bot will send in thelog_chat
(config.lua
) all the relevant errors returned by an api request toward Telegram
- There are some other useful fields that can be filled in
config.lua
admin.admins
: you can add in this table other (numerical) keys, they must be the IDs of the other admins of the bot. Each key must have a boolean value,true
if admin,false
if notlog_chat
: iflog_api_errors
is set ontrue
, this must be the chat id where the bot will log the errors. Ifnil
or empty, they will be sent directly to the bot ownerchannel
: a channel where you can post something through the bot. Must be an username,@
included. To post something, the bot must be admin of the channel. Use$post [text]
to post a messagedb
: the selected Redis database (if you are running Redis with the default config, the available databases are 16). The database will be selected on each start/reload. Default: 2languages
: the path to the file that contains the translations
- Other things that may be useful
- Admin commands start for
$
. They are not documented, look at the triggers ofplugins/admin.lua
plugin for the whole list - If the
action
function of a plugin returnstrue
, the bot will continue to try to match the message text with the missing triggers of theplugins
table - You can send yourself a backup of the zipped bot folder with the
$backup
command - The Telegram Bot API has some undocumented "weird behaviours" that you may notice while using this bot
- In supergroups, the
kickChatMember
method returns always a positive response if theuser_id
has been part of the group at least once, it doesn't matter if the user is not in the group when you use this method - In supergroups, the
unbanChatMember
method returns always a positive response if theuser_id
has been part of the group at least once, it doesn't matter if the user is not in the group or is not in the group blacklist - Users kicked by the bot can join again a group from where they've been kicked out only if not banned and only via invite link. An admin can't add them back
- In supergroups, the
- Admin commands start for
##Some notes about the database
Everything is stored on Redis, and the faster way to edit your database is the Redis command line interface.
You can find a backup of your Redis database under /etc/redis/dump.rdb
. The name of this file and the frequency of the saves depend on your redis configuration file.
###Notes about this repository
Note that this bot is not opensource because I want everyone to be able to clone it and run its own copy. It's opensource because everyone can take a look on how the bot works, see which data are stored, and decide if the bot is worth to be a group admin. There are some installation intructions just because why not.
Please don't contact me via Telegram asking for help in the installation or about errors in your clone (I like to spamreport people). Contact me only if you find a bug or have a suggestion. I don't give any support in the installation or development of your own instance of the bot. Basicly because I'm a stupid noob that only knows the basics of Lua scripting, and I don't like to spend my free time in front of a monitor. I try to keep the time I waste on this project to a minimum.
If you are going to open a pull request, keep in mind that I don't know how to use GitHub well. I may overwrite commits and stuffs like that, this already happened. It's not because I'm bad, it's just because I'm an idiot.
##Credits
Topkecleon, for the original otouto
Iman Daneshi and Tiago Danin, for Jack-telegram-bot
Yago Pérez for his telegram-bot
The Werewolf guys, for aiding the spread of the bot
Lucas Montuano, for helping me a lot in the debugging of the bot
All the people who reported bugs and suggested new stuffs
Le Laide