README.md

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.
• Rename .envexample file to .env and fill the details.
• To start the bot use the command node bot.js or npm run test

Building modules guide:

• Use forward module for reference.
• Each module should contain a file named "interface.js".
• "interface.js" must contain a class named "Module".
• "Module" Class must contain these four methods.
  • Module name. name = 'Forward'
  • Module description. description = 'Messaging forwarding features.'
  • operate(client, message) function.
  • Module commands.

commands = {
		'fwd': 'Reply the quoted message as forwarded.',
		'fwds': 'Show the forward score.',
	};

Modules To-do list:

• Animal module (!cat, !dog)
• Forward (!fwd, !fwds)
• AI Chatbot (!gemini query)
• Meme (!meme [subreddit])
• Random (!rmeme, !ranime, !rsong, !rsong2)
• Song (!song query)
• Sticker (!sticker, !steal, !image, !square)
• Urban dictionary (!ud query)
• Wikipedia (!wiki [query], !wikipdf [query])
• Year progress (!yp)
• youtube-dl (!ytdl url)
• Group management (!warn, !ban, !kick, etc)

!help

Screenshots

Backend/Terminal

Frontend/Whatsapp-Client

Make sure to star the project if it was helpful to you.