Skip to content

itsliaaa/starseed

Repository files navigation

✴️ @itsliaaa/starseed

Logo

Starseed is a simple WhatsApp bot designed for quick setup and efficient use. It offers essential features such as sticker creation, social media content downloading, basic group management tools, and various general-purpose utilities, all accessible directly through WhatsApp.

Caution

This project is a direct implementation of @itsliaaa/baileys. If you choose to replace it with any other fork, all resulting issues or bugs are entirely your responsibility.

⚙️ Architecture Overview

Principle Implementation
⚡ Native ESM Architecture Fully structured using modern ECMAScript Modules (type: module) and designed for Node.js >=20.18.1 environments.
🪶 Lean Dependency Strategy Minimal, purpose-specific dependencies to keep the runtime lightweight.
🧩 Runtime Minimalism No obfuscation or bundling layers are used, ensuring predictable execution and optimal performance.

📄 System Requirements

🔹 Minimum ✨ Recommended
1 vCPU 1 vCPU
512 MB RAM 1 GB RAM
1 GB Free Space 2 GB Free Space
FFmpeg v6.x.x FFmpeg v6.x.x
Node.js v20.18.1 LTS Node.js v24.x.x LTS
Yarn v1.x.x Yarn v1.22.22

🗄️ Server

To run the bot, I highly recommend the following services. They are not only affordable, but also ensure that user data stored in the database remains secure:

⬇️ How to Download

DownloadStep

  1. Click the Code button.
  2. Select Download ZIP.
  3. Extract the downloaded file.

📥 Installation & Run

Important

Check this repository regularly for updates. The project is still under development. If you encounter any issues, please open an issue. Thank you!

Note

The installer supports Linux, macOS (Darwin), and Android (Termux).

I’m not familiar with Windows because I primarily use Linux, so no Windows installation files are provided.

Make sure your system meets the required dependencies. Then run:

bash install.sh

After installation completes, start the bot using pm2:

pm2 start app.config.cjs && pm2 logs bot

🔧 Configuration

Edit config.json to customize the bot:

Object.assign(global, {
   // Owner name
   ownerName: 'Lia Wynn',

   // Owner phone number
   ownerNumber: '6281111',

   // Bot name
   botName: 'Starseed',

   // Footer text
   footer: '✦ Starseed',

   // [IMPORTANT] Bot phone number for pairing code
   botNumber: '6281111',

   // Pairing using code method (set to true for pairing code, false for QR pairing)
   pairingCode: false,

   // User default limit (used for reset too)
   defaultLimit: 15,

   // Sticker pack name
   stickerPackName: '📦 Starseed Sticker',

   // Sticker pack publisher
   stickerPackPublisher: 'GitHub: itsliaaa',

   // ********** API KEYS ********** //

   // Google AI Studio for Chat Bot @ https://aistudio.google.com/
   googleApiKey: '',

   // SightEngine for Anti Porn @ https://sightengine.com/
   apiUser: '',
   apiSecret: '',

   // ...
})

📁 Plugins

You can follow this format to add your own plugins:

export default {
   command: 'your_command',
   hidden: 'your_hidden_command',
   category: 'your_category_name',
   async run(m, {
      sock,
      // ...other values from handler.js
   }) {
      /* YOUR LOGIC HERE */
   },
   group: false, // is this command only for group chats?
   private: false, // is this command only for private chats?
   owner: false, // is this command only for the owner?
   partner: false, // is this command only for partners?
   admin: false, // is this command only for group admins?
   botAdmin: false, // does this command require the bot to be a group admin?
   limit: 1 // command usage cost
}

See the documentation in @itsliaaa/baileys for details about sending interactive messages.

👤 Credits

Starseed is an independent project built and maintained by:

  • itsliaaa — Project Maintainer & Creator

Support this project:

🌐 Third-Party Services

Starseed utilizes the following external APIs:

These services are used as external integrations and are not directly affiliated with the development of Starseed.

🧪 Testers & Community

Special thanks to:

  • Starseed Group Members
  • And of course… You

Your feedback and support help this project continue to grow 🌱