Skip to content

Latest commit

 

History

History
43 lines (34 loc) · 1.5 KB

README.md

File metadata and controls

43 lines (34 loc) · 1.5 KB

Mussum Build Status

A telegram bot to help you fight spam written in Go

This bot is inspired by a Brazilian comedian called Mussum. He was very popular between the 70's and 90's and he had a particular way of speaking portuguese while acting and I tried to bring that style into the way the bot talks to the users. Hope you enjoy it.

Usage

Mussum generates a random sum challenge and gives the user 60 seconds to solve it. If the challenge is solved, user gets a confirmation and stays in the group. If user fails, Mussum will kick the user from the group. Therefore, Mussum also needs to have admin permission for your group in order to kick the users that fail the challenge.

Build

The following command should build Mussum binary as well as its docker image.

make build

Running locally

Use the BotFather on Telegram to generate an APIKEY. Start the bot locally by running:

APIKEY=your_api_key make run

Mussum speaks portuguese by default.

Running tests

make test

Running linter

make lint

Changing the language

Mussum currently supports portuguese(pt) and english(en).

APIKEY=your_api_key LANGUAGE=en make run

You can easily add more languages by implementing the language interface. Please see the language package.