shubhambawner / cheems-bot

cheems-bot

A modular Whatsapp bot.

Dev-environment setup:

• Install Docker, VS Code and Dev Containers extension.
• Start the Docker application (It has to be keep running in background).
• Open Windows/Linux/Mac CMD/Terminal and do

  git clone https://github.com/bunnykek/cheems-bot
  cd cheems-bot
  code .
  

  or manually open the cheems-bot project folder in vs code.
• Now in VS Code, hit ctrl + shift + P and search Dev Containers: Rebuild and Reopen in Container. It will take few minutes depending on your internet connection.
• Now the project will re-open in a proper pre-configured environment/container.
• To start the bot use the command node bot.js or npm run test

Building modules guide:

• Use sticker module for reference.
• Modules file must contain a single class.
• Class name should be Title case. (Ex: Sticker, Chatgpt)
• Module file should have same name as class but in lowecase (ex: sticker.js, chatgpt.js)
• Class must contain these three things.
  • command variable. command = ['!sticker', '!steal']
  • description variable. description = ['!sticker desc.', '!steal desc']
  • operate() function.

Modules To-do list:

• Sticker
• Group management
• Chat GPT
• Music
• Year progress