@muhammedaksam/opentui-doom 0.3.0 → 0.3.6

package/README.md

@@ -1,3 +1,11 @@
+[![npm version](https://img.shields.io/npm/v/@muhammedaksam/opentui-doom.svg)](https://www.npmjs.com/package/@muhammedaksam/opentui-doom)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/)
+[![Bun](https://img.shields.io/badge/Bun-000?logo=bun&logoColor=fff)](https://bun.sh/)
+[![Alacritty](https://img.shields.io/badge/Alacritty-F46D01?logo=alacritty&logoColor=fff)](https://alacritty.org/)
+[![CI](https://github.com/muhammedaksam/opentui-doom/workflows/CI/badge.svg)](https://github.com/muhammedaksam/opentui-doom/actions)
+[![Mentioned in Awesome OpenTUI](https://awesome.re/mentioned-badge.svg)](https://github.com/msmps/awesome-opentui)
+
 # DOOM for OpenTUI
 
 🎮 Play DOOM in your terminal using [OpenTUI](https://github.com/sst/opentui)'s framebuffer rendering!
@@ -6,6 +14,7 @@
 
 - **Full DOOM gameplay** in your terminal
 - **High-resolution rendering** using half-block characters (▀) for 2x vertical resolution
+- **Mouse aiming** - Turn and fire with your mouse (enabled by default)
 - **Keyboard input support** with WASD and arrow keys
 - **Save/Load game** support - saves persist to `~/.opentui-doom/`
 - **Sound effects and music** via mpv
@@ -68,20 +77,34 @@ Place the WAD file in the project root.
 bun run dev -- --wad ./doom1.wad
 ```
 
+To disable mouse aiming:
+
+```bash
+bun run dev -- --wad ./doom1.wad --mouse false
+```
+
+### Debug Mode
+
+To run with debug logging enabled (outputs to `debug.log`):
+
+```bash
+bun run dev:debug -- --wad ./doom1.wad
+```
+
 ## 🎮 Controls
 
-| Action            | Keys           |
-| ----------------- | -------------- |
-| Move Forward/Back | W / S or ↑ / ↓ |
-| Turn Left/Right   | ← / →          |
-| Strafe            | A / D          |
-| Fire              | Ctrl           |
-| Use/Open          | Space          |
-| Run               | Shift          |
-| Weapons           | 1-7            |
-| Menu              | Escape         |
-| Map               | Tab            |
-| Quit              | Ctrl+C         |
+| Action            | Keys               |
+| ----------------- | ------------------ |
+| Move Forward/Back | W / S or ↑ / ↓     |
+| Turn Left/Right   | Mouse or ← / →     |
+| Strafe            | A / D              |
+| Fire              | Left Click or Ctrl |
+| Use/Open          | Space              |
+| Run               | Shift              |
+| Weapons           | 1-7                |
+| Menu              | Escape             |
+| Map               | Tab                |
+| Quit              | Ctrl+C             |
 
 ## 💾 Save Games
 
@@ -148,7 +171,8 @@ opentui-doom/
 ├── src/
 │   ├── index.ts          # Main entry point
 │   ├── doom-engine.ts    # WASM module wrapper
-│   └── doom-input.ts     # Keyboard input mapping
+│   ├── doom-input.ts     # Keyboard input mapping
+│   └── doom-mouse.ts     # Mouse input handling
 ├── doom/
 │   ├── doomgeneric_opentui.c  # Platform implementation
 │   ├── doomgeneric/           # doomgeneric source (cloned during build)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@muhammedaksam/opentui-doom",
-  "version": "0.3.0",
+  "version": "0.3.6",
   "description": "Play DOOM in your terminal using OpenTUI's framebuffer rendering and doomgeneric WASM",
   "module": "src/index.ts",
   "type": "module",
@@ -48,20 +48,27 @@
     "build:doom": "bash ./scripts/build-doom.sh",
     "build": "bun build src/index.ts --outdir dist --target node",
     "typecheck": "bun x tsc --noEmit",
+    "lint": "eslint src/",
+    "lint:fix": "eslint src/ --fix",
+    "format": "prettier --write src/",
+    "format:check": "prettier --check src/",
     "start": "bun run src/index.ts",
     "prepublishOnly": "bun run build:doom"
   },
   "devDependencies": {
-    "@types/bun": "latest"
+    "@eslint/js": "^9.17.0",
+    "@types/bun": "latest",
+    "eslint": "^9.17.0",
+    "prettier": "^3.4.2",
+    "typescript-eslint": "^8.18.1"
   },
   "peerDependencies": {
     "typescript": "^5"
   },
   "dependencies": {
-    "@opentui/core": "^0.1.57"
+    "@opentui/core": "^0.1.59"
   },
   "engines": {
-    "node": ">=18",
     "bun": ">=1.0"
   }
-}
+}

package/src/debug.ts

@@ -1,6 +1,6 @@
 /**
  * Debug logging utility for OpenTUI-DOOM
- * 
+ *
  * Only logs when DOOM_DEBUG environment variable is set.
  * Usage: DOOM_DEBUG=1 bun run dev
  */
@@ -16,12 +16,12 @@ const logFile = join(import.meta.dir, "..", "debug.log");
  */
 export function debugLog(category: string, message: string): void {
   if (!DEBUG_ENABLED) return;
-  
+
   const timestamp = new Date().toISOString();
   const line = `[${timestamp}] [${category}] ${message}\n`;
   try {
     appendFileSync(logFile, line);
-  } catch (e) {
+  } catch (_e) {
     // Ignore logging errors
   }
 }

package/src/doom-audio.ts

@@ -1,6 +1,6 @@
 /**
  * DOOM Audio Bridge for OpenTUI
- * 
+ *
  * Handles audio playback using mpv with proper process management.
  * All spawned processes are tracked and terminated on shutdown.
  */
@@ -8,12 +8,12 @@
 import { spawn, ChildProcess } from "child_process";
 import { join } from "path";
 import { existsSync, unlinkSync } from "fs";
-import { createConnection, Socket } from "net";
+import { createConnection } from "net";
 import { debugLog } from "./debug";
 
 // Local helper to log with Audio category
 function log(message: string): void {
-    debugLog('Audio', message);
+  debugLog("Audio", message);
 }
 
 // Track all spawned mpv processes for cleanup
@@ -36,88 +36,88 @@ let initialized = false;
 
 // Current music state for volume changes
 let currentMusicName: string | null = null;
-let currentMusicLooping: boolean = false;
+let _currentMusicLooping: boolean = false;
 
 /**
  * Initialize the audio system
  */
 export function initAudio(): void {
-    if (initialized) return;
-    initialized = true;
-    log(`Initialized, sound dir: ${soundDir}`);
+  if (initialized) return;
+  initialized = true;
+  log(`Initialized, sound dir: ${soundDir}`);
 }
 
 /**
  * Shutdown the audio system and kill ALL spawned processes
  */
 export function shutdownAudio(): void {
-    if (!initialized) return;
-
-    // Kill music process
-    if (musicProcess) {
-        try {
-            musicProcess.kill("SIGKILL");
-        } catch (e) {
-            // Process may have already exited
-        }
-        musicProcess = null;
+  if (!initialized) return;
+
+  // Kill music process
+  if (musicProcess) {
+    try {
+      musicProcess.kill("SIGKILL");
+    } catch (_e) {
+      // Process may have already exited
     }
+    musicProcess = null;
+  }
 
-    // Kill ALL tracked processes
-    for (const proc of activeProcesses) {
-        try {
-            proc.kill("SIGKILL");
-        } catch (e) {
-            // Process may have already exited
-        }
+  // Kill ALL tracked processes
+  for (const proc of activeProcesses) {
+    try {
+      proc.kill("SIGKILL");
+    } catch (_e) {
+      // Process may have already exited
     }
-    activeProcesses.clear();
+  }
+  activeProcesses.clear();
 
-    initialized = false;
-    log("Shutdown complete");
+  initialized = false;
+  log("Shutdown complete");
 }
 
 /**
  * Helper to spawn mpv with common options
  */
 function spawnMpv(filePath: string, options: string[] = []): ChildProcess | null {
-    if (!existsSync(filePath)) {
-        log(`File not found: ${filePath}`);
-        return null;
-    }
-
-    const args = [
-        "--no-video",           // No video output
-        "--no-terminal",        // No terminal output
-        "--really-quiet",       // Suppress all output
-        ...options,
-        filePath
-    ];
-
-    try {
-        const proc = spawn("mpv", args, {
-            stdio: "ignore",
-            detached: false,    // Keep attached to parent process
-        });
-
-        // Track the process
-        activeProcesses.add(proc);
-
-        // Remove from tracking when process exits
-        proc.on("exit", () => {
-            activeProcesses.delete(proc);
-        });
-
-        proc.on("error", (err) => {
-            log(`mpv error: ${err.message}`);
-            activeProcesses.delete(proc);
-        });
-
-        return proc;
-    } catch (e) {
-        log(`Failed to spawn mpv: ${e}`);
-        return null;
-    }
+  if (!existsSync(filePath)) {
+    log(`File not found: ${filePath}`);
+    return null;
+  }
+
+  const args = [
+    "--no-video", // No video output
+    "--no-terminal", // No terminal output
+    "--really-quiet", // Suppress all output
+    ...options,
+    filePath,
+  ];
+
+  try {
+    const proc = spawn("mpv", args, {
+      stdio: "ignore",
+      detached: false, // Keep attached to parent process
+    });
+
+    // Track the process
+    activeProcesses.add(proc);
+
+    // Remove from tracking when process exits
+    proc.on("exit", () => {
+      activeProcesses.delete(proc);
+    });
+
+    proc.on("error", (err) => {
+      log(`mpv error: ${err.message}`);
+      activeProcesses.delete(proc);
+    });
+
+    return proc;
+  } catch (e) {
+    log(`Failed to spawn mpv: ${e}`);
+    return null;
+  }
 }
 
 /**
@@ -126,20 +126,20 @@ function spawnMpv(filePath: string, options: string[] = []): ChildProcess | null
  * Volume is 0-127 (DOOM standard)
  */
 export function playSound(name: string, volume: number = 127): void {
-    if (!initialized) {
-        log("playSound called but not initialized");
-        return;
-    }
+  if (!initialized) {
+    log("playSound called but not initialized");
+    return;
+  }
 
-    const soundPath = join(soundDir, `ds${name.toLowerCase()}.wav`);
+  const soundPath = join(soundDir, `ds${name.toLowerCase()}.wav`);
 
-    // Convert DOOM volume (0-127) to mpv volume (0-100)
-    const mpvVolume = Math.round((volume / 127) * 100);
-    log(`Playing sound: ${soundPath} at volume ${mpvVolume}`);
+  // Convert DOOM volume (0-127) to mpv volume (0-100)
+  const mpvVolume = Math.round((volume / 127) * 100);
+  log(`Playing sound: ${soundPath} at volume ${mpvVolume}`);
 
-    // Fire and forget - process will auto-cleanup when done
-    const proc = spawnMpv(soundPath, [`--volume=${mpvVolume}`]);
-    log(`Spawn result: ${proc ? "success" : "failed"}`);
+  // Fire and forget - process will auto-cleanup when done
+  const proc = spawnMpv(soundPath, [`--volume=${mpvVolume}`]);
+  log(`Spawn result: ${proc ? "success" : "failed"}`);
 }
 
 /**
@@ -147,57 +147,57 @@ export function playSound(name: string, volume: number = 127): void {
  * Music files should be in sound/{name}.mp3
  */
 export function playMusic(name: string, looping: boolean): void {
-    if (!initialized) {
-        log("playMusic called but not initialized");
-        return;
-    }
-
-    // Stop any currently playing music
-    stopMusic();
-
-    // Clean up any stale socket file
-    try {
-        if (existsSync(musicSocketPath)) {
-            unlinkSync(musicSocketPath);
-        }
-    } catch (e) {
-        // Ignore
-    }
-
-    // Store music state for volume changes
-    currentMusicName = name;
-    currentMusicLooping = looping;
-
-    const musicPath = join(soundDir, `${name.toLowerCase()}.mp3`);
-    log(`Playing music: ${musicPath}, looping: ${looping}`);
-    const options: string[] = [
-        `--input-ipc-server=${musicSocketPath}`,  // Enable IPC for volume control
-    ];
-    if (looping) {
-        options.push("--loop=inf");
+  if (!initialized) {
+    log("playMusic called but not initialized");
+    return;
+  }
+
+  // Stop any currently playing music
+  stopMusic();
+
+  // Clean up any stale socket file
+  try {
+    if (existsSync(musicSocketPath)) {
+      unlinkSync(musicSocketPath);
     }
-
-    // Set volume (mpv uses 0-100 scale, DOOM uses 0-127)
-    const mpvVolume = Math.round((currentVolume / 127) * 100);
-    options.push(`--volume=${mpvVolume}`);
-
-    musicProcess = spawnMpv(musicPath, options);
+  } catch (_e) {
+    // Ignore
+  }
+
+  // Store music state for volume changes
+  currentMusicName = name;
+  _currentMusicLooping = looping;
+
+  const musicPath = join(soundDir, `${name.toLowerCase()}.mp3`);
+  log(`Playing music: ${musicPath}, looping: ${looping}`);
+  const options: string[] = [
+    `--input-ipc-server=${musicSocketPath}`, // Enable IPC for volume control
+  ];
+  if (looping) {
+    options.push("--loop=inf");
+  }
+
+  // Set volume (mpv uses 0-100 scale, DOOM uses 0-127)
+  const mpvVolume = Math.round((currentVolume / 127) * 100);
+  options.push(`--volume=${mpvVolume}`);
+
+  musicProcess = spawnMpv(musicPath, options);
 }
 
 /**
  * Stop the currently playing music
  */
 export function stopMusic(): void {
-    if (musicProcess) {
-        try {
-            musicProcess.kill("SIGTERM");
-        } catch (e) {
-            // Process may have already exited
-        }
-        activeProcesses.delete(musicProcess);
-        musicProcess = null;
+  if (musicProcess) {
+    try {
+      musicProcess.kill("SIGTERM");
+    } catch (_e) {
+      // Process may have already exited
     }
-    currentMusicName = null;
+    activeProcesses.delete(musicProcess);
+    musicProcess = null;
+  }
+  currentMusicName = null;
 }
 
 /**
@@ -205,32 +205,32 @@ export function stopMusic(): void {
  * Uses IPC socket to change volume without restarting music
  */
 export function setMusicVolume(volume: number): void {
-    const newVolume = Math.max(0, Math.min(127, volume));
-    currentVolume = newVolume;
-
-    // If no music is playing, just save the volume for next play
-    if (!musicProcess || !currentMusicName) {
-        return;
-    }
-
-    // Convert to mpv volume (0-100)
-    const mpvVolume = Math.round((newVolume / 127) * 100);
-    log(`Setting music volume to ${mpvVolume} via IPC`);
-
-    // Send volume command via IPC socket
-    try {
-        const socket = createConnection(musicSocketPath);
-
-        socket.on("connect", () => {
-            const cmd = JSON.stringify({ command: ["set_property", "volume", mpvVolume] }) + "\n";
-            socket.write(cmd);
-            socket.end();
-        });
-
-        socket.on("error", (err) => {
-            log(`IPC socket error: ${err.message}`);
-        });
-    } catch (e) {
-        log(`Failed to send IPC command: ${e}`);
-    }
+  const newVolume = Math.max(0, Math.min(127, volume));
+  currentVolume = newVolume;
+
+  // If no music is playing, just save the volume for next play
+  if (!musicProcess || !currentMusicName) {
+    return;
+  }
+
+  // Convert to mpv volume (0-100)
+  const mpvVolume = Math.round((newVolume / 127) * 100);
+  log(`Setting music volume to ${mpvVolume} via IPC`);
+
+  // Send volume command via IPC socket
+  try {
+    const socket = createConnection(musicSocketPath);
+
+    socket.on("connect", () => {
+      const cmd = JSON.stringify({ command: ["set_property", "volume", mpvVolume] }) + "\n";
+      socket.write(cmd);
+      socket.end();
+    });
+
+    socket.on("error", (err) => {
+      log(`IPC socket error: ${err.message}`);
+    });
+  } catch (e) {
+    log(`Failed to send IPC command: ${e}`);
+  }
 }