How xeravax/shield-bot works
Shield Bot is a Discord community-management bot with a VRChat integration and a web dashboard. Discord members use commands and interactions for attendance, planned events, patrols, leave requests, verification, and whitelist administration; managers implement those domain workflows, while event handlers and schedules support ongoing activity. The dashboard provides an additional authenticated interface for event planning. The README documents broader capabilities than the sampled excerpts; unsampled subsystems are represented at their exact source directories, and edges are limited to documented behavior or indexed references.
Main entry points: main.ts Bot runtime · commands Slash commands · discord Discord interactions · whitelistManager.ts Whitelist control
Components 22
Runtime and interfaces
- Bot runtime
src/main.ts - Slash commands
src/commands - Discord interactions
src/events/discord - Scheduled jobs
src/schedules - Persistent records
Community workflows
- Attendance tracking
src/managers/attendance/attendanceManager.ts - Event planning
src/managers/events/eventPlanningManager.ts - Patrol tracking
src/managers/patrol/patrolTimerManager.ts - Leave management
src/managers/loa/loaManager.ts - Role tracking
src/managers/roleTracking/roleTrackingManager.ts
VRChat integration
- Account verification
src/managers/verification - VRChat events
src/events/vrchat/vrchat-websocket.ts - Group role sync
src/managers/groupRoleSync/groupRoleSyncManager.ts
Administration
- Whitelist control
src/managers/whitelist/whitelistManager.ts - Audit logging
src/managers/logging/index.ts - REST API
src/api
Web dashboard
- Dashboard interface
dashboard/src/App.tsx - Dashboard endpoints
src/api/dashboard/dashboard.ts
Other components
- Discord members
- Discord platform
- VRChat API
- GitHub
Connections 22
- Discord members → Discord platform: use bot
- Discord platform → Bot runtime: delivers events
src/main.ts - Bot runtime → Slash commands: loads modules
src/main.ts - Bot runtime → Discord interactions: loads modules
src/main.ts - Bot runtime → REST API: loads modules
src/main.ts - Bot runtime → Scheduled jobs: starts schedules
src/main.ts - Slash commands → Attendance tracking: manage attendance
- Slash commands → Event planning: manage events
- Slash commands → Patrol tracking: manage patrols
- Slash commands → Leave management: manage leave
- Discord interactions → Account verification: handle verification
- Discord interactions → Whitelist control: manage whitelist
src/events/discord/button/accountmanagement/VRCAccountManagerButton.ts - Bot runtime → VRChat events: starts listener
src/main.ts - VRChat events → VRChat API: receive events
- Group role sync → VRChat API: sync group roles
- Whitelist control → GitHub: publish backup
- Discord interactions → Audit logging: send audit events
src/events/discord/logging/server.ts - Dashboard interface → Dashboard endpoints: request data
src/api/dashboard/dashboard.ts - Dashboard endpoints → Event planning: uses planning logic
src/api/dashboard/dashboard.ts - Event planning → Persistent records: persist events
src/managers/events/eventPlanningManager.ts - Leave management → Persistent records: persist leave
src/managers/loa/loaManager.ts - Whitelist control → Persistent records: read whitelist data
src/managers/whitelist/whitelistManager.ts