Initial Setup Guide

This guide walks you through setting up Vör for development or self-hosting.

Prerequisites

Python Version

Vör requires Python 3.13 (recommended) or Python 3.12+.

  • Download from python.org
  • Ensure python --version shows 3.13.x

Dependencies

Vör uses several external services that require API keys:

  • Discord Bot Token: Required for bot functionality
  • CurrencyBeacon API Key: For currency conversion
  • VirusTotal API Key: For file scanning
  • Various webhook URLs: For logging and notifications

Environment Configuration

Creating the .env File

  1. Navigate to the bot_config/ directory in your Vör installation
  2. Copy example_env to .env:
    cp example_env .env
    
  3. Edit .env with your configuration values

Required Environment Variables

Discord Configuration

# Your Discord bot token from https://discord.com/developers/applications
DISCORD_TOKEN=your_bot_token_here

# Bot owner IDs (comma-separated)
BOT_OWNERS=123456789012345678,987654321098765432

# Bot prefix (default: !)
BOT_PREFIX=!

API Keys

# Currency conversion API (get from https://currencybeacon.com)
CB_API_KEY=your_currencybeacon_api_key

# VirusTotal API (get from https://virustotal.com)
VT_API_KEY=your_virustotal_api_key

Database Configuration

# SQLite database paths (relative to project root)
MAIN_DB_PATH=vor.db
MODLOGS_DB_PATH=vor_modlogs.db
ECONOMY_DB_PATH=vor_economy.db
NOTES_DB_PATH=vor_notes.db
REPUTATION_DB_PATH=vor_reputation.db
TIERS_DB_PATH=vor_tiers.db

Webhook URLs

# Error logging webhook
WEBHOOK_ERROR=https://discord.com/api/webhooks/your/webhook/url

# Dashboard URL (for production)
VOR_DASHBOARD_URL=https://your-dashboard-domain.com

Debug Settings

# Set to 'true' for development
DEBUG_MODE=false

# Logging level (DEBUG, INFO, WARNING, ERROR)
LOG_LEVEL=INFO

Installing Dependencies

Using pip

# Install from requirements.txt
pip install -r requirements.txt
# Create virtual environment
python -m venv venv

# Activate virtual environment
# Windows:
venv\Scripts\activate
# Linux/Mac:
source venv/bin/activate

# Install dependencies
pip install -r requirements.txt

Database Setup

Vör uses SQLite databases that are created automatically on first run. No manual database setup is required.

The bot will create the following database files:

  • vor.db - Main bot data
  • vor_modlogs.db - Moderation logs
  • vor_economy.db - Economy data
  • vor_notes.db - User notes
  • vor_reputation.db - Reputation data
  • vor_tiers.db - XP/levels data

Running the Bot

Basic Startup

# Ensure you're in the virtual environment
# Then run:
python main.py

Development Mode

Set DEBUG_MODE=true in your .env file for additional logging and development features.

Production Deployment

For production, consider using:

  • Process managers like systemd or supervisor
  • Reverse proxies like nginx
  • Containerization with Docker

Configuration Validation

After starting the bot, check the console output for:

  • ✅ Database connections established
  • ✅ Discord connection successful
  • ✅ API keys validated
  • ✅ Cogs loaded successfully

Troubleshooting

Common Issues

“Module not found” errors

  • Ensure all dependencies are installed: pip install -r requirements.txt
  • Check you’re using the correct Python version

“Invalid token” error

  • Verify your DISCORD_TOKEN in .env
  • Ensure the token has proper bot permissions

Database errors

  • Check file permissions on database directory
  • Ensure SQLite is available (usually included with Python)

API key errors

  • Verify API keys are correct and active
  • Check API rate limits haven’t been exceeded

Getting Help

  • Check the full documentation for detailed guides
  • Join the Vör support community
  • Review the developer documentation for advanced setup

Security Notes

  • Never commit your .env file to version control
  • Keep API keys secure and rotate them regularly
  • Use strong, unique passwords for any web interfaces
  • Regularly update dependencies for security patches