NeruBot - Your Ultimate Discord Companion 🎵

Preview

NeruBot Banner

Preview

Discord Bot

Preview

Python

Preview

License

Preview

Version

A powerful, feature-rich Discord bot designed to bring music, community engagement, and entertainment to your server

🚀 Quick Start • 📋 Features • 📖 Documentation • 🤝 Support

#🎯 About NeruBot

##🏆 Why Choose NeruBot?

• 🎵 Premium Audio Quality - Crystal-clear streaming from YouTube, Spotify, and SoundCloud
• 🛡️ Privacy-First Design - Anonymous features with robust security measures
• ⚡ Lightning Fast - Optimized performance with minimal resource usage
• 🎨 Beautiful Interface - Modern Discord UI with interactive components
• 🔒 Production Ready - Enterprise-grade architecture and deployment tools
• 💰 Completely Free - No premium features, everything included!

#✨ Features

#🚀 Quick Start

##🖥️ Local Development

# Clone the repository
git clone https://github.com/nerufuyo/nerubot.git
cd nerubot

# Automated setup and run
./run.sh

• ✅ Create virtual environment
• ✅ Install dependencies
• ✅ Generate .env template
• ✅ Guide you through Discord token setup
• ✅ Start the bot

##🌐 VPS Deployment (Production)

# One-command VPS setup (Ubuntu/Debian)
curl -fsSL https://raw.githubusercontent.com/nerufuyo/nerubot/main/deploy/setup.sh | sudo bash

• 🔧 Installs Python 3, FFmpeg, and dependencies
• 👤 Creates secure nerubot user
• 🛡️ Configures firewall (SSH only)
• ⚙️ Sets up systemd service
• 📊 Enables health monitoring

#📋 Command Reference

##🎵 Music Commands

##📝 Confession Commands

##� Roast Commands

##🤖 Chatbot Commands

##�📰 News & Crypto Commands

##ℹ️ Information Commands

#⚙️ Configuration

##🔑 Environment Setup

1. Create .env file:

# Required
DISCORD_TOKEN=your_discord_bot_token_here

# Optional
LOG_LEVEL=INFO
COMMAND_PREFIX=!
SPOTIFY_CLIENT_ID=your_spotify_client_id
SPOTIFY_CLIENT_SECRET=your_spotify_client_secret

2. Get Discord Bot Token:
   • Visit Discord Developer Portal
   • Create new application → Bot → Copy token
   • Enable all necessary intents
3. Bot Permissions:
   • Send Messages
   • Embed Links
   • Read Message History
   • Connect to Voice
   • Speak in Voice
   • Use Slash Commands

##🎛️ Advanced Configuration

• Bot responses and messages
• Help system content
• Error messages
• Feature descriptions

#🛠️ Management & Monitoring

##📊 Service Management

# Check bot status
sudo systemctl status nerubot

# View real-time logs
sudo journalctl -u nerubot -f

# Restart service
sudo systemctl restart nerubot

##📈 Monitoring Tools

# Quick status dashboard
./deploy/status.sh

# Health monitoring
./deploy/monitor.sh

# Update bot to latest version
./deploy/update.sh

#🏗️ Architecture

• 🏛️ Modular Design - Features can be easily added/removed
• 🧹 Clean Code - Well-structured, maintainable codebase
• 🔒 Security First - Production-grade security practices
• 📈 Scalable - Ready for high-traffic servers
• 🧪 Testable - Comprehensive testing infrastructure

#📊 System Requirements

##Minimum Requirements

• OS: Ubuntu 20.04+ / Debian 11+ / Windows 10+ / macOS 10.15+
• Python: 3.8 or higher
• RAM: 1GB
• Storage: 5GB
• Network: Stable internet connection

##Recommended (VPS)

• CPU: 2+ cores
• RAM: 2GB+
• Storage: 10GB+
• Bandwidth: 1TB/month

##Dependencies

• FFmpeg - Audio processing
• Git - Version control
• Discord.py 2.3+ - Discord API wrapper

#📖 Documentation

#🤝 Contributing

##Quick Contribution Guide

1. Fork the repository
2. Clone your fork: git clone https://github.com/yourusername/nerubot.git
3. Create feature branch: git checkout -b feature/amazing-feature
4. Make your changes following our coding standards
5. Test thoroughly
6. Submit pull request

##Development Setup

# Setup development environment
./run.sh setup

# Install development dependencies
pip install -r requirements-dev.txt

# Run tests
python -m pytest

# Code formatting
black src/ && isort src/

• 🎵 Music features and sources
• 🛡️ Security improvements
• 📱 UI/UX enhancements
• 📚 Documentation
• 🧪 Testing coverage
• 🌐 Internationalization

#💫 Support & Community

##🆘 Getting Help

• GitHub Issues - Bug reports and feature requests
• Discussions - Questions and community chat
• Discord Server - Real-time support and community
• Documentation - Comprehensive guides

##🏷️ Project Status

• ✅ Active Development - Regular updates and improvements
• 🛡️ Production Ready - Used in 100+ Discord servers
• 🧪 Well Tested - Comprehensive test suite
• 📚 Documented - Complete documentation and guides

#🙏 Acknowledgments

• Discord.py Community - Amazing framework and support
• Contributors - Everyone who helped improve NeruBot
• Users - Servers and communities using NeruBot
• Open Source Projects - Libraries and tools that make this possible

#📄 License

#🌟 Star History

Preview

Star History Chart