https://github.com/bunnykek/cheems-bot
A modular WhatsApp bot with limitless extensible features.
https://github.com/bunnykek/cheems-bot
automation gemini stickers whatsapp-bot
Last synced: about 1 year ago
JSON representation
A modular WhatsApp bot with limitless extensible features.
- Host: GitHub
- URL: https://github.com/bunnykek/cheems-bot
- Owner: bunnykek
- Created: 2023-12-29T07:42:55.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-29T16:22:18.000Z (over 2 years ago)
- Last Synced: 2025-03-24T06:02:07.234Z (over 1 year ago)
- Topics: automation, gemini, stickers, whatsapp-bot
- Language: JavaScript
- Homepage:
- Size: 47.7 MB
- Stars: 6
- Watchers: 1
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Cheems-bot
A modular Whatsapp bot.
### Dev-environment setup:
- Install [Docker](https://docs.docker.com/engine/install/), [VS Code](https://code.visualstudio.com/download) and [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-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](https://github.com/bunnykek/Cheems-bot/blob/main/modules/forward/interface.js) 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:
- [x] Animal module (!cat, !dog)
- [x] Forward (!fwd, !fwds)
- [x] AI Chatbot (!gemini query)
- [x] Meme (!meme [subreddit])
- [x] Random (!rmeme, !ranime, !rsong, !rsong2)
- [x] Song (!song query)
- [x] Sticker (!sticker, !steal, !image, !square)
- [x] Urban dictionary (!ud query)
- [x] Wikipedia (!wiki [query], !wikipdf [query])
- [x] Year progress (!yp)
- [x] 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.