@tmustier/pi-nes 0.2.34 → 0.2.36

package/README.md

@@ -51,12 +51,13 @@ On first run, you'll be prompted to set your ROM directory and display quality.
 |---------|-------------|
 | `/nes` | Pick a ROM or reattach to running session |
 | `/nes <path>` | Load a specific ROM file |
-| `/nes config` | Configure ROM directory and quality |
+| `/nes config` | Quick setup (ROM directory + audio) |
+| `/nes-config` | Toggle audio, quality, and display style + advanced options |
 | `/nes debug` | Show FPS and memory stats |
 
 ## Configuration
 
-Config is stored at `~/.pi/nes/config.json`. Use `/nes config` for quick setup.
+Config is stored at `~/.pi/nes/config.json`. Use `/nes config` for quick setup (ROM dir + audio), or `/nes-config` to toggle audio/quality/style inline and access advanced options.
 
 ```json
 {
@@ -65,6 +66,7 @@ Config is stored at `~/.pi/nes/config.json`. Use `/nes config` for quick setup.
   "renderer": "image",
   "imageQuality": "balanced",
   "videoFilter": "ntsc-composite",
+  "enableAudio": false,
   "pixelScale": 1.0,
   "keybindings": {
     "up": ["up", "w"],
@@ -88,6 +90,7 @@ Config is stored at `~/.pi/nes/config.json`. Use `/nes config` for quick setup.
 | `renderer` | `"image"` | `"image"` (Kitty graphics) or `"text"` (ANSI) |
 | `imageQuality` | `"balanced"` | `"balanced"` (30 fps) or `"high"` (60 fps) |
 | `videoFilter` | `"ntsc-composite"` | `"off"`, `"ntsc-composite"`, `"ntsc-svideo"`, `"ntsc-rgb"` |
+| `enableAudio` | `false` | Enable audio output (requires native core built with `audio-cpal`) |
 | `pixelScale` | `1.0` | Display scale (0.5–4.0) |
 
 `videoFilter` applies a lightweight CRT/NTSC-inspired pass (horizontal bleed + scanlines). It runs in the native core and is optional.
@@ -109,8 +112,8 @@ Set `"renderer": "text"` if you prefer the ANSI renderer or have display issues.
 
 ## Limitations
 
-- **No audio** — Sound is not currently supported
-- **No save states** — Only battery-backed SRAM saves work
+- **Audio is opt-in** — Requires building the native core with `audio-cpal` and setting `enableAudio: true`
+- **No auto-save** — Save manually just like you would with the original NES (battery-backed SRAM)
 
 ## Vendored Dependencies
 
@@ -133,6 +136,9 @@ npm install
 cd extensions/nes/native/nes-core
 npm install && npm run build
 
+# Build the NES core with audio (optional)
+npm run build:audio
+
 # Build shared memory renderer (optional, faster on Kitty)
 cd ../kitty-shm
 npm install && npm run build

package/extensions/nes/index.ts

@@ -1,6 +1,8 @@
 import { promises as fs } from "node:fs";
 import path from "node:path";
-import type { ExtensionAPI, ExtensionCommandContext } from "@mariozechner/pi-coding-agent";
+import type { ExtensionAPI, ExtensionCommandContext, Theme } from "@mariozechner/pi-coding-agent";
+import { DynamicBorder, getSettingsListTheme } from "@mariozechner/pi-coding-agent";
+import { Container, SettingsList, Spacer, Text, type SettingItem } from "@mariozechner/pi-tui";
 import { NesOverlayComponent } from "./nes-component.js";
 import { createNesCore } from "./nes-core.js";
 import {
@@ -12,6 +14,8 @@ import {
 	loadConfig,
 	normalizeConfig,
 	saveConfig,
+	type ImageQuality,
+	type NesConfig,
 	type VideoFilter,
 } from "./config.js";
 import { displayPath, resolvePathInput } from "./paths.js";
@@ -24,6 +28,17 @@ const IMAGE_RENDER_INTERVAL_BALANCED_MS = 1000 / 30;
 const IMAGE_RENDER_INTERVAL_HIGH_MS = 1000 / 60;
 const TEXT_RENDER_INTERVAL_MS = 1000 / 60;
 
+const AUDIO_OPTIONS = ["off (default)", "on"] as const;
+const QUALITY_OPTIONS: Array<{ label: string; value: ImageQuality }> = [
+	{ label: "Balanced (default) — 30 fps", value: "balanced" },
+	{ label: "High — 60 fps", value: "high" },
+];
+const DISPLAY_FILTER_OPTIONS: Array<{ label: string; value: VideoFilter }> = [
+	{ label: "CRT Classic (default) — authentic scanlines + color bleed", value: "ntsc-composite" },
+	{ label: "CRT Soft — subtle retro look", value: "ntsc-rgb" },
+	{ label: "Sharp — pixel-perfect, no filtering", value: "off" },
+];
+
 let activeSession: NesSession | null = null;
 
 // ROM selection helpers.
@@ -160,31 +175,13 @@ async function configureWithWizard(
 		}
 	}
 
-	const qualityChoice = await ctx.ui.select("Quality", [
-		"Balanced (recommended) — 30 fps",
-		"High — 60 fps",
-	]);
-	if (!qualityChoice) {
-		return false;
-	}
-
-	const isHighQuality = qualityChoice.startsWith("High");
-	const imageQuality = isHighQuality ? "high" : "balanced";
-
-	const filterOptions: Array<{ label: string; value: VideoFilter }> = [
-		{ label: "CRT Classic (default) — authentic scanlines + color bleed", value: "ntsc-composite" },
-		{ label: "CRT Soft — subtle retro look", value: "ntsc-rgb" },
-		{ label: "Sharp — pixel-perfect, no filtering", value: "off" },
-	];
-	const filterChoice = await ctx.ui.select(
-		"Display style",
-		filterOptions.map((option) => option.label),
-	);
-	if (!filterChoice) {
+	const audioChoice = await ctx.ui.select("Audio", ["Off (default)", "On"]);
+	if (!audioChoice) {
 		return false;
 	}
-	const videoFilter =
-		filterOptions.find((option) => option.label === filterChoice)?.value ?? DEFAULT_CONFIG.videoFilter;
+	const enableAudio = audioChoice === "On";
+	const imageQuality = config.imageQuality;
+	const videoFilter = config.videoFilter;
 	const pixelScale = config.pixelScale;
 
 	const defaultSaveDir = getDefaultSaveDir(config.romDir);
@@ -194,21 +191,129 @@ async function configureWithWizard(
 		...config,
 		romDir,
 		saveDir,
+		enableAudio,
 		imageQuality,
 		videoFilter,
 		pixelScale,
 	});
 	await saveConfig(normalized);
 	ctx.ui.notify(`Saved config to ${getConfigPath()}`, "info");
+	await ctx.ui.select(
+		"Toggle audio, quality, and more in /nes-config",
+		["Run /nes to load your games"],
+	);
 	return true;
 }
 
+type ConfigMenuResult = "close" | "more";
+
+type ConfigUpdate = Partial<NesConfig>;
+
+class NesConfigMenu extends Container {
+	private readonly settingsList: SettingsList;
+
+	constructor(
+		config: NesConfig,
+		theme: Theme,
+		onUpdate: (update: ConfigUpdate) => void,
+		onDone: (result: ConfigMenuResult) => void,
+	) {
+		super();
+		const audioValue = config.enableAudio ? "on" : "off (default)";
+		const qualityValue =
+			QUALITY_OPTIONS.find((option) => option.value === config.imageQuality)?.label
+			?? QUALITY_OPTIONS[0].label;
+		const displayValue =
+			DISPLAY_FILTER_OPTIONS.find((option) => option.value === config.videoFilter)?.label
+			?? DISPLAY_FILTER_OPTIONS[0].label;
+		const items: SettingItem[] = [
+			{
+				id: "audio",
+				label: "Audio",
+				description: "Enable audio output (requires native core built with audio-cpal)",
+				currentValue: audioValue,
+				values: [...AUDIO_OPTIONS],
+			},
+			{
+				id: "quality",
+				label: "Quality",
+				description: "Target frame rate for image rendering",
+				currentValue: qualityValue,
+				values: QUALITY_OPTIONS.map((option) => option.label),
+			},
+			{
+				id: "display",
+				label: "Display style",
+				description: "CRT filter preset (applied in the native core)",
+				currentValue: displayValue,
+				values: DISPLAY_FILTER_OPTIONS.map((option) => option.label),
+			},
+			{
+				id: "more",
+				label: "More settings",
+				description: "Quick setup, advanced JSON, or reset defaults",
+				currentValue: "Open",
+				values: ["Open"],
+			},
+		];
+
+		this.settingsList = new SettingsList(
+			items,
+			8,
+			getSettingsListTheme(),
+			(id, value) => {
+				if (id === "audio") {
+					onUpdate({ enableAudio: value === "on" });
+					return;
+				}
+				if (id === "quality") {
+					const option = QUALITY_OPTIONS.find((entry) => entry.label === value);
+					onUpdate({ imageQuality: option?.value ?? config.imageQuality });
+					return;
+				}
+				if (id === "display") {
+					const option = DISPLAY_FILTER_OPTIONS.find((entry) => entry.label === value);
+					onUpdate({ videoFilter: option?.value ?? config.videoFilter });
+					return;
+				}
+				if (id === "more") {
+					onDone("more");
+				}
+			},
+			() => onDone("close"),
+		);
+
+		this.addChild(new DynamicBorder());
+		this.addChild(new Text(theme.bold(theme.fg("accent", "NES config")), 1, 0));
+		this.addChild(new Spacer(1));
+		this.addChild(this.settingsList);
+		this.addChild(new Spacer(1));
+		this.addChild(new DynamicBorder());
+	}
+
+	handleInput(data: string): void {
+		this.settingsList.handleInput(data);
+	}
+}
+
 async function editConfig(ctx: ExtensionCommandContext): Promise<void> {
 	if (!ctx.hasUI) {
 		ctx.ui.notify("NES config requires interactive mode", "error");
 		return;
 	}
 	const config = await loadConfig();
+	const updateConfig = async (update: ConfigUpdate) => {
+		const normalized = normalizeConfig({ ...config, ...update });
+		await saveConfig(normalized);
+		Object.assign(config, normalized);
+		ctx.ui.notify(`Saved config to ${getConfigPath()}`, "info");
+	};
+	const action = await ctx.ui.custom<ConfigMenuResult>((_tui, theme, _keybindings, done) =>
+		new NesConfigMenu(config, theme, (update) => void updateConfig(update), done),
+	);
+	if (action !== "more") {
+		return;
+	}
 	const choice = await ctx.ui.select("NES configuration", [
 		"Quick setup",
 		"Advanced (edit config JSON)",