How julien6/assistcluedo works
AssistCluedo is a deterministic terminal investigation game and scenario-generation framework. Its central workflow starts with a CLI request, generates and validates a seeded mystery with a player-safe evidence package and quiz, then lets a player browse evidence, submit answers, and review the revealed solution. The graph also shows framework export and evaluation capabilities. The generation orchestration and key game interactions are evidenced by excerpts and the SOURCE INDEX; broader features such as audits and document regeneration are documented in the README, so some subsystem links rely on that documentation.
Main entry points: tty.py TTY interface · main.py Command line · world.py World generation · evaluation.py Answer evaluation
Components 23
CLI and game
- Command line
src/assistcluedo/cli/main.py - TTY interface
src/assistcluedo/game/tty.py
Scenario generation
- Scenario pack
src/assistcluedo/scenario_packs/classic_manor/pack.yaml - Pack loader
src/assistcluedo/framework/pack.py - Seed streams
src/assistcluedo/framework/seed.py - World generation
src/assistcluedo/framework/world.py - Ground truth
src/assistcluedo/framework/scenario.py - Timeline and facts
src/assistcluedo/framework/timeline.py - Evidence traces
src/assistcluedo/framework/traces.py - Scenario model
src/assistcluedo/framework/models.py - Scenario validation
src/assistcluedo/framework/validation.py
Evidence and exports
- Document planning
src/assistcluedo/framework/documents.py - Document rendering
src/assistcluedo/framework/documents.py - Narrative generation
src/assistcluedo/framework/textgen.py - Proof graph
src/assistcluedo/framework/proof.py - Quiz generation
src/assistcluedo/framework/questions.py - Package export
src/assistcluedo/framework/export.py - Player package
src/assistcluedo/game/player_package.py
Play and review
- Game sessions
src/assistcluedo/game/session.py - Game services
src/assistcluedo/game/services.py - Answer evaluation
src/assistcluedo/game/evaluation.py - Solution review
src/assistcluedo/game/review.py
Other components
- Player
Connections 28
- Player → Command line: issues commands
README.md - Command line → World generation: starts generation
src/assistcluedo/cli/main.py - Command line → TTY interface: starts play
src/assistcluedo/cli/main.py - World generation → Pack loader: loads pack
src/assistcluedo/framework/world.py - Pack loader → Scenario pack: reads data
src/assistcluedo/framework/pack.py - World generation → Seed streams: uses seeded randomness
src/assistcluedo/framework/world.py - World generation → Ground truth: provides world
src/assistcluedo/framework/generator.py - Ground truth → Timeline and facts: provides truth
src/assistcluedo/framework/generator.py - Timeline and facts → Evidence traces: provides facts and events
src/assistcluedo/framework/generator.py - Evidence traces → Document planning: provides traces
src/assistcluedo/framework/generator.py - Document planning → Document rendering: provides plans
src/assistcluedo/framework/generator.py - Document rendering → Narrative generation: generates prose
src/assistcluedo/framework/documents.py - Document rendering → Proof graph: provides documents
src/assistcluedo/framework/generator.py - Proof graph → Quiz generation: provides proof links
src/assistcluedo/framework/generator.py - Quiz generation → Scenario validation: quiz enters scenario
src/assistcluedo/framework/generator.py - Scenario validation → Package export: validates before export
src/assistcluedo/framework/export.py - Package export → Player package: builds player view
src/assistcluedo/framework/export.py - Package export → Scenario model: serializes scenario
src/assistcluedo/framework/export.py - Player package → TTY interface: supplies player content
README.md - TTY interface → Game services: uses game services
src/assistcluedo/game/tty.py - TTY interface → Game sessions: loads and saves
src/assistcluedo/game/tty.py - Game services → Game sessions: manages session
src/assistcluedo/game/services.py - Game services → Answer evaluation: evaluates answers
src/assistcluedo/game/services.py - TTY interface → Answer evaluation: submits answers
README.md - Command line → Answer evaluation: runs evaluation
src/assistcluedo/cli/main.py - Command line → Solution review: runs review
src/assistcluedo/cli/main.py - Solution review → Answer evaluation: uses result details
src/assistcluedo/game/review.py - Player → TTY interface: browses and answers
README.md