toke / go-triggerbot

Telegram Triggerbot written in go

Telegram Triggerbot

A Basic Telegram trigger bot. Triggers can be configured as go regular expressions in a configuration file. Currently only text messages can be triggered.

Compiling

Download and install it. In the Source code directory run: go build -v . Done - proceed withe Section Usage.

Usage

Use config-example.yaml as a template and place save it as triggerbot.yml in the same Directory as the binary. A different name and location can be set via the command line parameter -config

Make sure to insert The Bot TOKEN into the config file. Use @BotFather to create a bot and a TOKEN. Make sure to disable privacy mode.

telegram:
  token: "YOUR BOTTOKEN"
  timeout: 60

limits:
  - # Allow one request per 5 minutes
    bucket: 5m
    limit: 1
  - # Allow 5 requests per hour
    bucket: 1h
    limit: 5

trigger:
  - # A normal Case sensitive Match
    match: "WTF?"
    text: "What the Fish?"
  - # Case insensitive Match
    match: "(?i)guten morgen"
    text: "Nimm Dir nen Kaffee! ☕️"
  - # This will match "Die 5 Freunde" but not "Die fünf Freunde"
    match: "[Dd]ie \\d+ Freunde"
    text: "... und Timmy der Hund"

NOTE: The Configuration file uses YAML as format. Indentation matters! Also make sure not to mix Tabs and Spaces when doing indentation.

go-triggerbot's Issues

Limit activation

Limit the amount of reply per time

Make it possible to reply randomly

Provide a way to specify more than one response and choose randomly.

Stop triggers

Triggers that stop the bot from working in a chat for a specified time.

Connection triggers

Triggers that stay inactive until another trigger is triggered and will be disabled after the specified time after the activation trigger is triggered.

Provide a way to limit the probability for responses

Make it possible to specify a probability for answering.
So triggering is more naturally.