orion-wa

v2.0.1

Published

3 months ago

A powerful and modular WhatsApp bot framework based on Baileys.

Downloads

0High
0Medium
0Low

hendprw

whatsapp bot baileys framework modular

✨ Fitur Inti

⚡️ Sistem Perintah Modular: Atur perintah Anda dalam file-file terpisah yang bersih untuk manajemen yang mudah.
🔄 Hot Reloading: Perbarui, tambah, atau hapus perintah secara real-time tanpa me-restart seluruh bot.
🛡️ Arsitektur Middleware: Cegat dan proses pesan sebelum perintah dieksekusi. Sempurna untuk validasi, logging, atau modifikasi. Mendukung middleware bawaan dan kustom.
⚙️ Validasi Argumen Otomatis: Definisikan aturan untuk argumen perintah (misalnya, jumlah, tipe) langsung di objek perintah untuk validasi otomatis.
⏱️ Sistem Antrian & Rate Limiting: Kontrol beban kerja bot dengan sistem antrian per-pengguna dan global yang dapat dikonfigurasi untuk mencegah spam dan overload.
🛠️ Helper Socket yang Ditingkatkan: Objek sock dilengkapi dengan puluhan fungsi pembantu praktis seperti sock.reply, sock.sendImage, sock.downloadMedia, dan banyak lagi.
📦 Fitur Bawaan Siap Pakai: Aktifkan dengan mudah perintah umum (ping, add, remove) dan acara grup (penyambutan, selamat tinggal) langsung dari file .env Anda.

🚀 Instalasi & Mulai Cepat

1. Instalasi

Mulai proyek baru dan instal dependensi yang diperlukan. Untuk pengalaman terbaik, gunakan CLI create-orion-bot.

npx orion-installer nama-bot-saya
cd nama-bot-saya
npm start

-----S

2. Struktur Proyek

Atur proyek Anda dengan struktur berikut untuk skalabilitas maksimum.

my-bot/
├── commands/
│   └── utility/
│       └── ping.js
├── middlewares/
│   └── checkPremium.js
├── session/
├── .env
└── index.js

3. Titik Masuk `index.js`

File ini adalah jantung dari bot Anda.

//index.js
require('dotenv').config();
const { Bot } = require('orion-wa');
const path = require('path');

// Inisialisasi Orion Bot dengan konfigurasi Anda
const bot = new Bot({
    // Path ke direktori perintah kustom Anda
    commandsPath: path.join(__dirname, 'commands'),
    
    // (Opsional) Path ke direktori middleware kustom Anda
    middlewaresPath: path.join(__dirname, 'middlewares'),
});


bot.connect();

(Konsep Inti)

Memahami konsep inti Orion adalah kunci untuk membuka potensi penuhnya.

🔹 Objek Perintah

Setiap file .js di dalam direktori commands Anda adalah modul perintah. Ia harus mengekspor objek dengan properti berikut:

Contoh Perintah: commands/utility/kick.js

module.exports = {
    name: 'kick',
    aliases: ['tendang'],
    description: 'Mengeluarkan anggota dari grup.',
    category: 'admin',
    isGroupOnly: true,
    isAdminOnly: true,
    isBotAdminOnly: true,
    // Aturan validasi untuk argumen
    args: {
        min: 1,
        usage: '@mention',
        types: ['mention']
    },
    // Menjalankan middleware kustom (jika ada)
    middlewares: ['logKickAction'], 
    
    async execute(sock, m) {
        const targetJid = m.mentionedJid[0] || m.quoted.sender;
        await sock.groupParticipantsUpdate(m.chat, [targetJid], 'remove');
        await sock.reply(m, `Berhasil mengeluarkan @${targetJid.split('@')[0]}`);
    }
};

🔹 Arsitektur Middleware

Middleware adalah fungsi yang berjalan di antara parsing pesan dan eksekusi perintah. Gunakan untuk validasi, logging, atau memodifikasi permintaan.

Middleware Bawaan: Diaktifkan dengan properti boolean pada objek perintah seperti isGroupOnly: true.
Middleware Kustom: Buat file di direktori middlewares/ Anda, lalu terapkan menggunakan properti middlewares: ['namaMiddleware'] pada perintah.

Contoh Middleware Kustom: middlewares/isBotAdmin.js

// src/middlewares/isBotAdminOnly.js
module.exports = {
    name: 'isBotAdminOnly',
    execute: async (sock, m, command) => {
        if (command.isBotAdminOnly && !m.isBotAdmin) {
            await sock.reply(m, 'Bot harus menjadi admin untuk menjalankan perintah ini.');
            return false;
        }
        return true;
    }
};

🔹 Objek Pesan yang Di-parse (`m`)

Setiap perintah dan middleware menerima objek pesan m yang sudah di-parse untuk interaksi yang mudah.

⚙️ Konfigurasi (`.env`)

Buat file .env di root proyek Anda untuk mengonfigurasi bot Anda.

# --- KONFIGURASI INTI ---
SESSION_NAME=mysession
PREFIX=!

# --- FITUR BAWAAN (atur ke 'true' untuk mengaktifkan) ---
BUILTIN_COMMAND_PING_ENABLED=true
BUILTIN_COMMAND_ADD_ENABLED=true
BUILTIN_COMMAND_REMOVE_ENABLED=true

# --- EVENT GRUP BAWAAN ---
BUILTIN_WELCOMER_ENABLED=true
BUILTIN_WELCOMER_MESSAGE="Hai %%mention%%! Selamat datang di %%group%%."
BUILTIN_GOODBYE_ENABLED=true
BUILTIN_GOODBYE_MESSAGE="Yah, %%mention%% telah meninggalkan kita..."

# --- PENGATURAN ANTRIAN (RATE LIMIT) ---
# Aktifkan sistem antrian untuk mencegah spam dan overload
QUEUE_ENABLED=true
# Pengaturan Antrian Global (mengontrol semua perintah dari semua pengguna)
QUEUE_GLOBAL_CONCURRENCY=20
QUEUE_GLOBAL_INTERVAL_CAP=60
QUEUE_GLOBAL_INTERVAL=1000
# Pengaturan Antrian per Pengguna (mengontrol satu pengguna)
QUEUE_PER_USER_CONCURRENCY=1
QUEUE_PER_USER_INTERVAL_CAP=3
QUEUE_PER_USER_INTERVAL=1500

🤝 Berkontribusi

Kontribusi adalah apa yang membuat komunitas sumber terbuka menjadi tempat yang luar biasa untuk belajar, menginspirasi, dan berkreasi. Setiap kontribusi yang Anda buat sangat dihargai.

Jika Anda memiliki saran yang akan membuat ini lebih baik, silakan fork repo dan buat pull request. Anda juga bisa langsung membuka issue dengan tag "enhancement".

Fork Proyek
Buat Cabang Fitur Anda (git checkout -b feature/FiturLuarBiasa)
Commit Perubahan Anda (git commit -m 'Menambahkan FiturLuarBiasa')
Push ke Cabang (git push origin feature/FiturLuarBiasa)
Buka Pull Request

📜 Lisensi

Proyek ini didistribusikan di bawah Lisensi MIT. Lihat LICENSE untuk informasi lebih lanjut.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme