BocchiBot  by SlavyanDesu

WhatsApp bot for multipurpose tasks

Created 4 years ago
335 stars

Top 82.0% on SourcePulse

GitHubView on GitHub
Project Summary

BocchiBot is a multipurpose WhatsApp bot designed for users who want to automate tasks and add functionality to their WhatsApp interactions. It leverages the wa-automate-nodejs library to connect to WhatsApp, offering a range of features for personal or group chat management.

How It Works

The bot operates by connecting to a WhatsApp account via wa-automate-nodejs, which handles the WhatsApp Web interface. Users configure API keys for services like OpenAI and SauceNAO, enabling features such as AI-powered responses and image searching. The bot's functionality is extended through various npm packages and external tools like FFmpeg for media processing and Tesseract for OCR.

Quick Start & Requirements

  • Primary install: npm install followed by npm start or pm2 start index.js.
  • Prerequisites: Node.js, Git, FFmpeg, Tesseract OCR.
  • Setup: Requires editing config.json with API keys and WhatsApp number. FFmpeg and Tesseract installation involves adding their binaries to the system's PATH.
  • Documentation: Commands are listed by typing .help in the bot's chat.

Highlighted Details

  • Multipurpose functionality with commands for various tasks.
  • Integration with OpenAI for AI-driven conversations.
  • Support for image-to-sticker conversion using FFmpeg.
  • OCR capabilities via Tesseract for text extraction from images.

Maintenance & Community

The project is authored and maintained by SlavyanDesu. No specific community channels or roadmap details are provided in the README.

Licensing & Compatibility

  • License: MIT License.
  • Compatibility: Permissive for commercial use and integration with closed-source applications.

Limitations & Caveats

The setup process for FFmpeg and Tesseract requires manual configuration of system environment variables, which may be a barrier for less technical users. The README does not detail specific limitations or known bugs.

Health Check
Last Commit

5 months ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
0
Star History
2 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.