How uheej0625/discordmate works
Project Type and Purpose
• DiscordMate is a conversational AI Discord bot.
• It listens to Discord gateway events, processes messages via an AI provider (Gemini), persists conversation history in a database, and replies back on Discord.
High-Level Components
A. Discord Gateway Integration
– Listens to events (messageCreate, interactionCreate, clientReady)
– Located in src/discord/{discord.js, events/*}
B. Event Handling Layer
– Routes raw Discord events into the business logic
– src/handler/messageHandler.js
C. Business Logic / Service Layer
– ChattingService: Orchestrates conversation flow
– AIService: Wraps prompt building and provider calls
– LogService: Optional logging/tracing
– src/services/*
D. AI Module
– Prompt building (src/ai/builders/promptBuilder.js)
– Prompt definitions (src/ai/prompts/*)
– Providers (src/ai/providers/gemini.js)
E. Persistence Layer
– Repositories (messageRepository, userRepository, modelRepository in src/repositories)
– Database connection and schemas (src/database)
F. Configuration
– Environment and JSON configs (src/config, config.json, .env.template)
G. Utility Functions
– Common helpers (delay, ISO conversion, JSON utils in src/utils)
H. Legacy Code (optional)
– Earlier versions in /legacy – can be omitted or shown as “archived”
Relationships and Data Flow
1. Discord Gateway → Event Handlers
• Discord API pushes “messageCreate” / “interactionCreate” events.
2. Event Handlers → MessageHandler
• Handlers extract payload and invoke the messageHandler.
3. MessageHandler → Services
• ChattingService.receiveMessage(...)
4. ChattingService → Repositories
• + userRepository.findOrCreate()
• + messageRepository.create()
• + modelRepository.lookup()
5. ChattingService → AIService
• AIService.buildPrompt(...) via promptBuilder → sends to Gemini provider
6. AI Provider → AIService → ChattingService
• Gemini returns a response
7. ChattingService → Repositories
• Save AI response via messageRepository
8. ChattingService → Discord Gateway
• Sends reply through discord.js client
9. Logging / Config
• All layers read from src/config and optionally log via LogService
Architectural Patterns & Design Principles
• Event-Driven: Discord events trigger flows.
• Layered Architecture:
– Transport (Discord Gateway)
– Handler Layer
– Service Layer
– Data Access Layer (Repositories)
• Separation of Concerns: AI logic is isolated from database logic.
• Repository Pattern for database interactions.
• Configuration Centralization: All credentials/config in /config and .env.
Must-Include Elements
• Clear labels (e.g., “Discord Gateway (discord.js client)”)
– Integration points, Services, Data stores, Utilities