🐐 Goat WhatsApp Bot

A clean, modular, and production-ready WhatsApp chatbot using personal accounts via Baileys.

---

🧠 About

Goat WhatsApp Bot was built with a single goal: to offer a lightweight, stable, and developer-friendly chatbot platform for WhatsApp. It’s crafted from the ground up with clarity, modularity, and maintainability in mind — making it easier for developers to understand, extend, and collaborate on.

With clean, fully readable code (no obfuscation or encryption), this project is designed to help developers of all levels learn, modify, and extend it with confidence.

🎯 Built for Developers. Shared with the Community.

---

📋 Features

• 🔌 Modular Plugin System – Drop-in commands & event files.
• ⚙️ Hot Reload – Update without restarting the bot.
• 🔐 Pairing/QR Login – Choose your auth flow.
• 💻 Dashboard UI – Real-time stats, settings & more.
• 🧠 Smart Commands – Prebuilt utilities, media, tools.
• 🌍 Multilingual Support – Easily extend to other languages.
• 📁 JSON DB (Pluggable) – Add MongoDB, SQLite, etc.
• 📜 Built-in Logger – Simple and effective console outputs.

---

🛠️ Installation Guide

Follow these steps to get the bot running on your machine.

📦 Requirements

• Node.js >= 20.x — Download here
• Git (optional but recommended)
• WhatsApp account (use a secondary or throwaway account)

🚀 Quick Start

1. Clone the Repository

git clone https://github.com/tas33n/Goat-WhatsApp-Bot.git
cd Goat-WhatsApp-Bot

2. Install Dependencies

npm install

3. Start the Bot

npm start

The bot will prompt you to scan a QR code (for the first time login).

🐳 Optional: Run with Docker

A ready-to-use Dockerfile is included with Node.js 20 and FFmpeg preinstalled.

# Build the Docker image
docker build -t goat-whatsapp-bot .

# Run the bot container interactively
docker run -it goat-whatsapp-bot

# Run the bot with persistent session
docker run -it -p 3000:3000 -v $(pwd)/session:/app/session goat-whatsapp-bot

✅ Authentication Note

If you want to reuse the session, your credentials are stored locally in session/ folder. Do not share it.

---

🧩 Plugin System

✏️ Creating a Command

// plugins/commands/ping.js
module.exports = {
  config: {
    name: "ping",
    aliases: ["p"],
    description: "Check bot responsiveness.",
    author: "Tas33n",
    cooldown: 5,
    role: 0,
    category: "utility"
  },
  onCmd: async ({ reply }) => {
    reply("Pong!");
  }
};

🧠 Event Listener Example

// plugins/events/welcome.js
module.exports = {
  config: {
    name: "welcome",
    author: "Anbuinfosec",
    category: "events"
  },
  onEvent: async ({ api, event }) => {
    if (event.action !== "add") return;
    for (const user of event.participants) {
      api.sendMessage(event.id, {
        text: `👋 Welcome @${user.split("@")[0]}`,
        mentions: [user]
      });
    }
  }
};

For detailed documentation, see DOCS.md

---

📸 Previews

🤖 Bot Commands

• Bot sample commands

📊 Dashboard UI

• Admin Login Page
• Bot Dashboard
• Admin command dashboard

---

🙋‍♂️ Contributing

We welcome contributions from developers of all skill levels! Whether it's fixing bugs, suggesting features, or improving documentation — your input makes this project better.

Please feel free to open an issue or submit a pull request.

---

🚫 Respect the Project & Credits

This project is licensed under the MIT License, which allows you to use and modify it freely. However, please do not remove author credits or attempt to rebrand this project as your own.

Doing so hurts community collaboration and makes it harder to track real improvements. If you want to build on this, we encourage you to fork it and credit the original authors so others know where the foundation came from.

Let’s build better tools — together.

---

🙌 Authors

• 👨‍💻 Lead Author: Tas33n
• 🛡 Co-Author: Anbuinfosec

---

🙏 Acknowledgements

• 🐐 GoatBot V2 – A Messenger chatbot project that inspired the modular plugin-based architecture and command flow.
• 📡 Baileys – For their awesome WhatsApp Web API library that powers the bot.
• 🤖 ChatGPT – For help with writing, refactoring, and improving documentation, Docker setup, and best practices.

---

💰 Support & Donations

If you find this project helpful and want to support further development, donations are appreciated 🙏

🏦 Binance Pay

Binance ID: 471390205

💵 USDT (TRC-20)

TR95UPDfsB1Ammyj4w62xDuAJEA8wH5GSz

💸 Litecoin (LTC)

LeaKUHCiAhRa6U3jrQa4bCAvaAfniJ6pXP

💸 Bitcoin (BTC)

16NyoNtkDk8uHejqNsKkhpc8RyPEEfu1m9

---

📜 License

This project is licensed under the MIT License – see the LICENSE file.