Ghost Module
Ghost Module
Ghóst_Módule // Autómated_QA
ᚠ ᛫ ᛟ ᛫ ᚱ ᛫ ᛒ ᛫ ᛟ ᛫ ᚲ
The Ghost module runs headless AI agents for automated game testing. Ghosts explore, fight, dialogue, and report bugs.
T̸h̵e̷ ̴g̸h̴o̸s̶t̶s̷ ̵w̷a̶l̵k̶ ̵w̵h̸e̷r̵e̴ ̷p̷l̸a̷y̴e̵r̶s̷ ̷f̷e̵a̷r̷.
Overview
Ghost provides:
- Multiple Test Suites: Exploration, combat, dialogue, pathfinding
- Real-time Status: Monitor progress and duration
- Comprehensive Results: Pass/fail, coverage, performance metrics
- Screenshot Capture: Visual evidence of failures
Quick Start
Configuration
Test Suites
API Reference
createGhost(config)
Factory function to create a Ghost session.
ghost.run()
Start the Ghost testing session.
Returns: Promise<string> (sessionId)
ghost.status()
Get current session status.
Returns: Promise<GhostStatus>
ghost.results()
Get session test results.
Returns: Promise<GhostResults>
ghost.stop()
Stop the running session.
Returns: Promise<void>
ghost.waitForCompletion(pollInterval?, timeout?, onProgress?)
Wait for session to complete with progress updates.
Parameters:
pollIntervalMs(number): Polling interval (default: 5000)timeoutMs(number): Maximum wait time (default: 300000)onProgress(function): Progress callback
Returns: Promise<GhostResults>
Standalone Functions
startGhostSession(config)
Start a session without class instance.
getGhostStatus(sessionId, apiUrl?)
Get status for any session.
getGhostResults(sessionId, apiUrl?)
Get results for any session.
stopGhostSession(sessionId, apiUrl?)
Stop a running Ghost session.
Returns: Promise<{ stopped: boolean; status: string }>
getGhostHistory(limit?, apiUrl?)
Get history of all Ghost sessions.
Returns: Promise<GhostHistoryEntry[]>
Metrics
Ghost collects performance and coverage metrics:
CI/CD Integration
Integrate Ghost into your CI pipeline:
Test Report Format
Ghost outputs results in JUnit-compatible format:
Custom Test Parameters
Pass custom parameters to test suites:
ᚠ ᛫ ᛟ ᛫ ᚱ ᛫ ᛒ ᛫ ᛟ ᛫ ᚲ
G̵h̴o̷s̶t̵s̴ ̸n̶e̷v̸e̷r̷ ̵s̶l̷e̴e̸p̸.̵ ̷T̵h̶e̸y̴ ̵o̵n̵l̵y̴ ̸w̷a̸t̷c̶h̶.
