Xstro WA Bot

Important

Open-source WhatsApp bot designed to handle various tasks and perform automated services for both basic and business users. I disclaim any and all liability for any misuse of this software. It is for educational purposes only—please use it responsibly.

Features and Development

Note

Below is a comprehensive and easy-to-understand guide on how to create your custom functionalities and specifications. Some of you might wonder why I didn't add fun features like games, etc. It's a WhatsApp bot, and those features are not the focus of this project. Implement those at your end if needed.

Create your own session

1. Session Generator
2. Session Encryptor

• A detailed usage guide is provided in the repositories on how to use them properly. Also, use PostgreSQL to save sessions. Again, if you try to steal your users' sessions using such methods, I condemn you and your tactics, as I strongly oppose this and any method of social engineering.

How can I create a command?

It's easy, but first, I want you to know and understand the Types of our command structure and serialized messages.

/** Values of our Command Definitions **/

interface Command {
  name: RegExp | string;
  function?: Function;
  fromMe?: boolean;
  isGroup?: boolean;
  desc: string | undefined;
  type: string | undefined;
  dontAddCommandList?: boolean;
}

/** Values of our Message Definitions **/
import { WAProto, WASocket } from 'baileys';

export interface Message {
    key: {
        remoteJid: string;
        fromMe: boolean;
        id: string;
        participant?: string | undefined;
    };
    jid: string;
    pushName: string | null | undefined;
    messageTimestamp: number | Long.Long;
    owner: string;
    message: WAProto.IMessage | undefined;
    type: string;
    device: string;
    sender: string | null | undefined;
    prefix: string[];
    mod: boolean;
    ban: boolean;
    sudo: boolean;
    text: string | null | undefined;
    quoted?: {
        key: {
            remoteJid: string;
            fromMe: boolean;
            id: string;
            participant?: string | undefined;
        };
        message: WAProto.IMessage | undefined,
        type: string | undefined;
        sender: string | undefined;
        device: string;
        ban: boolean;
        sudo: boolean;
        text: string | null | undefined;
        image: boolean;
        video: boolean;
        audio: boolean;
        document: boolean;
        viewonce: boolean;
    };
    send: (content: Buffer | string, options?: any) => Promise<Message | any>;
    edit: (content: string) => Promise<Message>;
    forward: (jid: string, message: any, opts?: any) => Promise<any>;
    reply: (text: string) => Promise<Message>;
    downloadM: (message: any, file?: boolean) => Promise<ArrayBuffer | any>;
    delete: () => Promise<Message>;
    react: (emoji: string) => Promise<Message>;
    user: (match: string) => Promise<string | false>;
    error: (error: Error, cmd: string | RegExp) => Promise<void | any>,
    client: WASocket
}

How do I use them now?

/** Import the Module function and Message Types **/
import { Module, Message } from '../src/index.mjs'

/** Define a Module, a command register **/
Module(
  {
    name: 'hello', // name of the command
    fromMe: false, // is the command for sudo users? make it true if it should respond only to sudo users
    isGroup: false, // use this only if you want the command to work in a group!
    desc: 'Greetings', // provide the description of the command if you want it to appear on the list
    type: 'system', // specify the type or category which the command falls under
  },
  async (message: Message) => {
    await message.send('hi, I just replied to you') // send a message; this send function supports only text, image, video, and audio
  }
);

Send a Message

await message.send('hi')

Edit a Message

const msg = await message.send('hi') // Make sure to define a returnable instance of serialize in order to callback the edit to edit this message; otherwise, it would edit the message you sent yourself, not the target message.
await msg.edit('hello') // Edits it to the new value (String only)

Forward a Message

const jid = `12345678990@whatsapp.net`
const msg = await message.send('Hello, this is an instance that will be forwarded')
await message.forward(jid, msg, {quoted: msg}) // forwards the message; jid and the message are mandatory, quoted is an optional parameter

Basic Reply

await message.reply('Okay, you got it!') // Just reply to a message; it supports only text

Download a Message

const msg = await message.send(ImageBuffer) // sends an image, could be video, audio

await message.downloadM(msg) // Downloads the message as a buffer

/** If you want to save the downloaded file **/
await message.downloadM(msg, true)

Delete a Message

await message.delete() // deletes your message; if you reply to a message when you call this, it would delete the replied message and not yours

React to a Message

await message.react('😍') // react to a message; if you reply to a message, it would react to that and not the one you sent

Custom Events

/** Import the Types **/
import { Message } from '../../../src/index.mjs';

export async function greetingsListener(message: Message) {
  if (message.text.startsWith('Good Morning')) {
    // you can add regex for that if checker
    return message.reply(`${message.pushName}, Good Day`)
  }
}

Tip

These custom events depend on the type of Baileys event listeners. Make sure you create them based on the correct one; otherwise, they won't work.

Start Contributing

Want to help? Fork the repository, create a pull request, and make sure everything works.