@tmustier/pi-nes 0.2.9 → 0.2.11

package/README.md

@@ -54,14 +54,15 @@ On first run, you'll be prompted to set your ROM directory and display quality.
 
 ## Configuration
 
-Config is stored at `~/.pi/nes/config.json`. Use `/nes config` for guided setup.
+Config is stored at `~/.pi/nes/config.json`. Use `/nes config` for quick setup.
 
 ```json
 {
   "romDir": "/roms/nes",
   "saveDir": "/roms/nes/saves",
   "renderer": "image",
-  "pixelScale": 1.2,
+  "imageQuality": "balanced",
+  "pixelScale": 1.0,
   "keybindings": {
     "up": ["up", "w"],
     "down": ["down", "s"],
@@ -82,7 +83,8 @@ Config is stored at `~/.pi/nes/config.json`. Use `/nes config` for guided setup.
 | `romDir` | `/roms/nes` | Where to look for ROM files |
 | `saveDir` | `/roms/nes/saves` | Where to store battery saves (defaults to `<romDir>/saves`) |
 | `renderer` | `"image"` | `"image"` (Kitty graphics) or `"text"` (ANSI) |
-| `pixelScale` | `1.2` | Display scale (0.5–4.0) |
+| `imageQuality` | `"balanced"` | `"balanced"` (30 fps, max pixel scale 1.0) or `"high"` (60 fps, max pixel scale 1.5) |
+| `pixelScale` | `1.0` | Display scale (0.5–1.0 balanced, 0.5–1.5 high) |
 
 ## Terminal Support
 

package/extensions/nes/config.ts

@@ -5,12 +5,14 @@ import { DEFAULT_INPUT_MAPPING, type InputMapping } from "./input-map.js";
 import { normalizePath } from "./paths.js";
 
 export type RendererMode = "image" | "text";
+export type ImageQuality = "balanced" | "high";
 
 export interface NesConfig {
 	romDir: string;
 	saveDir: string;
 	enableAudio: boolean;
 	renderer: RendererMode;
+	imageQuality: ImageQuality;
 	pixelScale: number;
 	keybindings: InputMapping;
 }
@@ -26,7 +28,8 @@ export const DEFAULT_CONFIG: NesConfig = {
 	saveDir: getDefaultSaveDir(DEFAULT_ROM_DIR),
 	enableAudio: false,
 	renderer: "image",
-	pixelScale: 1.2,
+	imageQuality: "balanced",
+	pixelScale: 1.0,
 	keybindings: cloneMapping(DEFAULT_INPUT_MAPPING),
 };
 
@@ -35,6 +38,7 @@ interface RawConfig {
 	saveDir?: unknown;
 	enableAudio?: unknown;
 	renderer?: unknown;
+	imageQuality?: unknown;
 	pixelScale?: unknown;
 	keybindings?: unknown;
 }
@@ -54,12 +58,19 @@ export function normalizeConfig(raw: unknown): NesConfig {
 		typeof parsed.saveDir === "string" && parsed.saveDir.length > 0
 			? normalizePath(parsed.saveDir, saveDirFallback)
 			: saveDirFallback;
+	const imageQuality = normalizeImageQuality(parsed.imageQuality);
+	const maxPixelScale = imageQuality === "high" ? 1.5 : 1.0;
+	const pixelScale =
+		typeof parsed.pixelScale === "number" && !Number.isNaN(parsed.pixelScale)
+			? normalizePixelScale(parsed.pixelScale, maxPixelScale)
+			: maxPixelScale;
 	return {
 		romDir,
 		saveDir,
 		enableAudio: typeof parsed.enableAudio === "boolean" ? parsed.enableAudio : DEFAULT_CONFIG.enableAudio,
 		renderer: parsed.renderer === "text" ? "text" : DEFAULT_CONFIG.renderer,
-		pixelScale: normalizePixelScale(parsed.pixelScale),
+		imageQuality,
+		pixelScale,
 		keybindings: normalizeKeybindings(parsed.keybindings),
 	};
 }
@@ -104,11 +115,12 @@ async function ensureDirectory(dirPath: string): Promise<void> {
 	}
 }
 
-function normalizePixelScale(raw: unknown): number {
-	if (typeof raw !== "number" || Number.isNaN(raw)) {
-		return DEFAULT_CONFIG.pixelScale;
-	}
-	return Math.min(4, Math.max(0.5, raw));
+function normalizePixelScale(raw: number, maxPixelScale: number): number {
+	return Math.min(maxPixelScale, Math.max(0.5, raw));
+}
+
+function normalizeImageQuality(raw: unknown): ImageQuality {
+	return raw === "high" ? "high" : "balanced";
 }
 
 function normalizeKeybindings(raw: unknown): InputMapping {

package/extensions/nes/index.ts

@@ -18,7 +18,8 @@ import { NesSession } from "./nes-session.js";
 import { listRoms } from "./roms.js";
 import { loadSram } from "./saves.js";
 
-const IMAGE_RENDER_INTERVAL_MS = 1000 / 30;
+const IMAGE_RENDER_INTERVAL_BALANCED_MS = 1000 / 30;
+const IMAGE_RENDER_INTERVAL_HIGH_MS = 1000 / 60;
 const TEXT_RENDER_INTERVAL_MS = 1000 / 60;
 
 let activeSession: NesSession | null = null;
@@ -143,8 +144,8 @@ async function configureWithWizard(
 	const romDirDisplay = displayPath(config.romDir);
 	const romDirDefaultLabel = config.romDir === DEFAULT_CONFIG.romDir ? "Use default" : "Use current";
 	const romDirOptions = [
-		`${romDirDefaultLabel} (${romDirDisplay})`,
-		"Enter a custom path",
+		`${romDirDefaultLabel} (${romDirDisplay}) — creates if missing`,
+		"Enter a custom path (must exist)",
 	];
 	const romDirChoice = await ctx.ui.select("ROM directory", romDirOptions);
 	if (!romDirChoice) {
@@ -153,7 +154,7 @@ async function configureWithWizard(
 
 	let romDir = config.romDir;
 	if (romDirChoice === romDirOptions[1]) {
-		const romDirInput = await ctx.ui.input("ROM directory", romDirDisplay);
+		const romDirInput = await ctx.ui.input("ROM directory (must exist)", romDirDisplay);
 		if (romDirInput === undefined) {
 			return false;
 		}
@@ -174,35 +175,17 @@ async function configureWithWizard(
 		}
 	}
 
-	const qualityChoice = await ctx.ui.select("Quality (pixel scale)", [
-		"Balanced (1.2) - recommended",
-		"Low (1.0) - faster",
-		"High (1.5) - sharper",
-		"Custom...",
+	const qualityChoice = await ctx.ui.select("Quality", [
+		"Balanced (recommended) — 30 fps, max pixel scale 1.0",
+		"High — 60 fps, max pixel scale 1.5",
 	]);
 	if (!qualityChoice) {
 		return false;
 	}
 
-	let pixelScale: number;
-	if (qualityChoice.startsWith("Low")) {
-		pixelScale = 1.0;
-	} else if (qualityChoice.startsWith("Balanced")) {
-		pixelScale = 1.2;
-	} else if (qualityChoice.startsWith("High")) {
-		pixelScale = 1.5;
-	} else {
-		const pixelScaleInput = await ctx.ui.input("Pixel scale (0.5 - 4)", config.pixelScale.toString());
-		if (pixelScaleInput === undefined) {
-			return false;
-		}
-		const parsed = pixelScaleInput.trim() === "" ? config.pixelScale : Number(pixelScaleInput);
-		if (Number.isNaN(parsed)) {
-			ctx.ui.notify("Pixel scale must be a number.", "error");
-			return false;
-		}
-		pixelScale = parsed;
-	}
+	const isHighQuality = qualityChoice.startsWith("High");
+	const imageQuality = isHighQuality ? "high" : "balanced";
+	const pixelScale = isHighQuality ? 1.5 : 1.0;
 
 	const defaultSaveDir = getDefaultSaveDir(config.romDir);
 	const shouldSyncSaveDir = config.saveDir === defaultSaveDir;
@@ -211,6 +194,7 @@ async function configureWithWizard(
 		...config,
 		romDir,
 		saveDir,
+		imageQuality,
 		pixelScale,
 	});
 	await saveConfig(normalized);
@@ -318,7 +302,11 @@ async function attachSession(
 				}
 			: undefined;
 
-		const renderIntervalMs = config.renderer === "image" ? IMAGE_RENDER_INTERVAL_MS : TEXT_RENDER_INTERVAL_MS;
+		const renderIntervalMs = config.renderer === "image"
+			? config.imageQuality === "high"
+				? IMAGE_RENDER_INTERVAL_HIGH_MS
+				: IMAGE_RENDER_INTERVAL_BALANCED_MS
+			: TEXT_RENDER_INTERVAL_MS;
 		session.setRenderIntervalMs(renderIntervalMs);
 
 		await ctx.ui.custom(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tmustier/pi-nes",
-  "version": "0.2.9",
+  "version": "0.2.11",
   "description": "NES emulator extension for pi",
   "keywords": [
     "pi-package",

package/spec.md

@@ -70,7 +70,8 @@ pi-nes/
   - `saveDir`
   - `enableAudio`
   - `renderer` ("image" or "text")
-  - `pixelScale` (float, e.g. 1.5)
+  - `imageQuality` ("balanced" or "high")
+  - `pixelScale` (float, e.g. 1.0)
   - `keybindings` (button-to-keys map, e.g. `{ "a": ["z"] }`)
 
 Note: audio output is currently disabled; setting `enableAudio` will show a warning.
@@ -88,5 +89,6 @@ Note: audio output is currently disabled; setting `enableAudio` will show a warn
 - Audio: disabled (no safe dependency selected).
 - Default ROM dir: `/roms/nes` (configurable).
 - Default core: `native`.
-- Default pixel scale: `1.2`.
+- Default image quality: `balanced`.
+- Default pixel scale: `1.0`.
 - Default save dir: `/roms/nes/saves` (configurable).