Skip to content

Latest commit

 

History

History
66 lines (53 loc) · 2.9 KB

README.md

File metadata and controls

66 lines (53 loc) · 2.9 KB

KarmaBot

Лого проекта

This telegram bot is designed to track karma in chats. Just add him to the chat and thank each other for helpful answers.

wakatime license

Most bot commands use throttle mechanism, it means the bot wouldn't answer if you send many identical requests in a row.

Commands list:

  • /start, !start - simple bot information
  • !help - information about karma triggers
  • !about - information about the bot author and link to the source code
  • !top - show top users by karma level for this chat (only works for group and supergroups)
  • !me - show your karma for this chat (in group or supergroup) or show your karma for all yours chats (in private)
  • !report, /report, !admin, /admin, @admin - report spam, insult or another inappropriate content to the group administrators
  • !settings - show chat settings and commands to change them

Moderator commands list:

  • !ro !mute [DURATION] [@mention] - restrict replied or mentioned user for DURATION.
  • !ban [DURATION] [@mention] - kick replied user for DURATION
    • DURATION in format [AAAy][BBBw][CCCd][DDDh][EEEm][FFFs] where:
      • AAA - count of years (more than one year is permanent)
      • BBB - count of weeks
      • CCC - count of days
      • DDD - count of hours
      • EEE - count of minutes
      • FFF - count of seconds (less than 30 seconds will be mean 30 seconds)
    • you have to specify one or more duration part without spaces
  • !warn, !w [@mention] - official warn user from moderator
  • !info [@mention] - information about user (karma changes, restrictions, warns)
  • !karma_import [{"id": %id%, "karma": 42}] - import karma from JSON. %id% - is telegram user id, 42 is user karma. ONLY FOR CHAT OWNER. You can add more than one object in array.

Chat settings commands list:

  • !enable_karma - enable karma in chat
  • !disable_karma - disable karma in chat
  • !enable_karmic_ro - enable restrictions on low karma reason (need to have right for ban users for bot and user asked for that command)
  • !disable_karmic_ro - disable restrictions on low karma reason (need to have right for ban users for bot and user asked for that command)
  • !set_report_reward [REWARD] - set reward for report

Helper commands list:

  • !idchat - get id of chat, your id, and id of replayed user (if you reply to someone)
  • !go - search in Google
  • !paste - services for paste code
  • !nm - information about meta-questions
  • !xy - information about XY problem

Superuser commands list:

  • /dump - The bot sends a dump of the sqlite database to the chat DUMP_CHAT_ID
  • /get_out - Leave chat
  • /exception - Throw RuntimeError exception
  • /entities - Show entities from reply message