How hgleung/discord-squire works
Squire is a self-hosted Discord bot with assistant, strength-training, music, and system modules; its training log also has a web UI and is stored in an Obsidian vault. The main user workflow is a Discord message or command routed by the bot to a module, which responds or updates state. The assistant also runs background tasks and offers research, calendar, and factory capabilities. Relationships for unsampled assistant features are included only where the README documents them; source excerpts and the index support the other shown links.
Main entry points: assistant/index.ts Chat module · service.ts Workout service · src/index.ts Bot startup · bot.ts Command routing
Components 29
Bot runtime
- Bot startup
src/index.ts - Command routing
src/bot.ts - Obsidian vault
src/vault.ts - Update command
src/modules/system/index.ts
Assistant
- Chat module
src/modules/assistant/index.ts - Chat agent
src/modules/assistant/agent.ts - Tool protocol
src/modules/assistant/llm.ts - Background tasks
src/modules/assistant/tasks.ts - Job factories
src/modules/assistant/factory.ts - Calendar brief
src/modules/assistant/brief.ts - Google services
src/modules/assistant/google.ts - Reminders, memory
src/modules/assistant
Training log
- Training commands
src/modules/training/index.ts - Workout service
src/modules/training/service.ts - Plan storage
src/modules/training/store.ts - Plan operations
lib/planOps.ts - Workout scoring
lib/scoring.ts - Weekly summary
lib/weekSummary.ts - Muscle targets
lib/muscles.ts - Date utilities
lib/dateUtils.ts - Training web UI
web/src/App.tsx - Plan sync hook
web/src/hooks/usePlan.ts - Plan API
web/src/lib/api.ts
Music
- Music commands
src/modules/music/index.ts - Audio player
src/modules/music/player.ts
Other components
- Discord user
- Discord
- Anthropic API
- YouTube audio
Connections 36
- Discord user → Discord: sends command
- Discord → Command routing: delivers events
- Bot startup → Command routing: starts
src/index.ts - Bot startup → Chat module: registers
src/index.ts - Bot startup → Training commands: registers
src/index.ts - Bot startup → Music commands: registers
src/index.ts - Bot startup → Update command: registers
src/index.ts - Command routing → Chat module: dispatches
- Command routing → Training commands: dispatches
- Command routing → Music commands: dispatches
- Chat module → Chat agent: invokes
src/modules/assistant/index.ts - Chat agent → Tool protocol: uses tools
src/modules/assistant/llm.ts - Chat agent → Anthropic API: requests completion
- Chat module → Background tasks: starts tasks
src/modules/assistant/index.ts - Background tasks → Tool protocol: runs tools
src/modules/assistant/tasks.ts - Background tasks → Job factories: loads prompt
src/modules/assistant/tasks.ts - Background tasks → Obsidian vault: reads and writes notes
src/modules/assistant/tasks.ts - Chat module → Calendar brief: generates brief
src/modules/assistant/index.ts - Calendar brief → Google services: uses calendar
- Chat module → Reminders, memory: manages
src/modules/assistant/index.ts - Chat module → Workout service: answers gym queries
src/modules/assistant/index.ts - Training commands → Workout service: handles commands
src/modules/training/index.ts - Workout service → Plan storage: reads and updates
src/modules/training/service.ts - Workout service → Plan operations: updates plan
src/modules/training/service.ts - Workout service → Workout scoring: calculates progress
src/modules/training/service.ts - Workout service → Weekly summary: builds weekly facts
src/modules/training/service.ts - Weekly summary → Workout scoring: computes statistics
lib/weekSummary.ts - Workout scoring → Muscle targets: uses targets
lib/scoring.ts - Workout service → Date utilities: formats dates
src/modules/training/service.ts - Plan storage → Obsidian vault: persists plan
src/modules/training/store.ts - Discord user → Training web UI: logs workout
- Training web UI → Plan sync hook: uses plan state
web/src/App.tsx - Plan sync hook → Plan API: fetches and saves
web/src/hooks/usePlan.ts - Training web UI → Plan operations: edits plan
web/src/App.tsx - Music commands → Audio player: controls playback
src/modules/music/index.ts - Audio player → YouTube audio: streams audio