epfl-dojo / mate-bot

Manage your Club Mate in a Telegram group

Mate Bot

Telegram bot to manage the consumption of Club Mate between different people.

Setup

1. Communicate with @BotFather to create a bot and get the token.
2. Rename secrets.sample.json to secrets.json.
3. Replace the BOT_TOKEN key in the secrets.json file with the bot token.
4. Go on Giphy get api key and follow the instructions to get an API key.
5. Replace the API_KEY key in the secrets.json file with the api key you were provided with.
6. Run npm i to install the node dependencies.
7. Run script with node index.js.

Commands

• /start → Welcome :)
• /about → Shows bot version, bug report, etc...
• /help → Shows a list of all available commands with their description.
• /send <@username> <amount> → Send a specific amount of money to another person.
• /balance → Shows the status of everyone's wallet.
• /setoption <item> <value> → Change the value of an item (price of box, bottle, currency...).
• /option → List current options's values.
• /buybox → The user buys a case of club-mate.
• /drink → The user drinks a club-mate.
• /charge [@username] <value>

mate-bot's Issues

Add /charge command

• /charge 20 → +20 to current user
• /charge @user 20 → +20 to specified user
• /charge -20 → -20 to current user
• /charge @user -20 → -20 to specified user

Add /buybox command

Add /buybox command for a person who buy a mate box

Change currency

It could be cool to change the current currency

`/about` command

I think it would be helpful to get a command that shows:

• where to get the bot's sources, i.e. https://github.com/epfl-dojo/mate-bot
• the bot version number
• on what server the bot's currently running

Dockerisation

À remplir

Add a /balance command

Add a /balance command that show the balance of a user or all users

Missing currency in /buybox's anwer

Add /dump command

Add a /dump command that send the users_data content, this command musst NOT to be in the README

Print usage for command with options

e.g. when someone call /setoption, it would be nice to print a message with the usage of the command instead of nothing. There are probably others command in the same case.

createUserList() function isn't working

User's ID along with wallet and username attributes are not being written in user_data.json when a message is sent in the chat.

Add a /setprice command

Add a /setprice command that set the price of a mate bottle or mate box

Add a /price command

Add a /price command that list the price for 1 mate and 1 mate box

Add /drink command

Add a /drink command that decrease the balance of the user that use this command

Add /help command

Add a /help command that list all the available commands for the bot

Check bot writing access

Check if the bot has write access when creating users_data.json file

Add a /send command

Add a /send command that send monney to another user

Add some server's logs

user_data doesn't update when someones changes his username

Add random gif to /drink messages

/help command order

There is no particular order in the output of the /help command: either put them in alphabetical order or rearrange them in a more logical way.

Add a /start command