{"id":20178693,"url":"https://github.com/bunnykek/cheems-bot","last_synced_at":"2025-04-10T04:44:23.180Z","repository":{"id":214594158,"uuid":"736899794","full_name":"bunnykek/Cheems-bot","owner":"bunnykek","description":"A modular WhatsApp bot with limitless extensible features.","archived":false,"fork":false,"pushed_at":"2024-03-29T16:22:18.000Z","size":50020,"stargazers_count":6,"open_issues_count":0,"forks_count":6,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-24T06:02:07.234Z","etag":null,"topics":["automation","gemini","stickers","whatsapp-bot"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bunnykek.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-12-29T07:42:55.000Z","updated_at":"2024-12-24T12:56:22.000Z","dependencies_parsed_at":"2024-03-29T17:43:15.865Z","dependency_job_id":null,"html_url":"https://github.com/bunnykek/Cheems-bot","commit_stats":null,"previous_names":["bunnykek/cheems-bot"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bunnykek%2FCheems-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bunnykek%2FCheems-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bunnykek%2FCheems-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bunnykek%2FCheems-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bunnykek","download_url":"https://codeload.github.com/bunnykek/Cheems-bot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248161233,"owners_count":21057552,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","gemini","stickers","whatsapp-bot"],"created_at":"2024-11-14T02:22:55.558Z","updated_at":"2025-04-10T04:44:23.155Z","avatar_url":"https://github.com/bunnykek.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Cheems-bot](https://github.com/bunnykek/Cheems-bot/blob/main/assets/logo.svg)\r\n# Cheems-bot\r\nA modular Whatsapp bot.\r\n\r\n### Dev-environment setup:\r\n- 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.\r\n- Start the Docker application (It has to be keep running in background).\r\n- Open Windows/Linux/Mac `CMD/Terminal` and do\r\n  ```\r\n  git clone https://github.com/bunnykek/cheems-bot\r\n  cd cheems-bot\r\n  code .\r\n  ```\r\n  or manually open the `cheems-bot` project folder in vs code.\r\n- Now in VS Code, hit `ctrl + shift + P` and search `Dev Containers: Rebuild and Reopen in Container`. \r\nIt will take few minutes depending on your internet connection.\r\n![image](https://github.com/bunnykek/cheems-bot/assets/67633271/57f6584b-926f-4ede-abe2-46f78d991553)\r\n- Now the project will re-open in a proper pre-configured environment/container.\r\n- Rename `.envexample` file to `.env` and fill the details.\r\n- To start the bot use the command `node bot.js` or `npm run test`\r\n\r\n### Building modules guide:\r\n- Use [forward](https://github.com/bunnykek/Cheems-bot/blob/main/modules/forward/interface.js) module for reference.\r\n- Each module should contain a file named `\"interface.js\"`.\r\n- `\"interface.js\"` must contain a class named `\"Module\"`.\r\n- `\"Module\"` Class must contain these four methods.\r\n  - Module name. `name = 'Forward'`\r\n  - Module description. `description = 'Messaging forwarding features.'`\r\n  - `operate(client, message)` function.\r\n  - Module commands. \r\n```\r\ncommands = {\r\n\t\t'fwd': 'Reply the quoted message as forwarded.',\r\n\t\t'fwds': 'Show the forward score.',\r\n\t};\r\n```\r\n\r\n### Modules To-do list:\r\n- [x] Animal module (!cat, !dog)\r\n- [x] Forward (!fwd, !fwds)\r\n- [x] AI Chatbot (!gemini query)\r\n- [x] Meme (!meme [subreddit])\r\n- [x] Random (!rmeme, !ranime, !rsong, !rsong2)\r\n- [x] Song (!song query)\r\n- [x] Sticker (!sticker, !steal, !image, !square)\r\n- [x] Urban dictionary (!ud query)\r\n- [x] Wikipedia (!wiki [query], !wikipdf [query])\r\n- [x] Year progress (!yp)\r\n- [x] youtube-dl (!ytdl url) \r\n- [ ] Group management (!warn, !ban, !kick, etc)\r\n\r\n### !help\r\n\u003cimg src=\"https://github.com/bunnykek/Cheems-bot/assets/67633271/1fa89438-921f-499a-b7e6-b8ff473ad7ac\" width=\"300\"\u003e \r\n\r\n\r\n## Screenshots\r\n### Backend/Terminal\r\n![image](https://github.com/bunnykek/Cheems-bot/assets/67633271/a6591070-f2fe-4c31-b138-dbed4e80a22a)\r\n\r\n### Frontend/Whatsapp-Client\r\n![collage (3)](https://github.com/bunnykek/Cheems-bot/assets/67633271/727fa4a5-20be-4ef7-9463-a8ce5b2afbad)\r\n\r\n##### Make sure to star the project if it was helpful to you.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbunnykek%2Fcheems-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbunnykek%2Fcheems-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbunnykek%2Fcheems-bot/lists"}