playgowa
v1.0.0
Published
Un paquete de WhatsApp Bot para empresas, potente y configurable.
Maintainers
Readme
PlayGoWa
Descripción
PlayGoWa es una poderosa y flexible librería de Node.js diseñada para ayudarte a crear bots de WhatsApp Business personalizables. Construido sobre Baileys, ofrece funcionalidades esenciales como auto-respuestas configurables, integración con ChatGPT (usando un scraper), gestión básica de usuarios y un sistema de tickets simple, todo gestionado mediante archivos JSON para una fácil persistencia de datos.
Además, PlayGoWa incluye una interfaz de línea de comandos (CLI) intuitiva que permite a las empresas y usuarios configurar y gestionar su bot de WhatsApp sin necesidad de modificar directamente el código.
Características Principales
- Bot de WhatsApp para Empresas: Conecta tu número de WhatsApp Business y automatiza interacciones.
- Auto-Respuestas Configurables: Define respuestas automáticas a palabras clave o frases específicas. Fácilmente gestionable a través del CLI.
- Integración con ChatGPT (Scraper): Responde a consultas complejas utilizando la inteligencia de ChatGPT, sin necesidad de una API Key oficial (requiere Google Chrome/Chromium instalado localmente).
- Gestión de Usuarios: Registra automáticamente los usuarios que interactúan con el bot en un archivo JSON.
- Sistema de Tickets Básico: Permite a los usuarios crear tickets, guardando la información en un archivo JSON para seguimiento.
- Interfaz de Línea de Comandos (CLI): Herramienta interactiva para configurar auto-respuestas y futuras funcionalidades sin tocar el código.
- Generación de QR: Facilita el inicio de sesión escaneando un código QR en la terminal.
- Persistencia de Datos: Toda la configuración y los datos de usuarios/tickets se guardan en archivos JSON locales (playgowa_data/).
Instalación
Prerrequisitos
- Node.js: Versión 16.x o superior.
- npm: Gestor de paquetes de Node.js (viene con Node.js).
- Google Chrome o Chromium: Esencial para que el scraper de ChatGPT funcione, ya que puppeteer lo requiere para simular un navegador. Asegúrate de tenerlo instalado en el sistema donde ejecutarás el bot.
Pasos de Instalación
Crea un nuevo proyecto Node.js (si aún no lo tienes):
mkdir mi-bot-whatsapp cd mi-bot-whatsapp npm init -Instala PlayGoWa como una dependencia en tu proyecto:
npm install playgowaEsto también instalará todas las dependencias necesarias como @whiskeysockets/baileys, axios, pino, qrcode-terminal, inquirer, chatgpt-scraper y puppeteer.
Uso
Código de Ejemplo
Para iniciar tu bot, crea un archivo index.js (o app.js) en la raíz de tu proyecto con el siguiente contenido:
javascript
const PlayGoWa = require('playgowa');
const { log } = require('playgowa/src/utils/logger'); // Importa el logger si quieres usarlo en tu script principal
const main = async () => {
log.info('Iniciando tu bot PlayGoWa...');
const bot = new PlayGoWa();
// Para la primera vez, el bot mostrará un código QR en la terminal.
// Escanéalo con tu aplicación de WhatsApp en tu teléfono.
// La sesión se guardará automáticamente en la carpeta 'playgowa_auth_info'.
// Los datos del bot (respuestas, usuarios, tickets) se guardarán en 'playgowa_data'.
await bot.init();
};
main().catch(err => {
log.error('Error al iniciar el bot:', err);
process.exit(1);
});Luego, ejecuta este archivo desde tu terminal
node src/index.js
Uso del CLI (Command Line Interface) PlayGoWa viene con un CLI que facilita la configuración del bot. Iniciar el bot (Primera vez - Para escanear QR): Necesitarás escanear el código QR con tu teléfono WhatsApp. Usa este comando solo la primera vez o cuando pierdas la sesión.
npm run cli startDev
O directamente si tienes el binario linkeado:
playgowa startDev
Iniciar el bot (Modo de Producción / Sesión Guardada): Una vez que hayas escaneado el QR y el bot se haya conectado exitosamente, puedes usar este comando para iniciarlo sin el menú interactivo, utilizando la sesión guardada.
npm start
O directamente:
playgowa start
Acceder al Menú de Configuración del CLI: Para gestionar tus auto-respuestas u otras configuraciones futuras, usa el comando playgowa sin argumentos. Esto abrirá un menú interactivo:
npm run cli
O directamente:
playgowa
Una vez dentro del menú, selecciona 2. Agregar Auto-Respuesta para añadir o modificar respuestas automáticas para tu bot. Las respuestas se guardarán en playgowa_data/responses.json. Ejemplo de interacción al agregar una respuesta:
Bienvenido a PlayGoWa CLI!
? ¿Qué quieres hacer? (Use arrow keys)
> 1. Iniciar Bot (modo de desarrollo)
2. Agregar Auto-Respuesta
3. Ver Auto-Respuestas existentes
4. Ver Usuarios Registrados
5. Ver Tickets Abiertos
6. SalirCreador
Esta libreria esta desarrollada por el equipo JJSnice, por Ondarion, y puede que demore un poco en sacar actualizaciones, no esta disposible un host.
