GitHub - XdKing2/star-xd: ✨ Star XD - Advanced WhatsApp bot with AI features, media tools, and group management. Built on Baileys by Malvin King.

BOT FEATURE ⤵️

Menu ➜	Status Save + Send	Group	ChatBot	Downloading	Antidelete	Ai	Viewonce	Fun	Status Reply	Status Reacts	HeartReacts	Autoreacts	Call Rejecter	Polls	Broadcast
Work ➜	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅

🚀 Fork the Repository

Warning

Security Alert: Never use your personal WhatsApp number as the bot number! WhatsApp may detect automated activity and permanently ban your account. Always use a dedicated/secondary number for bot deployment.

Important

Fork Required: You must fork the STAR-XD repository first before accessing the session pairing web interface!

🌐 Session Web ⤵️

Server 1

Server 2

Server 3 (Coming Soon)

Note

Server down? Try an alternative. Your session ID works on all servers.

📡 DEPLOYMENT OPTIONS

🌐 Cloud Platforms

🎯 Other Platforms

💡 TIP: For best performance on cloud platforms, use MongoDB Atlas for database storage and set COMMAND_MODE=public.

Note

For Pterodactyl-based panels, use a Node.js 20+ egg and set startup command to npm install && npm start.

Important

Ensure your panel uses Node.js 20 or newer. If your panel supports Docker, use the included Dockerfile for best compatibility.

📡 PANEL DEPLOYMENT OPTIONS

🎮 Panel Hosting

• HOST ON DISCORD / PANEL

Get the latest STAR-XD bot zip file for panel-based deployment:

✅ Deploy to any panel service of your choice.

🛠️ VPS / Hosting Panels

Note

For Pterodactyl-based panels, use a Node.js 20+ egg and set startup command to npm install && npm start.

Important

Ensure your panel uses Node.js 20 or newer. If your panel supports Docker, use the included Dockerfile for best compatibility.

📱 TERMUX DEPLOYMENT

pkg update && pkg upgrade -y
pkg install proot-distro -y
proot-distro install ubuntu
proot-distro login ubuntu

# Inside Ubuntu
apt update && apt upgrade -y
apt install -y git ffmpeg build-essential libvips-dev webp nodejs npm curl

git clone https://github.com/XdKing2/star-xd.git
cd star-xd
npm install
cp sample.env .env && nano .env
npm start

Keep running after closing Termux:

apt install tmux -y
tmux new -s star-xd
npm start
# Detach: Ctrl+B → D
# Re-attach: tmux attach -t star-xd

Note

Termux on Android requires storage permission. Run termux-setup-storage if needed.

Tip

Use tmux to keep the bot running even after closing Termux. Your session stays active!

🖥️ VPS / LINUX SERVER

One-line install (recommended):

