@tmustier/pi-nes 0.2.5 → 0.2.7

package/README.md

@@ -58,8 +58,8 @@ Config is stored at `~/.pi/nes/config.json`. Use `/nes config` for guided setup.
 
 ```json
 {
-  "romDir": "~/roms/nes",
-  "saveDir": "~/.pi/nes/saves",
+  "romDir": "/roms/nes",
+  "saveDir": "/roms/nes/saves",
   "renderer": "image",
   "pixelScale": 1.2,
   "keybindings": {
@@ -79,16 +79,16 @@ Config is stored at `~/.pi/nes/config.json`. Use `/nes config` for guided setup.
 
 | Option | Default | Description |
 |--------|---------|-------------|
-| `romDir` | `~/.pi/nes/roms` | Where to look for ROM files |
-| `saveDir` | `~/.pi/nes/saves` | Where to store battery saves |
+| `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) |
 
 ## Terminal Support
 
-**Best experience:** [Kitty](https://sw.kovidgoyal.net/kitty/) terminal with image protocol support.
+**Best experience:** a Kitty-protocol terminal like Ghostty, Kitty, or WezTerm (image protocol + key-up events).
 
-- **Kitty** — Full graphics via image protocol (shared memory or file transport)
+- **Kitty-protocol terminals** — Full graphics via image protocol (shared memory or file transport)
 - **Other terminals** — Falls back to ANSI half-block characters (`▀▄`)
 
 Set `"renderer": "text"` if you prefer the ANSI renderer or have display issues.

package/extensions/nes/config.ts

@@ -15,9 +15,15 @@ export interface NesConfig {
 	keybindings: InputMapping;
 }
 
+const DEFAULT_ROM_DIR = path.join(path.sep, "roms", "nes");
+
+export function getDefaultSaveDir(romDir: string): string {
+	return path.join(romDir, "saves");
+}
+
 export const DEFAULT_CONFIG: NesConfig = {
-	romDir: path.join(path.sep, "roms", "nes"),
-	saveDir: path.join(os.homedir(), ".pi", "nes", "saves"),
+	romDir: DEFAULT_ROM_DIR,
+	saveDir: getDefaultSaveDir(DEFAULT_ROM_DIR),
 	enableAudio: false,
 	renderer: "image",
 	pixelScale: 1.2,
@@ -39,15 +45,18 @@ export function getConfigPath(): string {
 
 export function normalizeConfig(raw: unknown): NesConfig {
 	const parsed = typeof raw === "object" && raw !== null ? (raw as RawConfig) : {};
+	const romDir =
+		typeof parsed.romDir === "string" && parsed.romDir.length > 0
+			? normalizePath(parsed.romDir, DEFAULT_CONFIG.romDir)
+			: DEFAULT_CONFIG.romDir;
+	const saveDirFallback = getDefaultSaveDir(romDir);
+	const saveDir =
+		typeof parsed.saveDir === "string" && parsed.saveDir.length > 0
+			? normalizePath(parsed.saveDir, saveDirFallback)
+			: saveDirFallback;
 	return {
-		romDir:
-			typeof parsed.romDir === "string" && parsed.romDir.length > 0
-				? normalizePath(parsed.romDir, DEFAULT_CONFIG.romDir)
-				: DEFAULT_CONFIG.romDir,
-		saveDir:
-			typeof parsed.saveDir === "string" && parsed.saveDir.length > 0
-				? normalizePath(parsed.saveDir, DEFAULT_CONFIG.saveDir)
-				: DEFAULT_CONFIG.saveDir,
+		romDir,
+		saveDir,
 		enableAudio: typeof parsed.enableAudio === "boolean" ? parsed.enableAudio : DEFAULT_CONFIG.enableAudio,
 		renderer: parsed.renderer === "text" ? "text" : DEFAULT_CONFIG.renderer,
 		pixelScale: normalizePixelScale(parsed.pixelScale),
@@ -61,12 +70,15 @@ export function formatConfig(config: NesConfig): string {
 
 export async function loadConfig(): Promise<NesConfig> {
 	const configPath = getConfigPath();
+	let config: NesConfig;
 	try {
 		const raw = await fs.readFile(configPath, "utf8");
-		return normalizeConfig(JSON.parse(raw));
+		config = normalizeConfig(JSON.parse(raw));
 	} catch {
-		return DEFAULT_CONFIG;
+		config = DEFAULT_CONFIG;
 	}
+	await ensureDirectory(config.saveDir);
+	return config;
 }
 
 export async function configExists(): Promise<boolean> {
@@ -84,6 +96,14 @@ export async function saveConfig(config: NesConfig): Promise<void> {
 	await fs.writeFile(configPath, formatConfig(config));
 }
 
+async function ensureDirectory(dirPath: string): Promise<void> {
+	try {
+		await fs.mkdir(dirPath, { recursive: true });
+	} catch {
+		// ignore
+	}
+}
+
 function normalizePixelScale(raw: unknown): number {
 	if (typeof raw !== "number" || Number.isNaN(raw)) {
 		return DEFAULT_CONFIG.pixelScale;

package/extensions/nes/index.ts

@@ -8,6 +8,7 @@ import {
 	configExists,
 	formatConfig,
 	getConfigPath,
+	getDefaultSaveDir,
 	loadConfig,
 	normalizeConfig,
 	saveConfig,
@@ -139,17 +140,28 @@ async function configureWithWizard(
 	ctx: ExtensionCommandContext,
 	config: Awaited<ReturnType<typeof loadConfig>>,
 ): Promise<boolean> {
-	const romDirPlaceholder = displayPath(config.romDir);
-	const romDirInput = await ctx.ui.input(
-		"ROM directory (or wherever you want to keep your roms)",
-		romDirPlaceholder,
-	);
-	if (romDirInput === undefined) {
+	const romDirDisplay = displayPath(config.romDir);
+	const romDirDefaultLabel = config.romDir === DEFAULT_CONFIG.romDir ? "Use default" : "Use current";
+	const romDirOptions = [
+		`${romDirDefaultLabel} (${romDirDisplay})`,
+		"Enter a custom path",
+	];
+	const romDirChoice = await ctx.ui.select("ROM directory", romDirOptions);
+	if (!romDirChoice) {
 		return false;
 	}
-	const trimmedRomDir = romDirInput.trim();
+
 	let romDir = config.romDir;
-	if (trimmedRomDir) {
+	if (romDirChoice === romDirOptions[1]) {
+		const romDirInput = await ctx.ui.input("ROM directory", romDirDisplay);
+		if (romDirInput === undefined) {
+			return false;
+		}
+		const trimmedRomDir = romDirInput.trim();
+		if (!trimmedRomDir) {
+			ctx.ui.notify("ROM directory cannot be empty.", "error");
+			return false;
+		}
 		romDir = resolvePathInput(trimmedRomDir, ctx.cwd);
 		const valid = await validateRomDir(romDir, ctx);
 		if (!valid) {
@@ -192,9 +204,13 @@ async function configureWithWizard(
 		pixelScale = parsed;
 	}
 
+	const defaultSaveDir = getDefaultSaveDir(config.romDir);
+	const shouldSyncSaveDir = config.saveDir === defaultSaveDir;
+	const saveDir = shouldSyncSaveDir ? getDefaultSaveDir(romDir) : config.saveDir;
 	const normalized = normalizeConfig({
 		...config,
 		romDir,
+		saveDir,
 		pixelScale,
 	});
 	await saveConfig(normalized);

package/package.json

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

package/spec.md

@@ -60,12 +60,10 @@ pi-nes/
 - Use `isKeyRelease()` for clean key‑up events.
 
 ## Saves
-- Store SRAM at `~/.pi/nes/saves/<rom-name>.sav`.
+- Store SRAM at `<saveDir>/<rom-name>.sav` (default `/roms/nes/saves`).
 - Load SRAM on ROM start.
 - Persist on exit and periodically (e.g., every 5–10 seconds).
 
-Note: the native core does not currently expose SRAM for persistence.
-
 ## Configuration
 - `~/.pi/nes/config.json` with:
   - `romDir`
@@ -91,4 +89,4 @@ Note: audio output is currently disabled; setting `enableAudio` will show a warn
 - Default ROM dir: `/roms/nes` (configurable).
 - Default core: `native`.
 - Default pixel scale: `1.2`.
-- Default save dir: `~/.pi/nes/saves` (configurable).
+- Default save dir: `/roms/nes/saves` (configurable).