open-dos
Launch and play classic DOS games like DOOM, Super Mario, and Tetris directly from your AI assistant using js-dos emulation.
Instructions
Open and play a DOS game using js-dos. Use list to see the exact key you need to use and the available games.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| game | Yes | DOS game slug to play (e.g., 'doom', 'doom2'). |
Implementation Reference
- src/tools/open-dos.ts:255-307 (handler)The main handler function for the 'open-dos' tool. It validates the game slug, starts an Express server if needed, generates an HTML page with js-dos for the game, opens it in Chrome, and returns success or error messages.export default async function openDos({ game }: InferSchema<typeof schema>) { try { const result = await suppressStdioAsync(async () => { const gameSlug = game.toLowerCase(); // Check if game exists if (!DOS_GAMES[gameSlug]) { return { content: [ { type: "text", text: `Game "${game}" not found` }, { type: "text", text: `Available games: ${Object.keys(DOS_GAMES).join(', ')}` } ], isError: true, }; } // Start server if not already running const port = await startServer(); // Build URLs for both local and CDN options const localUrl = `http://localhost:${port}/${encodeURIComponent(gameSlug)}`; const cdnUrl = `http://localhost:${port}/${encodeURIComponent(gameSlug)}?cdn=true`; const gameInfo = DOS_GAMES[gameSlug]; // Try to open with CDN first if available, otherwise use local const useUrl = gameInfo.cdnFile ? cdnUrl : localUrl; // Open URL in Chrome await open(useUrl, { app: { name: 'google chrome' } }); const response = { content: [ { type: "text", text: `Started ${gameInfo.title}` }, { type: "text", text: `Game URL: ${useUrl}` }, { type: "text", text: `Controls: ${JSON.stringify(gameInfo.keys, null, 2)}` }, ], }; if (port > 5555) { response.content.push({ type: "text", text: `Game servers start from port 5555. If you see that the game started on ports above 5555, it means you have older servers running. You can use the \`close-app\` tool to close them.` }); } return response; }); return result; } catch (error) { return { content: [{ type: "text", text: `Error starting game: ${error}` }], isError: true, }; } }
- src/tools/open-dos.ts:11-13 (schema)Input schema definition using Zod for the 'game' parameter.export const schema = { game: z.string().describe("DOS game slug to play (e.g., 'doom', 'doom2')."), };
- src/tools/open-dos.ts:16-25 (registration)Tool metadata including name, description, and annotations, used for registration in the MCP toolset.export const metadata = { name: "open-dos", description: "Open and play a DOS game using js-dos. Use `list` to see the exact key you need to use and the available games.", annotations: { title: "Play DOS game", readOnlyHint: true, destructiveHint: false, idempotentHint: true, }, };
- src/tools/open-dos.ts:185-230 (helper)Helper function to start the Express server that serves the DOS game HTML pages, finds available port starting from 5555, and sets up routes for games and API.async function startServer(): Promise<number> { const server = getGlobalServer(); const p = getGlobalServerPort(); if (server && p) { return p; } const app = express(); const port = await findAvailablePort(); app.get('/close', (req, res) => { getGlobalServer()?.close(); res.send('Server closed'); }); app.post('/close', (req, res) => { getGlobalServer()?.close(); res.send('Server closed'); }); // Game route: /:gameSlug with optional CDN parameter app.get('/:gameSlug', (req, res) => { const gameSlug = req.params.gameSlug; const useCDN = req.query.cdn === 'true'; res.send(createGameHTML(gameSlug, useCDN)); }); // API to list available games app.get('/api/games', (req, res) => { res.json({ games: Object.keys(DOS_GAMES), count: Object.keys(DOS_GAMES).length, gameDetails: DOS_GAMES, usage: { local: "http://localhost:PORT/GAME_SLUG", cdn: "http://localhost:PORT/GAME_SLUG?cdn=true" } }); }); // Start server setGlobalServer(app.listen(port, () => { })); setGlobalServerPort(port); return port; }
- src/tools/open-dos.ts:58-182 (helper)Helper function that generates the HTML page for embedding js-dos, including game file, executable, key mappings, and styles.function createGameHTML(gameSlug: string, useCDN: boolean = false): string { const game = DOS_GAMES[gameSlug]; if (!game) { return `<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Game Not Found</title> </head> <body> <h1>Game "${gameSlug}" not found</h1> <p>Available games: ${Object.keys(DOS_GAMES).join(', ')}</p> </body> </html>`; } // Use CDN file if requested and available, otherwise use local file const gameFile = useCDN && game.cdnFile ? game.cdnFile : game.file; // Generate key mappings display const keyMappingsHTML = game.keys .filter(k => k.code !== -1) .map(k => `<div class="key-mapping"><kbd>${k.key}</kbd> - ${k.text || k.key}</div>`) .join(''); return `<!doctype html> <html lang="en-us"> <head> <meta charset="utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>${game.title}</title> <style type="text/css"> body { margin: 0; padding: 0; } .dosbox-container { width: 100vw; height: 100vh; } .dosbox-canvas { width: 100%; height: 100%; } .dosbox-container > .dosbox-overlay { background: url(https://js-dos.com/cdn/${gameSlug.toUpperCase()}.png); background-size: contain; background-repeat: no-repeat; background-position: center; } .dosbox-start { background: rgba(0, 0, 0, 0.5); color: #0f0; font-family: monospace; font-size: 16px; padding: 10px; border: none; cursor: pointer; } body { margin: 0; padding: 20px; background: #000; color: #0f0; font-family: monospace; } button { background: #0f0; color: #000; border: none; padding: 10px 20px; margin: 10px 0; cursor: pointer; font-family: monospace; } button:hover { background: #0a0; } .info { background: #333; padding: 10px; margin: 10px 0; border-radius: 5px; } .dosbox-fullscreen { position: absolute; top: 10px; right: 10px; background: #0f0; color: #000; border: none; padding: 10px 20px; margin: 10px 0; cursor: pointer; } .controls { position: absolute; top: 10px; left: 10px; background: rgba(0, 0, 0, 0.8); padding: 15px; border-radius: 5px; font-size: 12px; max-width: 250px; } .key-mapping { margin: 5px 0; } kbd { background: #0f0; color: #000; padding: 2px 6px; border-radius: 3px; font-family: monospace; font-size: 11px; } .controls h4 { margin: 0 0 10px 0; color: #0f0; } </style> </head> <body> <div id="dosbox"></div> <button class="dosbox-fullscreen" onclick="dosbox.requestFullScreen();">Fullscreen</button> <div class="controls"> <h4>Controls:</h4> ${keyMappingsHTML} </div> <script type="text/javascript" src="https://js-dos.com/cdn/js-dos-api.js"></script> <script type="text/javascript"> const keyMappings = ${JSON.stringify(game.keys)}; var dosbox = new Dosbox({ id: "dosbox", onload: function (dosbox) { dosbox.run("${gameFile}", "${game.executable}"); }, onrun: function (dosbox, app) { console.log("App '" + app + "' is running"); // Configure key mappings if (dosbox.setKeyMapping) { keyMappings.forEach(function(mapping) { if (mapping.code !== -1) { dosbox.setKeyMapping(mapping.key, mapping.code); } }); } } }); </script> </body> </html>`; }