sudo bash <(curl -fsSL https://raw.githubusercontent.com/XdKing2/star-xd/main/lib/install.sh)

Manual:

curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt install -y nodejs git ffmpeg libvips-dev libwebp-dev build-essential

git clone https://github.com/XdKing2/star-xd.git
cd star-xd
npm install
cp sample.env .env && nano .env

# Keep alive with PM2
npm install -g pm2
pm2 start dist/index.js --name star-xd
pm2 save && pm2 startup

PM2 commands:

Command	Description
pm2 logs star-xd	Live logs
pm2 restart star-xd	Restart
pm2 stop star-xd	Stop
pm2 status	Status overview

Important

This one-line installer automatically sets up Node.js 20, ffmpeg, libvips, libwebp, PM2, clones the repo, and configures everything.

Tip

PM2 automatically restarts your bot if it crashes. Use pm2 startup to enable auto-start on server reboot.

🐳 DOCKER DEPLOYMENT

# Pull pre-built image (no build required)
docker pull quay.io/mrxdking/star-xd:latest

# Run with your credentials
docker run -d \
  -e SESSION_ID="star~YOUR_SESSION_ID" \
  -e OWNER_NUMBER="YOUR_WHATSAPP_NUMBER" \
  -e BOT_NAME="STAR XD" \
  -e COMMAND_MODE="public" \
  -p 5000:5000 \
  --name star-xd \
  quay.io/mrxdking/star-xd:latest

# View logs
docker logs -f star-xd

[!NOTE] Get your Session ID from the pairing servers above. Replace YOUR_SESSION_ID and YOUR_WHATSAPP_NUMBER with your own.

The image is pre-built on Quay.io with all dependencies included. No building required!

Tip

For persistent storage, mount a volume: -v $(pwd)/data:/app/data

Warning

🔒 Security Critical: Never share your .env file or SESSION_ID publicly! Anyone with access to your session credentials can completely control your bot and WhatsApp account. Keep these files private and secure.

⚙️ CONFIGURATION

cp sample.env .env

# ── REQUIRED (choose one) ────────────────────────────────────
SESSION_ID=star~your_cloud_id_here
# OR
PAIRING_NUMBER=263714757857

# ── REQUIRED ─────────────────────────────────────────────────
OWNER_NUMBER=263700000000        # No + sign

# ── BOT IDENTITY ─────────────────────────────────────────────
BOT_NAME=star-xd
BOT_OWNER=mrxdking
PACKNAME=star-xd

# ── BEHAVIOUR ────────────────────────────────────────────────
PREFIXES=.,!,/                   # Comma-separated
COMMAND_MODE=public              # public or private
TIMEZONE=Africa/Zimbabwe 

# ── OPTIONAL API KEYS ────────────────────────────────────────
REMOVEBG_KEY=                    # https://remove.bg/api
GIPHY_API_KEY=                   # https://developers.giphy.com

# ── PERFORMANCE ──────────────────────────────────────────────
PORT=5000
MAX_STORE_MESSAGES=50

# ── DATABASE (all empty = JSON files) ────────────────────────
MONGO_URL=
POSTGRES_URL=
MYSQL_URL=
DB_URL=                          # SQLite: ./data/baileys.db

Caution

⚠️ Cloud Platform Data Loss: Heroku, Render, Railway, and similar cloud platforms reset the entire filesystem on every restart/redeploy. All local data (JSON files, session, media) will be permanently lost. Always use MongoDB or PostgreSQL for persistent data storage on cloud platforms!

🗄️ STORAGE BACKENDS

Set one database URL in .env. If all are empty, JSON file storage is used automatically.

Backend	Badge	Best For
JSON Files		Local, Termux
MongoDB		Cloud (recommended)
PostgreSQL		Cloud / VPS
MySQL		Cloud / VPS
SQLite		VPS

# MongoDB (Recommended for cloud)
MONGO_URL=mongodb+srv://user:[email protected]/starxd

# PostgreSQL
POSTGRES_URL=postgresql://user:password@host:5432/starxd

# MySQL
MYSQL_URL=mysql://user:password@host:3306/starxd

# SQLite
DB_URL=./data/baileys.db

Tip

Get a free MongoDB cluster at MongoDB Atlas — best choice for cloud deployments.

Important

Cloud platforms (Heroku, Render, Railway) reset filesystem on restart. Always use MongoDB or PostgreSQL for persistent storage.

🔌 PLUGIN SYSTEM

Plugins live in plugins/ and auto-load on startup.

export default {
    command: 'mycommand',
    aliases: ['mc'],
    category: 'utility',
    description: 'Does something cool',
    
    // Optional permission flags
    ownerOnly: false,
    groupOnly: false,
    adminOnly: false,
    cooldown: 5,
    
    async handler(sock, message, args, context) {
        const { chatId, senderId, isGroup, config } = context;
        
        await sock.sendMessage(chatId, {
            text: `You said: ${args.join(' ')}`
        });
    }
};

Important

Each plugin file must export a default object with command, handler, and optional fields.

Note

Plugins are auto-detected. No registration needed! Just drop a .js or .ts file in the plugins/ folder.

🔧 TROUBLESHOOTING

Bot not connecting

· Verify SESSION_ID is correct and starts with star~ · Reset session: npm run reset-session && npm start · If using PAIRING_NUMBER, link within 60 seconds of code appearing

Commands not responding

· Check you're using the right prefix (default .) · COMMAND_MODE=private → only owner can use commands · OWNER_NUMBER must have no + sign

Data lost after restart

· Cloud platforms reset the filesystem on redeploy · Add MONGO_URL to use MongoDB — MongoDB Atlas has a free tier

myAppStateKey not present error

node -e "
const fs = require('fs');
const c = JSON.parse(fs.readFileSync('session/creds.json','utf8'));
delete c.myAppStateKeyId;
fs.writeFileSync('session/creds.json', JSON.stringify(c, null, 2));
console.log('Done');
"
npm start

Tip

After fixing the myAppStateKey error, send any message to the bot — WhatsApp re-syncs keys automatically.

⚠️ DISCLAIMER

⚖️ Legal & Usage Notice

🚫 Not Affiliated with WhatsApp:

STAR-XD is an independent project and is NOT affiliated with WhatsApp Inc.

⚠️ Account Ban Risk:

Misuse or improper use may result in permanent WhatsApp account bans
WhatsApp may detect automated activity and suspend your account
Never use your personal number — always use a dedicated/secondary number
Use this bot responsibly and at your own risk

🛡️ Developer Liability:

The developers are NOT responsible for:
- Account bans or suspensions
- Legal consequences or issues
- Data loss or security breaches
- Misuse of the bot by users
Users assume full responsibility for compliance with WhatsApp's Terms of Service

📜 Usage Terms:

This project is provided for educational purposes only
Redistribution, modification, or commercial use without proper attribution is prohibited
Automated messaging and bulk operations may violate WhatsApp policies
By using this bot, you acknowledge and accept all risks and terms

✅ By deploying or using STAR-XD, you confirm that you:

Understand the risks of automated WhatsApp bots
Will use a dedicated number (not your personal account)
Accept full responsibility for any consequences
Agree to comply with WhatsApp's Terms of Service

Caution

⚠️ Final Warning: WhatsApp actively monitors for automated bot activity. Your account may be temporarily or permanently banned without warning. Deploy at your own risk and never use your primary WhatsApp account.

💡 CREDITS & CONTRIBUTORS

Built with ❤️ by Malvin King

· 👤 Malvin King — Creator & Maintainer · Core features, plugin manager, deployment tools, performance optimization · 🌟 Special Thanks to all Contributors and Star Supporters!

Note

Want to contribute? Fork the repo, create your plugin, and submit a Pull Request!

🌐 JOIN OUR SUPPORT CHANNELS

🔔 Stay connected for updates, feature drops, and tutorials!

Platform	Link
▶️ YouTube
💬 Telegram
📱 WhatsApp Channel
🐙 GitHub
❓ Issues

Tip

Join the WhatsApp Channel for instant updates on new features and fixes!

🤖 STAR-XD STATUS

+ Project Status: Active & Regularly Updated
! Version: V.3.5.0 Neon Edition
# License: MIT
+ Support: 24/7 Community Support
! Features: 250+ Commands & Growing
+ Database: 5 Storage Backends

💫 Thanks to our loyal followers

⭐ If this project helped you, please give it a star! ⭐

Made with ❤️ by Malvin King

Name		Name	Last commit message	Last commit date
Latest commit History 81 Commits
.github/workflows		.github/workflows
lib		lib
.gitignore		.gitignore
.replit		.replit
Dockerfile		Dockerfile
Procfile		Procfile
README.md		README.md
app.json		app.json
eslint.config.mjs		eslint.config.mjs
fly.toml		fly.toml
heroku.yml		heroku.yml
index.js		index.js
malvin.json		malvin.json
nodemon.json		nodemon.json
package-lock.json		package-lock.json
package.json		package.json
railway.json		railway.json
render.yaml		render.yaml
replit.nix		replit.nix
sample.env		sample.env
settings.js		settings.js

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

🚀 Fork the Repository

🌐 Session Web ⤵️

🌐 Cloud Platforms

🎯 Other Platforms

🎮 Panel Hosting

🛠️ VPS / Hosting Panels

⚖️ Legal & Usage Notice

💫 Thanks to our loyal followers

About

Uh oh!

Releases

Packages

Uh oh!

Contributors

Uh oh!

Languages

Folders and files

Latest commit

History

Repository files navigation

🚀 Fork the Repository

🌐 Session Web ⤵️

🌐 Cloud Platforms

🎯 Other Platforms

🎮 Panel Hosting

🛠️ VPS / Hosting Panels

⚖️ Legal & Usage Notice

💫 Thanks to our loyal followers

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

Packages