Installation

1. python 2.7 required, as well as pip module.
2. clone this repository
3. pip install -r requirements.txt to fullfill dependencies.

Community Bot

Config File

You can find a config template here: conf/watchdog.conf.example Following are description for each section in config file

[bot]

token = 111111111:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA name = @usernameofyourbot

token should be the token of bot you got from @botfather name should be the username of your token, don't miss @

[groups]

-1000000000001 = anotherpuzzle.json -1000000000001 = nopuzzle If Groups doesn't have puzzle file, the following commands will use the group's name as default.

puzzle file must use json as extension

puzzle file format example: _data/11111111111111.json.example

format groupid = puzzle file path

If puzzle file path is a relative path, then the current directory is the working directory where the bot started.

Have to use UTF-8 encoding to save it

[confadmins]

The user who has the rights to change config. Format: userid = Remark

[dataadmins]

The user who has the rights to change data. Format: userid = Remark

[blackfiletypes]

The users who send the following type of files will be banned automatically,

Format: .filetype = Remark

[scamkeys]

The keywords that scammers possibly use,

Format: Keywords = Remark

How to run it

After set the conf file,

Please make sure the current user has the WRITE rights to the folder _data

Run the following command

python community.py [config file]

Run the log output to stderr, possibly need redirect

Quick Manual

1. When the Community Bot detects a new user join in the group(which has correctly configured the puzzle file, and the bot has READ rights in this group). The bot will temporary ban the new user (needs BAN rights), and ask the new user to take a quiz (needs Send Message rights). The bot will allow the user to join in after he/she complete the quiz successfully. Otherwise it will ban the user if he/she has not finished the quiz in a certain time period.

2. /supervise dataadmin could reply to a user in the group(which has the Bot), and if this user is not in the 'groups' config, this user will be added to the 'groups' config.

3. /dataadmin confadmin could reply to a user in the group(which has the Bot), and this user will become dataadmin.

4. /start watchdog function, user PM the Bot in order to take a quiz.

5. /replybanall dataadmin or confadmin could use this command to ban the user(that has been replied) in ALL groups that under this admin's jurisdiction. And add this user to black list.

6. /fwdbanall dataadmin or confadmin could use this command to ban the forwarded user in ALL groups that under this admin's jurisdiction. And add this user to black list.

7. /idbanall <userid> dataadmin or confadmin could use this command to ban the userid in ALL groups that under this admin's jurisdiction. And add this userid to black list.

8. /reload confadmin could PM the Bot to use this command to reload config files(and config the data files in the config files).

9. /points Check your self points in the current group.

10. /rank dataadmin check the top 10 ranking.

11. /clearpoints confadmin clear all points in the current group.

12. /clean confadmin clear the hidden tasks, and after that please stop the Bot immediately.

13. /punish group admin, confadmin or dataadmin could clear user's points to punish the user.

14. /broadcastee <Group Name> call this command in group to add this group as broadcastee in certain group