Best Practices

​

Overview

​

Bot Configuration

​

Environment Security

​

Securing Your Credentials

1. Add .env to .gitignore:

# .gitignore
.env
node_modules/
*.log

2. Use environment-specific files:

.env.development
.env.production
.env.example  # Template without actual credentials

3. Rotate tokens regularly: Change your Discord bot token periodically
4. Limit API key permissions: Only grant necessary permissions to API keys

TOKEN=your_discord_token_here
YOUTUBE_API_KEY=your_youtube_api_key
SPOTIFY_CLIENT_ID=your_spotify_client_id
SPOTIFY_CLIENT_SECRET=your_spotify_client_secret

​

Optimal Dependencies Configuration

​

Keep Dependencies Updated

# Check for outdated packages
npm outdated

# Update all dependencies
npm update

# Update specific package
npm update discord.js

​

Recommended Package Versions

• Node.js: 18.17.0 or higher (LTS version recommended)
• Discord.js: 14.x
• Distube: 5.x
• @discordjs/voice: Latest version

​

Bot Presence Configuration

module.exports = {
    prefix: 'r!',
    presence: {
        activities: [
            { name: 'r!help 🎶', type: 'LISTENING' },
        ],
        status: 'idle'
    }
};

​

Managing Server Music Sessions

​

Queue Management Best Practices

​

Starting a Session

1. Join voice channel first: Always be in the voice channel before commanding the bot
2. Start with one song: Test playback before queuing multiple songs
3. Use direct URLs for playlists: More reliable than searching

# Good practice
r!play https://youtube.com/watch?v=VIDEO_ID

# Also good
r!play the scientist coldplay

​

Managing Long Queues

1. Check queue regularly: Use r!queue to see what’s coming
2. Clear and restart: Use r!stop to clear queue if it gets messy
3. One user manages: Designate one person to manage the queue in shared sessions

​

Session Lifecycle

​

Best Practices for Starting

# 1. Join voice channel
# 2. Test with one song
r!play test song

# 3. Verify playback works
# 4. Add more songs to queue
r!play song 2
r!play song 3

# 5. Check queue
r!queue

​

Best Practices for Ending

# Proper cleanup
r!stop  # Stops playback and clears queue

# Bot will automatically leave voice channel

​

Queue Management Tips

​

Efficient Queue Building

​

Use Direct URLs

# Most efficient - no search needed
r!play https://youtu.be/VIDEO_ID

• Faster processing
• No YouTube API quota usage
• Exact song you want
• Works with playlists

​

Search Optimization

# Specific searches get better results
r!play imagine dragons believer official

# Less specific - may get wrong song
r!play believer

​

Interactive Search Selection

1. Be ready: You have 20 seconds to select
2. Read carefully: Check artist and duration before selecting
3. Act quickly: Menu times out automatically

​

Volume Management

# Start at moderate volume
r!volume 50

# Adjust based on preference
r!volume 30  # Quieter
r!volume 80  # Louder

​

Performance Optimization

​

Server Performance

​

Resource Requirements

• 512MB RAM
• 1 CPU core
• Stable internet connection

• 1GB+ RAM
• 2 CPU cores
• Low-latency internet

​

Monitoring Resources

# On Linux/Mac
top
htop

# On Windows (PowerShell)
Get-Process node

​

Bot Performance

​

Optimize for Multiple Guilds

• Each guild has independent queue
• Concurrent playback supported
• No cross-guild interference

​

Memory Management

require('events').EventEmitter.defaultMaxListeners = 15;

​

Network Optimization

​

Reduce API Calls

1. Use URLs: Direct links don’t use API quota
2. Cache results: Reuse search results when possible
3. Batch operations: Queue multiple songs at once

# Instead of one at a time
r!play song1
r!play song2
r!play song3

# Use URLs or add to queue quickly
r!play https://youtube.com/playlist?list=PLAYLIST_ID

​

YouTube API Quota Management

• Default quota: 10,000 units/day
• Search cost: ~100 units per search
• Approximate searches: ~100/day

