@pinkpixel/haku 0.1.0 → 1.0.0

package/README.md

@@ -11,7 +11,7 @@ The `haku` command gives you (or your agent) a tool for every drawing command, p
 - Node 22.18 or newer
 - For listening without the browser: one of `pw-play`, `paplay`, `aplay`, `afplay`, or `ffplay` (Windows uses PowerShell, so nothing extra there)
 
-The package is about 7 MB, mostly because the instrument samples come with it.
+The package is about 9 MB, mostly because the instrument samples come with it. The web app is in there too.
 
 ## Install
 
@@ -93,7 +93,7 @@ Every drawing and editing command is its own tool (`draw_line`, `set_mood`, `add
 | `new_project` | Makes a new `.haku.json` from a mood |
 | `batch` | Runs a list of commands as one step. All or nothing |
 | `describe` | Reads the project back as text, with a little piano roll per layer |
-| `snapshot` | A PNG of a scene: chords, notes, strokes, and a legend. `--out` saves it as `.png` or `.svg` |
+| `snapshot` | A PNG of a scene: chords, notes, strokes, and a legend. `--scope song` draws the whole arrangement instead: the song order, then each scene's chords and notes. `--out` saves it as `.png` or `.svg` |
 | `analyze` | Notes per layer, how many strong-beat notes are chord tones, notes outside the key, half-step clashes between layers, and loudness in LUFS |
 | `play` / `stop` | Renders the scene (or the whole song) and plays it through your speakers |
 | `export` | WAV, MIDI, or the project file, for one scene or the whole song |
@@ -102,21 +102,23 @@ Every drawing and editing command is its own tool (`draw_line`, `set_mood`, `add
 
 ## Working live in the browser
 
-Haku also has a web app with the actual drawing canvas. When it's open, leave out `-f` and the tools work on that tab instead of a file, so you see and hear every change, and Ctrl+Z still undoes it. The MCP server hosts a small bridge on `127.0.0.1:5179` for this, and the tab connects on its own. Without an MCP server, run `haku bridge` in another terminal.
-
-Right now the web app isn't hosted anywhere, so live mode means running it from the repo:
+Haku also has a web app with the actual drawing canvas, and it ships in this package. Open it with:
 
 ```bash
-git clone https://github.com/pinkpixel-dev/haku.git
-cd haku
-pnpm install
-pnpm --filter @haku/web dev
+haku web
 ```
 
-Then open http://localhost:5178. A few things to know:
+That serves the app on http://127.0.0.1:5177, hosts the agent bridge, and opens your default browser. Leave out `-f` and the tools work on that tab instead of a file, so you see and hear every change, and Ctrl+Z still undoes it. The MCP server also hosts the bridge on `127.0.0.1:5179`, and the tab connects to whichever one is running on its own.
+
+You don't have to open it first. When a tool needs the tab and none is connected, Haku starts `haku web` in the background (it quits after 30 minutes with no tab connected), opens the browser, and waits for the tab. Set `HAKU_NO_LAUNCH=1` if you'd rather get an error instead.
+
+In Chrome or Edge you can install Haku as an app from the install icon in the address bar. It gets its own window, and since the app and samples are cached after the first visit, it opens fine even when `haku web` isn't running. Agents only reach it while a bridge is up, though, so start `haku web` or your MCP client first if you want that.
+
+A few things to know:
 
 - Browsers won't let a page make sound until you've clicked in it once. If `play` says so, click anywhere in the tab and try again.
 - With more than one Haku tab open, tools drive the one you clicked into most recently.
+- Your projects are saved in the browser for `127.0.0.1:5177`. Changing `HAKU_WEB_PORT` gives you a separate, empty project list, so use the folder button to export and import if you move.
 - The bridge only accepts tabs from `localhost` pages and only accepts tools from outside the browser. `HAKU_ALLOW_ORIGINS` (comma separated) adds other page origins, and `HAKU_BRIDGE_PORT` changes the port.
 
 ## Environment variables
@@ -125,19 +127,24 @@ Then open http://localhost:5178. A few things to know:
 |---|---|
 | `HAKU_PROJECT` | Default project file for commands that take `-f` |
 | `HAKU_BRIDGE_PORT` | Bridge port. Default `5179` |
+| `HAKU_WEB_PORT` | Port `haku web` serves the app on. Default `5177` |
+| `HAKU_NO_LAUNCH` | Set it to stop tools from opening Haku when no tab is connected |
 | `HAKU_ALLOW_ORIGINS` | Extra page origins allowed to connect as a Haku tab |
 | `HAKU_SAMPLES` | Use a different sample folder (one with a `manifest.json`) |
 
 ## Credits
 
-Haku's code is Apache 2.0 (see `dist/LICENSE`). The bundled samples are edited versions of the originals: trimmed, shortened, faded, level-adjusted, and re-encoded to Ogg Vorbis. The Wurlitzer also has its sfz mapping's tuning and level fixes baked in, and the rain recordings are cut into seamless loops.
+Haku's code is Apache 2.0 (see `dist/LICENSE`). The bundled samples are edited versions of the originals: trimmed, shortened, faded, level-adjusted, and re-encoded to Ogg Vorbis. The Wurlitzer also has its sfz mapping's tuning and level fixes baked in, the kalimba and a few guitar notes are retuned to the nearest note, and the rain recordings are cut into seamless loops.
 
 | Sound | Source | Author | License |
 |---|---|---|---|
 | Upright piano | [VSCO 2 Community Edition](https://github.com/sgossner/VSCO-2-CE) | Simon Dalzell of Ivy Audio, distributed by Versilian Studios | CC0 1.0 |
 | Glockenspiel, marimba, harp | [VSCO 2 Community Edition](https://github.com/sgossner/VSCO-2-CE) | Versilian Studios | CC0 1.0 |
+| Vibraphone, kalimba | [Versilian Community Sample Library](https://github.com/sgossner/VCSL) | Versilian Studios | CC0 1.0 |
+| Nylon guitar | [Spanish classical guitar](https://freepats.zenvoid.org/Guitar/acoustic-guitar.html) from FreePats | roberto@zenvoid.org, for the FreePats project | CC0 1.0 |
 | Wurlitzer EP200 | [Greg Sullivan's E-Pianos](https://github.com/sfzinstruments/GregSullivan.E-Pianos) | [Greg Sullivan](http://www.sullivang.net/), sfz mapping by kinwie | [CC-BY 3.0](https://creativecommons.org/licenses/by/3.0/) |
 | Drums | [Big Rusty Drums](https://github.com/sfzinstruments/karoryfer.big-rusty-drums) | Karoryfer Samples | CC0 1.0 |
+| Shaker, cabasa | [Versilian Community Sample Library](https://github.com/sgossner/VCSL) | Versilian Studios | CC0 1.0 |
 | Rain on the roof | [Soft rain on roof window](https://freesound.org/people/Metadex/sounds/235827/) | Metadex | CC0 1.0 |
 | Rain on the window | [January rain on a window](https://freesound.org/people/mmorgaine/sounds/333510/) | mmorgaine | CC0 1.0 |
 

package/dist/cli.mjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { a as BridgeClient, c as bridgePort, i as GUIDE, n as TOOLS, o as BridgeHost, r as Player, t as VERSION } from "./version-DoZ2etXG.mjs";
+import { a as webRunning, c as Player, d as BridgeHost, f as SharedLink, i as webPort, l as GUIDE, n as openBrowser, o as webUrl, p as bridgePort, r as serveWeb, s as VERSION, t as TOOLS, u as BridgeClient } from "./tools-CO-tdB7d.mjs";
 import { readFile } from "node:fs/promises";
 import { resolve } from "node:path";
 import { Command, Option } from "commander";
@@ -8,10 +8,11 @@ import { z } from "zod";
 const kebab = (s) => s.replace(/_/g, "-");
 let client = null;
 const ctx = {
-	link: () => client ??= BridgeClient.connect(),
+	link: async () => await client ?? await (client = BridgeClient.connect()),
 	player: new Player(),
 	waitForPlayback: true,
-	cwd: process.env.INIT_CWD ?? process.cwd()
+	cwd: process.env.INIT_CWD ?? process.cwd(),
+	autoLaunch: !process.env.HAKU_NO_LAUNCH
 };
 function fail(message) {
 	console.error(`haku: ${message}`);
@@ -110,6 +111,39 @@ program.command("exec").argument("[commands]", "JSON file of commands (an array,
 	}
 	await runTool(batch, parsed.data);
 });
+/** How long an auto-launched `haku web` keeps running with no tab connected. */
+const IDLE_MS = 18e5;
+program.command("web").description("Open Haku in your browser. Serves the app on localhost and hosts the bridge, so agents can drive it too.").option("--no-open", "Just serve, don't open a browser").addOption(new Option("--exit-when-idle").hideHelp()).action(async (opts) => {
+	const port = webPort();
+	const url = webUrl(port);
+	let server;
+	try {
+		server = await serveWeb(port);
+	} catch (err) {
+		if (err.code !== "EADDRINUSE") fail(err instanceof Error ? err.message : String(err));
+		if (!await webRunning(port)) fail(`port ${port} is taken by something else. Set HAKU_WEB_PORT to use another one.`);
+		console.log(`Haku is already running at ${url}`);
+		if (opts.open) await openBrowser(url);
+		return;
+	}
+	const link = new SharedLink();
+	await link.ensure().catch(() => null);
+	console.log(`Haku is running at ${url}. Ctrl+C to stop.`);
+	if (opts.open && !await openBrowser(url)) console.log(`Couldn't open a browser. Open ${url} yourself.`);
+	const shutdown = () => {
+		server.close();
+		link.close().finally(() => process.exit(0));
+	};
+	process.once("SIGINT", shutdown);
+	process.once("SIGTERM", shutdown);
+	if (opts.exitWhenIdle) {
+		let lastTab = Date.now();
+		setInterval(async () => {
+			if ((await link.request({ op: "ping" }).catch(() => null))?.tab) lastTab = Date.now();
+			else if (Date.now() - lastTab > IDLE_MS) shutdown();
+		}, 6e4);
+	}
+});
 program.command("bridge").description("Run the localhost bridge on its own, so the CLI can reach the open Haku tab.").action(async () => {
 	const port = bridgePort();
 	let host;
@@ -124,7 +158,7 @@ program.command("bridge").description("Run the localhost bridge on its own, so t
 	process.once("SIGINT", () => void host.close().then(() => process.exit(0)));
 });
 program.command("mcp").description("Start the MCP server on stdio. It also hosts the bridge to the Haku tab.").action(async () => {
-	const { startMcp } = await import("./mcp-DDuNECfs.mjs");
+	const { startMcp } = await import("./mcp-DsSn95Rn.mjs");
 	await startMcp();
 });
 const argv = [...process.argv];

package/dist/{mcp-DDuNECfs.mjs → mcp-DsSn95Rn.mjs}

@@ -1,4 +1,4 @@
-import { i as GUIDE, n as TOOLS, r as Player, s as SharedLink, t as VERSION } from "./version-DoZ2etXG.mjs";
+import { c as Player, f as SharedLink, l as GUIDE, s as VERSION, t as TOOLS } from "./tools-CO-tdB7d.mjs";
 import { McpServer } from "@modelcontextprotocol/server";
 import { serveStdio } from "@modelcontextprotocol/server/stdio";
 // src/mcp.ts
@@ -17,7 +17,8 @@ async function startMcp() {
 		link: () => link.ensure().catch(() => null),
 		player,
 		waitForPlayback: false,
-		cwd: process.cwd()
+		cwd: process.cwd(),
+		autoLaunch: !process.env.HAKU_NO_LAUNCH
 	};
 	const handle = serveStdio(() => {
 		const server = new McpServer({

package/dist/samples/manifest.json

@@ -189,6 +189,149 @@
           }
         }
       ]
+    },
+    "vibes": {
+      "credit": {
+        "name": "Vibraphone, soft mallets (VCSL)",
+        "author": "Versilian Studios",
+        "license": "CC0-1.0",
+        "url": "https://github.com/sgossner/VCSL"
+      },
+      "release": 1.5,
+      "layers": [
+        {
+          "maxVelocity": 0.6,
+          "zones": {
+            "53": "vibes/v0_53.ogg",
+            "57": "vibes/v0_57.ogg",
+            "60": "vibes/v0_60.ogg",
+            "64": "vibes/v0_64.ogg",
+            "67": "vibes/v0_67.ogg",
+            "71": "vibes/v0_71.ogg",
+            "74": "vibes/v0_74.ogg",
+            "77": "vibes/v0_77.ogg",
+            "81": "vibes/v0_81.ogg",
+            "84": "vibes/v0_84.ogg",
+            "88": "vibes/v0_88.ogg"
+          }
+        },
+        {
+          "maxVelocity": 1,
+          "zones": {
+            "53": "vibes/v1_53.ogg",
+            "57": "vibes/v1_57.ogg",
+            "60": "vibes/v1_60.ogg",
+            "64": "vibes/v1_64.ogg",
+            "67": "vibes/v1_67.ogg",
+            "71": "vibes/v1_71.ogg",
+            "74": "vibes/v1_74.ogg",
+            "77": "vibes/v1_77.ogg",
+            "81": "vibes/v1_81.ogg",
+            "84": "vibes/v1_84.ogg",
+            "88": "vibes/v1_88.ogg"
+          }
+        }
+      ]
+    },
+    "guitar": {
+      "credit": {
+        "name": "Spanish classical guitar (FreePats)",
+        "author": "roberto@zenvoid.org, for the FreePats project",
+        "license": "CC0-1.0",
+        "url": "https://freepats.zenvoid.org/Guitar/acoustic-guitar.html"
+      },
+      "release": 0.8,
+      "layers": [
+        {
+          "maxVelocity": 1,
+          "zones": {
+            "31": "guitar/v0_31.ogg",
+            "32": "guitar/v0_32.ogg",
+            "33": "guitar/v0_33.ogg",
+            "34": "guitar/v0_34.ogg",
+            "35": "guitar/v0_35.ogg",
+            "36": "guitar/v0_36.ogg",
+            "37": "guitar/v0_37.ogg",
+            "38": "guitar/v0_38.ogg",
+            "39": "guitar/v0_39.ogg",
+            "40": "guitar/v0_40.ogg",
+            "41": "guitar/v0_41.ogg",
+            "43": "guitar/v0_43.ogg",
+            "45": "guitar/v0_45.ogg",
+            "47": "guitar/v0_47.ogg",
+            "48": "guitar/v0_48.ogg",
+            "50": "guitar/v0_50.ogg",
+            "52": "guitar/v0_52.ogg",
+            "53": "guitar/v0_53.ogg",
+            "54": "guitar/v0_54.ogg",
+            "55": "guitar/v0_55.ogg",
+            "56": "guitar/v0_56.ogg",
+            "57": "guitar/v0_57.ogg",
+            "58": "guitar/v0_58.ogg",
+            "59": "guitar/v0_59.ogg",
+            "60": "guitar/v0_60.ogg",
+            "61": "guitar/v0_61.ogg",
+            "62": "guitar/v0_62.ogg",
+            "63": "guitar/v0_63.ogg",
+            "64": "guitar/v0_64.ogg",
+            "65": "guitar/v0_65.ogg",
+            "66": "guitar/v0_66.ogg",
+            "67": "guitar/v0_67.ogg",
+            "69": "guitar/v0_69.ogg",
+            "70": "guitar/v0_70.ogg",
+            "71": "guitar/v0_71.ogg",
+            "72": "guitar/v0_72.ogg",
+            "73": "guitar/v0_73.ogg",
+            "74": "guitar/v0_74.ogg",
+            "75": "guitar/v0_75.ogg",
+            "76": "guitar/v0_76.ogg",
+            "77": "guitar/v0_77.ogg",
+            "78": "guitar/v0_78.ogg",
+            "79": "guitar/v0_79.ogg",
+            "80": "guitar/v0_80.ogg",
+            "81": "guitar/v0_81.ogg",
+            "82": "guitar/v0_82.ogg",
+            "83": "guitar/v0_83.ogg",
+            "84": "guitar/v0_84.ogg"
+          }
+        }
+      ]
+    },
+    "kalimba": {
+      "credit": {
+        "name": "Kalimba, Tanzania (VCSL)",
+        "author": "Versilian Studios",
+        "license": "CC0-1.0",
+        "url": "https://github.com/sgossner/VCSL"
+      },
+      "release": 1.2,
+      "layers": [
+        {
+          "maxVelocity": 1,
+          "zones": {
+            "44": "kalimba/v0_44.ogg",
+            "46": "kalimba/v0_46.ogg",
+            "49": "kalimba/v0_49.ogg",
+            "51": "kalimba/v0_51.ogg",
+            "53": "kalimba/v0_53.ogg",
+            "56": "kalimba/v0_56.ogg",
+            "59": "kalimba/v0_59.ogg",
+            "61": "kalimba/v0_61.ogg",
+            "64": "kalimba/v0_64.ogg",
+            "65": "kalimba/v0_65.ogg",
+            "67": "kalimba/v0_67.ogg",
+            "71": "kalimba/v0_71.ogg",
+            "73": "kalimba/v0_73.ogg",
+            "74": "kalimba/v0_74.ogg",
+            "75": "kalimba/v0_75.ogg",
+            "77": "kalimba/v0_77.ogg",
+            "78": "kalimba/v0_78.ogg",
+            "79": "kalimba/v0_79.ogg",
+            "82": "kalimba/v0_82.ogg",
+            "83": "kalimba/v0_83.ogg"
+          }
+        }
+      ]
     }
   },
   "drums": {
@@ -198,6 +341,12 @@
       "license": "CC0-1.0",
       "url": "https://github.com/sfzinstruments/karoryfer.big-rusty-drums"
     },
+    "percussionCredit": {
+      "name": "Shaker and cabasa (VCSL)",
+      "author": "Versilian Studios",
+      "license": "CC0-1.0",
+      "url": "https://github.com/sgossner/VCSL"
+    },
     "pieces": {
       "kick": [
         {
@@ -342,6 +491,38 @@
             "drums/tom_v1_r2.ogg"
           ]
         }
+      ],
+      "shaker": [
+        {
+          "maxVelocity": 0.6,
+          "files": [
+            "drums/shaker_v0_r1.ogg",
+            "drums/shaker_v0_r2.ogg"
+          ]
+        },
+        {
+          "maxVelocity": 1,
+          "files": [
+            "drums/shaker_v1_r1.ogg",
+            "drums/shaker_v1_r2.ogg"
+          ]
+        }
+      ],
+      "cabasa": [
+        {
+          "maxVelocity": 0.6,
+          "files": [
+            "drums/cabasa_v0_r1.ogg",
+            "drums/cabasa_v0_r2.ogg"
+          ]
+        },
+        {
+          "maxVelocity": 1,
+          "files": [
+            "drums/cabasa_v1_r1.ogg",
+            "drums/cabasa_v1_r2.ogg"
+          ]
+        }
       ]
     }
   },