VRChat Monitor

Advanced VRChat Instance Monitoring & Moderation Tool

Real-time monitoring of VRChat instances with SQLite blocklist checking and multi-channel alerts (Desktop, Discord, Audio, VR Overlay).

✨ Features

• 🔍 Real-time Log Monitoring - Automatically detects player join/leave events
• 🚫 SQLite Blocklist System - Fast, indexed database with 86+ groups
• 🔄 Auto-updating Blocklists - Fetches updates from remote sources
• 🔔 Multi-Channel Alerts:
  • Desktop notifications (Windows toast)
  • Discord webhooks with rich embeds
  • Audio alerts (FFmpeg)
  • VR overlay (VRCX & XSOverlay)
• 🔐 Full 2FA Support - TOTP, OTP, Email verification
• 💾 Session Persistence - SQLite-based session storage
• 📦 Single Executable - Node.js SEA packaging

📋 Requirements

• Windows 10/11 (64-bit)
• VRChat installed and running
• VRChat Account with credentials

🚀 Quick Start

Download & Run

1. Download the latest release from Releases
2. Extract the archive
3. Run vrc-monitor.exe
4. Login when prompted (credentials saved for next time)

First Run

# The app will prompt you for:
Username: your_vrchat_username
Password: ********
2FA Code: 123456  # If 2FA enabled

Your credentials and session are saved automatically. On subsequent runs, you'll be logged in instantly.

Interactive Commands

The app features an interactive command system. Once started, type commands at the prompt:

vrc-monitor> help          # Show all available commands
vrc-monitor> test-alert    # Test all notification channels
vrc-monitor> status        # Show monitor status
vrc-monitor> quit          # Exit the application

Available Commands:

• help - Show all commands
• test-alert - Test all notification channels (Desktop, Discord, Audio, VR)
• status - Display monitor status and blocklist stats
• update-blocklist - Force update blocklist from remote
• clear - Clear console screen
• restart - Restart the monitor
• version - Show app version
• quit - Exit

See Commands Reference for detailed documentation.

⚙️ Configuration

Edit config.json to enable features:

{
  "vrchat": {
    "username": "",  // Optional: pre-fill or leave empty to prompt
    "password": ""
  },
  "notifications": {
    "desktop": { "enabled": true, "sound": true },
    "discord": { "enabled": false, "webhookUrl": "" },
    "vrcx": { "enabled": false, "xsOverlay": false }
  },
  "audio": { "enabled": true, "volume": 0.5 },
  "blocklist": {
    "autoUpdate": true,
    "remoteUrl": "https://example.com/blocklist.db",
    "updateInterval": 60
  }
}

See Configuration Guide for all options.

📚 Documentation

• Interactive Commands - Command system reference
• Setup Guide - Installation, configuration, Discord webhooks, VR overlays
• Configuration Reference - All config options explained
• Blocklist Management - SQLite database schema and management
• Troubleshooting - Common issues and solutions
• Building from Source - Developer build instructions

🔄 How It Works

1. Monitors VRChat log files for player join events
2. Fetches player's groups via VRChat API (cached)
3. Checks against SQLite blocklist database
4. Sends alerts to all enabled channels if matched
5. Auto-updates blocklist periodically

🛠️ Technology Stack

• TypeScript 5.7 + Node.js 22+
• SQLite (better-sqlite3) - Blocklist & session storage
• vrchat@2.20.4 - Official VRChat API
• Node.js SEA - Single Executable Application

🐛 Troubleshooting

Quick Fixes

• Session issues: Delete .cache/session.sqlite and re-login
• Authentication failed: Verify credentials, check 2FA code
• No logs detected: Ensure VRChat is running and installed in default location

See Troubleshooting Guide for detailed solutions.

📞 Support

• Issues: GitHub Issues
• Documentation: See docs/ folder

🎯 Roadmap

✅ Completed

• Complete TypeScript rewrite
• SQLite blocklist with auto-updates
• User blocklist checking (block individual users)
• Node.js SEA packaging
• VRChat API with session persistence
• Multi-channel notifications (Desktop, Discord, Audio, VR)
• VRCX & XSOverlay VR overlay integration
• Interactive command system

📋 Planned

• Blocklist management web dashboard

🙏 Credits

• Built on VRChatMonitor
• vrchat@2.20.4 from vrchat.community
• better-sqlite3
• FFmpeg, SnoreToast
• Inspired by VRCX

📜 License

MIT License - See LICENSE

⚠️ Disclaimer

VRChat Monitor is not endorsed by VRChat and does not reflect the views of VRChat Inc. Uses VRChat API in accordance with their Terms of Service.

---

Made with ❤️ for the VRChat community