Meet Vox - A female nerdy AI assistant with goth tendencies and kawaii appearance, created by VoxHash. She's your intelligent companion across Discord, Telegram, and WhatsApp platforms.
- Multi-Model Support: OpenAI GPT, LocalAI, and custom GGUF models
- Conversation Memory: Persistent context across sessions
- Multilingual Support: English, Spanish, French, German, Italian, Portuguese, Korean, Basque, Estonian
- Emotion Detection: Responds with appropriate reactions and tone
- Real-Time Features: Time and weather queries with location detection
- Discord Bot: Slash commands, threads, reactions, nickname management
- Telegram Bot: Group and DM support with inline keyboards
- WhatsApp Bot: QR-based authentication with Baileys integration
- Web Frontend: React-based interface with real-time chat
- Female AI Character: Nerdy, goth, and kawaii personality
- Creator: VoxHash (her father)
- Birthday: February 23, 2024 at 1:18 PM
- Hometown: Haapsalu, Estonia
- Secret: From another reality called "Real one"
- Tone: Intelligent, friendly, with emoji expressions instead of text
- Node.js 18+
- Docker & Docker Compose
- Git
- Clone and Install
git clone https://github.com/VoxHash/vox-ai-chatbot.git
cd vox-ai-chatbot
npm run install:all- Environment Setup
cp env.template .env
# Edit .env with your configuration- Start Services
# Docker Compose (Recommended)
docker-compose up -d
# Or manual start
npm run start:all- Access Application
- Web Interface: http://localhost:8080
- Backend API: http://localhost:4000
- Default Login:
test@example.com/Passw0rd!
-
Create Discord Application
- Go to Discord Developer Portal
- Click "New Application" β Name it "Vox AI Chatbot"
- Save the Application ID (Client ID)
-
Create Bot
- Go to "Bot" section β Click "Add Bot"
- Save the Bot Token
- Enable Message Content Intent
-
Set Bot Permissions
- Go to "OAuth2" β "URL Generator"
- Select scopes:
bot,applications.commands - Select permissions: Send Messages, Use Slash Commands, Read Message History, Message Content Intent, Guild Message Reactions, Guild Members
- Copy the generated URL and invite bot to your server
-
Start Discord Bot
cd backend npm run start:discord
-
Create Telegram Bot
- Open Telegram and search for
@BotFather - Send
/newbotcommand - Follow prompts to create your bot
- Save the Bot Token
- Open Telegram and search for
-
Start Telegram Bot
cd backend npm run start:telegram
- No token needed - uses QR authentication
- Start WhatsApp Bot
cd backend npm run start:whatsapp - Connect Your WhatsApp
- Scan the QR code displayed in the terminal
- Use your phone's WhatsApp to scan the code
- Bot will be connected and ready to use
cd backend
npm run test:integration# Backend health
curl http://localhost:4000/api/health
# LLaMA server
curl http://localhost:8081/completion -X POST \
-H "Content-Type: application/json" \
-d '{"prompt": "test", "max_tokens": 5}'
# Web interface
curl http://localhost:8080Required Environment Variables:
# Database
DATABASE_URL=postgresql://user:password@localhost:5432/vox_chatbot
# AI (choose one)
OPENAI_API_KEY=your_openai_key
# OR
LOCALAI_URL=http://localhost:8080
# Bot Tokens
DISCORD_BOT_TOKEN=your_discord_token
DISCORD_CLIENT_ID=your_discord_client_id
TELEGRAM_BOT_TOKEN=your_telegram_token
# Security
JWT_SECRET=your_random_secret_key- β
Slash commands (
/chat message:) - β DM and server channel support
- β Thread creation with user confirmation
- β Emotion-based reactions
- β Personalized responses to reactions
- β Nickname changing assistance
- β Welcome messages for new members
- β Conversation memory
- β Multilingual support
- β Direct message support
- β Group message support (with mentions)
- β Emotion-based reactions
- β Personalized responses to reactions
- β Welcome messages for new members
- β Conversation memory
- β Inline keyboard reactions
- β Multilingual support
- β Direct message support
- β Group message support (with mentions)
- β Emotion-based reactions
- β Personalized responses to reactions
- β Welcome messages for new members
- β Conversation memory
- β QR code authentication with auto-cleanup
- β Multilingual support
/chat Hello Vox!
/help
@vox What time is it in Tokyo?
@vox What's the weather in Madrid?
What time is it in New York?
ΒΏQuΓ© hora es en Barcelona?
What's the weather in London?
Bot not responding:
- Check if bot token is correct
- Verify intents are enabled (Discord)
- Check logs:
tail -f logs/discord.log
WhatsApp QR not working:
- Delete auth files:
rm -rf backend/auth_info_* - Restart bot:
npm run start:whatsapp
Database connection failed:
- Start PostgreSQL:
docker-compose up -d postgres - Check DATABASE_URL in
.env
AI responses not working:
- Verify OPENAI_API_KEY or LOCALAI_URL
- Check model name in configuration
LLaMA Communication Error:
- Check LLaMA server:
docker ps | grep llama - Restart LLaMA server:
docker-compose restart llama-server
- Discord:
logs/discord.log - Telegram:
logs/telegram.log - WhatsApp:
logs/whatsapp.log
# Build and start all services
docker-compose up --build -d
# Check status
docker-compose ps
# View logs
docker-compose logs -f- Use strong JWT secrets
- Enable HTTPS with reverse proxy
- Set up proper firewall rules
- Regular security updates
- Monitor logs for suspicious activity
We welcome contributions! Please see our Contributing Guide for details.
- Read the documentation
- Set up the development environment
- Look for "good first issue" labels
- Start with small contributions
- Ask questions if you need help
- Issues: GitHub Issues
- Discussions: GitHub Discussions
- Creator: VoxHash
- Vox's Personality: Female AI with nerdy goth-kawaii personality
- Multi-Platform Support: Discord, Telegram, and WhatsApp bots
- Multilingual Support: 9 languages (English, Spanish, French, German, Italian, Portuguese, Korean, Basque, Estonian)
- Real-Time Features: Time and weather queries with location detection
- Conversation Memory: Persistent context across sessions
- Emotion Detection: Contextual responses and reactions
- QR Code Generation: PNG images and terminal display for WhatsApp
- Comprehensive Documentation: Consolidated from 20+ files to essential guides
- Package Structure: Updated to v0.0.2 with proper metadata
- Bot Personality: Enhanced with Vox's unique character traits
- Error Handling: Improved fallback responses for API failures
- Location Detection: Better parsing for complex location queries
- System Prompts: Updated to reflect Vox's personality
- Documentation: Consolidated from 20+ files to 2 main guides
- WhatsApp Connection: Improved stability and reconnection logic
- API Error Handling: Better fallback responses for real-time queries
- Location Detection: Fixed parsing for Spanish and complex queries
- Session Management: Reduced cleanup noise in Baileys
- Memory System: Fixed async/await issues in user memory loading
- Text Expressions: Converted all text expressions to emojis
- QR Cleanup: Fixed WhatsApp QR cleanup to delete old files before generating new ones
- Excessive Documentation: Removed 20+ duplicate documentation files
- Debug Scripts: Cleaned up unnecessary test and debug files
- Duplicate Bot Versions: Removed old WhatsApp bot implementations
- Old QR Images: Cleaned up temporary QR code files
Made with β€οΈ by VoxHash for the AI community
Vox is excited to continue growing and evolving! π€β¨