Expands the unit test suite from 320 to 380 tests (+60) and adds a
Gitea Actions CI workflow. Closes all six follow-up recommendations
from the test-architecture validation report.
New tests (tests/unit/):
- ollamaClient.test.ts — Ollama SDK wrapper, options passthrough
- litellmClient.test.ts — OpenAI SDK wrapper, model fallback
- personaLoader.test.ts — Zod validation + cache invalidation
- foundryReward.test.ts — Tool plugin: lookup, errors, partial grants
- xpAwarder.test.ts — Bulk XP awards + per-player skip reasons
- redisErrorPath.test.ts — Singleton error handler does not crash
- messageRouterRunLLMTurn.test.ts — 18 cases for the runtime heart:
narrative-only path, tool dispatch, filter correction, retry loop
guard, missed-skill-check heuristic, typing indicator interval,
LLM error fallback, archive on resolve.
Coverage (line %):
- harness/litellmClient.ts 0 → 100
- harness/ollamaClient.ts 0 → 100
- harness/tools/foundryReward.ts 0 → 100
- session/xpAwarder.ts 0 → 100
- persona/loader.ts 0 → 100
- db/redis.ts 0 → 100
- bot/handlers/messageRouter.ts 0 → 39.86 (runLLMTurn now covered)
Tooling:
- package.json: + test:coverage, test:watch scripts
- devDep: @vitest/coverage-v8@^3.1.0
- tests/README.md: conventions, anti-patterns, template map
- .gitignore: exclude coverage/
- .gitea/workflows/test.yml: Node 22, npm cache, tsc --noEmit gate
Documentation (from earlier /bmad-document-project run, now committed):
- docs/index.md
- docs/project-overview.md
- docs/architecture.md
- docs/deployment-guide.md
- docs/api-contracts.md
- docs/data-models.md
- docs/source-tree-analysis.md
- docs/component-inventory.md
- docs/development-guide.md
- _bmad-output/test-artifacts/automate-validation-report.md
Co-Authored-By: Claude <noreply@anthropic.com>
5.8 KiB
Mardonar Encounter Engine — Project Overview
Discord-native, LLM-driven D&D encounter engine. Generated 2026-06-19 from a deep scan.
What it is
A Discord bot that runs structured D&D encounters. Each Discord thread is an encounter session. The bot loads a YAML spec, narrates the scene via an LLM (Gemma 4 IT e2b through LiteLLM with Ollama fallback), voices NPCs with stable personas, runs skill checks via Discord embeds, and persists NPC memory + encounter history into a graph database through GraphMCP (JSON-RPC over HTTP). Optional Foundry VTT integration pulls live character stats and awards XP via an external relay.
Who it serves
Discord community members playing D&D 5e in the Land of Mardonar. The DM runs /encounter start <spec> to begin; players post their actions in the resulting thread. NPC personas are loaded from specs and grounded in long-term graph memory so that recurring NPCs remember prior interactions across encounters.
Tech stack at a glance
| Layer | Technology |
|---|---|
| Runtime | Node.js 22 (ESM, TypeScript 5.8 strict) |
| Discord | discord.js v14 |
| LLM (primary) | LiteLLM proxy (env: LITELLM_BASE_URL) |
| LLM (fallback) | Ollama (env: OLLAMA_BASE_URL) — gemma4-it:e2b, 128k context |
| Session cache | Redis (ioredis), 12h TTL |
| Graph DB | Neo4j (via GraphMCP JSON-RPC, not direct) |
| Lore / NPC memory | GraphMCP HTTP JSON-RPC server |
| Foundry VTT | External relay (optional, requires API key) |
| Validation | Zod (env + encounter spec) |
| Logging | pino + pino-pretty |
| Testing | Vitest 3 (unit + integration) |
| Build | tsc → multi-stage Node 22 alpine Dockerfile |
Architecture type
Layered backend with a plugin-style tool registry.
Discord ──▶ src/bot/ (commands, embeds, handlers)
│
▼
src/harness/ (promptBuilder, contextAssembler,
llmClient, toolParser, toolDispatcher,
tools/* plugin registry)
│
┌────────────┼────────────┐
▼ ▼ ▼
Redis GraphMCP VTT relay
(session (JSON-RPC: (Foundry
state) NPC memory, live stats,
lore, log) XP grants)
Repository structure
Single-part monolith. All source under src/. The bot is one Node.js process that talks to external services over the network.
src/
├── bot/ # Discord I/O (commands, embeds, event handlers)
├── harness/ # LLM orchestration + 6 tool plugins
├── session/ # Redis-backed registries + session state
├── graphmcp/ # JSON-RPC client + Redis stream ingest
├── vtt/ # Foundry VTT relay client + spin-up
├── db/ # ioredis singleton
├── spec/ # YAML encounter loader + Zod schema
├── persona/ # persona.yaml loader
├── config.ts # Zod env validation
├── lib/ # logger
├── scripts/ # deploy-commands (slash command registration)
└── types/ # shared interfaces + CONTEXT_BUDGET
Plus specs/ (8 encounter YAML files), tests/ (22 test files), data/ (runtime tally + summaries), and Docs/ (pre-existing project documentation, partially out of date).
Documentation
- Architecture — full system design
- Source Tree Analysis — annotated directory tree
- Component Inventory — reusable components
- Development Guide — setup, run, test, troubleshoot
- Deployment Guide — production deploy + ops
- API Contracts — Discord commands + GraphMCP JSON-RPC
- Data Models — session state, encounter spec, Neo4j graph
Key features in the current codebase
- Per-encounter tool filtering. Each spec declares which tool plugins are active.
- Dynamic goal registration (the active PRD feature) —
tools/goalRegister.tslets the LLM add new goals mid-encounter. - Three-pattern tool parser — handles fenced
tool_call, baretool_callheader, and fuzzy bare JSON, so even smaller models can drive tools. - Self-spinning VTT relay — when the relay is down, the bot handshakes via RSA-OAEP and launches a headless Foundry session on demand.
- Burst cap with drop notices — if too many messages arrive before the last LLM response, the bot drops the excess and posts a tone-aware notice.
- Reaction lifecycle (👀) — visible "I'm working on it" feedback through queued → processing → complete states.
- NPC memory injection at session start from GraphMCP, filtered by score threshold and capped at top-3 chunks above the threshold.
- In-world voice for player-facing strings — no utility/jargon (see
feedback-in-world-voice).
Known drift and open issues
Docs/mardonar-encounter-engine.mddescribes a Go bot with embedded MCP — superseded bydocs/architecture.mdbut still referenced by the README.README.md's project-structure tree is out of date (mentionssrc/mcp/, missing commands).src/types/index.tsEncounterSpecdiverged fromsrc/spec/loader.tsZod schema (missingtone,tools,randomizable,nameKey).- Duplicate
trimHistorybetweensessionManager.tsandcontextAssembler.ts. - No production
docker-compose.yml, no CI/CD, no HTTP health endpoint. DISCORD_ALLOWED_USERSempty by default — channel-scoped access only.
See docs/architecture.md §9 for full drift list.
When you're ready to plan new features
Point the PRD workflow at docs/index.md as input. For UI-facing work, architecture.md §5.1 is the primary reference. For backend/LLM feature work, architecture.md §5.2 and docs/data-models.md are the primary references.