Nanda-G / bot

A modular, highly-configurable, plug and play Telegram bot

Super Serious Bot

Introduction

The Super Serious Bot is a modular, asynchronous, highly-configurable, plug and play Telegram bot built using the fantastic python-telegram-bot library.

Features

By adding this bot to your group you can use this growing set of functions. Notable ones include:

• /stats to display today's chat statistics
• /steamstats to query a user's Steam profile
• /ban and /kick to ban or kick a member
• /weather to return live weather data of a location
• /tts to generate speech from provided text using Google's TTS engine
• /translate to translate a text in and to any language
• /hltb to query the HowLongToBeat API for game data
• /calc to query Wolframalpha

... and many more! To see a complete list of commands send /help to @SuperSeriousBot

Usage

Configuration

0. Before you can begin, you'll need to get a token and API keys for your bot. You can get the token from @BotFather.
1. Run the following command to generate an empty environment file:

$ git clone https://github.com/Super-Serious/bot
$ cp /bot/configuration/.env.example /bot/ssgbot.env

2. Now fill up the .env file with all the API keys mentioned

Running

SuperSeriousBot is run via Docker. The latest image can always be found at: http://ghcr.io/super-serious/bot.

To start the bot you only need the docker-compose.yml and a valid ssgbot.env file.

$ docker-compose up -d

Development

We also use Docker as the preferred development environment:

$ git clone https://github.com/Super-Serious/bot
$ cd bot
$ docker-compose up 

Any changes to the code persist through container restarts, no need to rebuild the image!

To test if the bot is running, simply send a /start message to it.

Recommended Reading

• Telegram API documentation
• python-telegram-bot documentation

Contributing

Contributions are welcome! You can view our contributing guidelines here.