​

Security Considerations

​

Token Security

​

What to Never Share

• Discord bot token
• YouTube API key
• Spotify Client ID and Secret
• .env file contents
• Database credentials (if added)

​

Safe Sharing Practices

1. Use .env.example: Template file without credentials
2. Document setup: Guide users to get their own keys
3. Never screenshot: Don’t share screenshots with tokens visible
4. Check commits: Review before pushing to ensure no tokens

​

Permission Principle

• Read Messages/View Channels
• Send Messages
• Embed Links
• Connect (voice)
• Speak (voice)

• Administrator
• Manage Server
• Manage Roles
• Manage Channels

​

API Key Restrictions

​

YouTube API Key

1. Go to Google Cloud Console
2. Select your project
3. APIs & Services → Credentials
4. Edit API key → Application restrictions:
   • Set IP restrictions if hosting on static IP
   • Set API restrictions to only YouTube Data API v3

​

Spotify API

1. Go to Spotify Dashboard
2. Edit Settings:
   • Add redirect URIs if needed
   • Don’t share Client Secret

​

Multi-Guild Best Practices

​

Scaling to Multiple Servers

// Each guild has independent DisTube queue
// No special configuration needed

​

Guild-Specific Considerations

​

Voice Regions

• Bot performs best in servers with nearby voice regions
• Higher latency in distant regions
• Consider hosting bot closer to primary servers

​

Concurrent Sessions

• No limit on concurrent guilds (within Discord API limits)
• Each session independent
• Resources scale with active sessions

​

Load Balancing (Advanced)

1. Shard the bot: Discord.js supports sharding for 2500+ guilds
2. Multiple instances: Run multiple bot instances with different tokens
3. Queue system: Implement external queue management

​

Monitoring and Logging

const Logger = require('./utils/logger');

Logger.info('Message');
Logger.error('Error', error, 'filename.js');
Logger.command('play', 'username', 'guild');
Logger.music('Now playing: Song Name', 'play.js');

​

Log Management

1. Monitor console: Watch for errors in real-time
2. Log rotation: Implement log rotation for production
3. Error tracking: Log errors for debugging

npm install -g pm2
pm2 start index.js --name rosy-bot
pm2 logs rosy-bot

​

Deployment Best Practices

​

Development vs Production

​

Development Setup

# Local development
npm start

# Auto-restart on changes (optional)
npm install -g nodemon
nodemon index.js

​

Production Setup

# Use process manager
pm2 start index.js --name rosy-bot

# Auto-restart on crash
pm2 startup
pm2 save

​

Hosting Recommendations

• VPS (DigitalOcean, Linode, Vultr)
• Cloud (AWS, Google Cloud, Azure)
• Dedicated server

• Heroku (dynos sleep, not ideal for voice)
• Shared hosting (limited resources)
• Replit (inconsistent for voice bots)

​

Uptime Monitoring

# Use PM2 for automatic restarts
pm2 start index.js --name rosy-bot --max-restarts 10

# Monitor status
pm2 status

# View logs
pm2 logs rosy-bot

​

Backup and Recovery

​

What to Backup

1. Source code: Keep in Git repository
2. Configuration: .env.example template
3. Custom modifications: Document all changes

​

What NOT to Backup

• node_modules/ (reinstall with npm install)
• .env with actual credentials (security risk)
• Log files (regenerate)

git init
git add .
git commit -m "Initial commit"
git remote add origin YOUR_REPO_URL
git push -u origin main

​

Maintenance Schedule

​

Weekly

• Check bot status and uptime
• Review error logs
• Test critical commands

​

Monthly

• Update dependencies: npm update
• Review API quota usage
• Check for Discord.js updates
• Reapply yt-dlp fix if updated

​

Quarterly

• Rotate bot token
• Review and update API keys
• Performance audit
• Update Node.js version

​

Common Pitfalls to Avoid

​

Related Resources

• Getting Started - Initial setup
• Troubleshooting - Fix common issues
• Commands Reference - All commands
• Inviting Bot - Add to servers