go-telegram-garvis

Garvis is a rule-based AI bot for Telegram written in Go. It is built using go-telegram-bot-api. It is written for Google App Engine but is easily ported to be hosted anywhere.

I created Garvis in the process of learning Go and trying to create a bot to mimic some of my reactions in Telegram group chats. For the time being it is following a fairly simple process by passing each message sent in a group through every filter available.

It can be used:

• as an autoresponder in group chats
• to create a personal butler for automating stuff with Telegram
• for gradually replacing yourself in group chats. (WIP: adding rules for all the modes of sarcasm, might use some sentiment analysis, might use some ML to make it learn from my responses hmmm... will see :) )

Features

• Generic filter system for easy creation of new filters and plugins
• Communication using Webhooks, making it easily scalable for environments like App Engine that spawn multiple instances for each request

Installation

1. Fork the project
2. Create a new bot in Telegram using BotFather
3. Disable group privacy mode so that it can read all the messages sent in a group
4. Create a new project in Google AppEngine
5. Create a config.json

{
    "TgBotKey": "YOUR KEY HERE"
}

6. Create your own filters
7. Deploy it
8. Activate it by visiting https://{app-id}.appspot.com/{telegram-bot-key}/start
9. Add it to a group (maybe)
10. Leave the group (potentially)

Filters added so far

• Caps filter: When a message is sent using all uppercase characters (stop shouting!)
• TL;DR filter: When a message exceeds a specified length
• Text filter: This is a more complicated programmable rule that allows the creation of text filters that trigger when a message is sent. This rule is using GAE key-based datastore to store the filters and their state.

Text filter examples

• \addrule [regex matcher][#count (optional default: 1)]~[reply]~[user (optional)]

  The regex matcher is enclosed by default with (?i) for case sensitivity, for case insensitive rules break it with (?-i)

  • When a message that starts with hi is sent respond "Hi"

    /addrule ^hi~Hi

  • When a message matching (ha)+ is sent 4 times respond "hahahah"

    /addrule (ha)+#4~hahahah

  • When user @test says lol 3 times respond "lel"

    /addrule lol#3~lel~@test

  • When user @test says lol respond "lel"

    /addrule lol~lel~@test

Playground for regex testing