wc3-mcp 0.5.10 → 0.5.12

package/README.md

@@ -1,67 +1,67 @@
-# wc3-mcp (npm launcher)
-
-An MCP server that lets AI assistants read, audit, and edit Warcraft III (`.w3x` and `.w3m`)
-maps byte-faithfully.
-
-This npm package is a tiny zero-dependency launcher. It downloads the matching self-contained
-`wc3-mcp.exe` and `CascLib.dll` from the GitHub Release into a per-version cache folder, then
-starts the server. Because the package version and the release version move together and the
-binary lives in a versioned folder, upgrading never hits a Windows file lock on a running
-`wc3-mcp.exe` or `CascLib.dll`.
-
-## Run it
-
-```
-npx -y wc3-mcp@latest
-```
-
-Point any MCP client at the same command to get one-click setup and an auto-update on every
-launch. For example, a client config that takes a command and args looks like this.
-
-```json
-{
-  "mcpServers": {
-    "wc3": {
-      "command": "npx",
-      "args": ["-y", "wc3-mcp@latest"]
-    }
-  }
-}
-```
-
-Then start the setup wizard once, which writes the `npx` entry into every supported client on
-this PC.
-
-```
-npx -y wc3-mcp@latest install --all
-```
-
-## Requirements
-
-Windows x64 with Node 18 or newer. Node 18 is where the built-in `fetch` the downloader uses
-arrived, so older versions are not supported.
-
-The launcher uses only Node built-in modules (fetch, crypto, fs, path, child_process). It has
-no npm dependencies.
-
-## How the download works
-
-On first launch, or on `npm install`, the launcher fetches
-`wc3-mcp-v<version>-win-x64.zip` and its `.sha256` from the GitHub Release, verifies the SHA-256
-digest, unpacks it with Windows `tar.exe` (with a PowerShell `Expand-Archive` fallback), and
-moves it into `%LOCALAPPDATA%\Programs\wc3-mcp\versions\v<version>\`. Older versions are pruned
-on a best-effort basis, and a locked folder is left alone.
-
-If the release asset for this version does not exist yet, the launcher prints a message to
-stderr and exits non-zero. It never writes download status to stdout, because the MCP stdio
-transport uses stdout for the protocol.
-
-## Commands
-
-- `wc3-mcp` starts the MCP server over stdio.
-- `wc3-mcp version` prints the package version from `package.json`, with no download.
-- `wc3-mcp install --all` (and the other setup verbs) are handled by the .NET server itself.
-
-## License
-
-Apache-2.0. See `LICENSE`.
+# wc3-mcp (npm launcher)
+
+An MCP server that lets AI assistants read, audit, and edit Warcraft III (`.w3x` and `.w3m`)
+maps byte-faithfully.
+
+This npm package is a tiny zero-dependency launcher. It downloads the matching self-contained
+`wc3-mcp.exe` and `CascLib.dll` from the GitHub Release into a per-version cache folder, then
+starts the server. Because the package version and the release version move together and the
+binary lives in a versioned folder, upgrading never hits a Windows file lock on a running
+`wc3-mcp.exe` or `CascLib.dll`.
+
+## Run it
+
+```
+npx -y wc3-mcp@latest
+```
+
+Point any MCP client at the same command to get one-click setup and an auto-update on every
+launch. For example, a client config that takes a command and args looks like this.
+
+```json
+{
+  "mcpServers": {
+    "wc3": {
+      "command": "npx",
+      "args": ["-y", "wc3-mcp@latest"]
+    }
+  }
+}
+```
+
+Then start the setup wizard once, which writes the `npx` entry into every supported client on
+this PC.
+
+```
+npx -y wc3-mcp@latest install --all
+```
+
+## Requirements
+
+Windows x64 with Node 18 or newer. Node 18 is where the built-in `fetch` the downloader uses
+arrived, so older versions are not supported.
+
+The launcher uses only Node built-in modules (fetch, crypto, fs, path, child_process). It has
+no npm dependencies.
+
+## How the download works
+
+On first launch, or on `npm install`, the launcher fetches
+`wc3-mcp-v<version>-win-x64.zip` and its `.sha256` from the GitHub Release, verifies the SHA-256
+digest, unpacks it with Windows `tar.exe` (with a PowerShell `Expand-Archive` fallback), and
+moves it into `%LOCALAPPDATA%\Programs\wc3-mcp\versions\v<version>\`. Older versions are pruned
+on a best-effort basis, and a locked folder is left alone.
+
+If the release asset for this version does not exist yet, the launcher prints a message to
+stderr and exits non-zero. It never writes download status to stdout, because the MCP stdio
+transport uses stdout for the protocol.
+
+## Commands
+
+- `wc3-mcp` starts the MCP server over stdio.
+- `wc3-mcp version` prints the package version from `package.json`, with no download.
+- `wc3-mcp install --all` (and the other setup verbs) are handled by the .NET server itself.
+
+## License
+
+Apache-2.0. See `LICENSE`.

package/bin/wc3-mcp.js

@@ -1,76 +1,76 @@
-#!/usr/bin/env node
-'use strict';
-
-// Entry point for the wc3-mcp npm package. It makes sure the matching .NET binary is
-// present in the per-version cache and then hands the process over to it.
-//
-// `wc3-mcp version` answers from package.json alone, with no download, so installs and
-// release tooling can read the version offline.
-//
-// MCP stdio transport owns stdout. All launcher status goes to stderr.
-
-const { spawn } = require('child_process');
-const pkg = require('../package.json');
-const { ensureBinary } = require('../lib/ensure-binary');
-
-function writeVersion() {
-  process.stdout.write(`${pkg.version}\n`);
-}
-
-async function main() {
-  const args = process.argv.slice(2);
-  const first = args[0];
-
-  if (first === 'version' || first === '--version') {
-    writeVersion();
-    return 0;
-  }
-
-  if (first === '--preload-binary') {
-    // Called by the npm postinstall step. Never fail the install on a network error,
-    // because a restricted build environment has no business blocking the package.
-    try {
-      await ensureBinary();
-    } catch (error) {
-      process.stderr.write(`[wc3-mcp] binary preload skipped, ${error.message}\n`);
-    }
-    return 0;
-  }
-
-  let exe;
-  try {
-    exe = await ensureBinary();
-  } catch (error) {
-    process.stderr.write(`[wc3-mcp] could not prepare the wc3-mcp binary, ${error.message}\n`);
-    process.stderr.write(`[wc3-mcp] install v${pkg.version} from https://github.com/GodMephisto/wc3-mcp/releases\n`);
-    return 1;
-  }
-
-  // Tells the server it was started through npx, so its own setup can register the
-  // auto-updating npx command in each AI client.
-  process.env.WC3_MCP_NPX = '1';
-
-  const child = spawn(exe, args, { stdio: 'inherit', windowsHide: true });
-
-  child.on('error', (error) => {
-    process.stderr.write(`[wc3-mcp] failed to start ${exe}, ${error.message}\n`);
-    process.exitCode = 1;
-  });
-
-  child.on('exit', (code, signal) => {
-    if (signal) {
-      process.kill(process.pid, signal);
-      return;
-    }
-    process.exitCode = code === null ? 1 : code;
-  });
-}
-
-// process.exitCode rather than process.exit, so pending sockets close cleanly. Calling
-// process.exit() right after a failed fetch trips a libuv handle assertion on Windows.
-main().then((code) => {
-  if (typeof code === 'number') process.exitCode = code;
-}).catch((error) => {
-  process.stderr.write(`[wc3-mcp] unexpected failure, ${error && error.message ? error.message : error}\n`);
-  process.exitCode = 1;
-});
+#!/usr/bin/env node
+'use strict';
+
+// Entry point for the wc3-mcp npm package. It makes sure the matching .NET binary is
+// present in the per-version cache and then hands the process over to it.
+//
+// `wc3-mcp version` answers from package.json alone, with no download, so installs and
+// release tooling can read the version offline.
+//
+// MCP stdio transport owns stdout. All launcher status goes to stderr.
+
+const { spawn } = require('child_process');
+const pkg = require('../package.json');
+const { ensureBinary } = require('../lib/ensure-binary');
+
+function writeVersion() {
+  process.stdout.write(`${pkg.version}\n`);
+}
+
+async function main() {
+  const args = process.argv.slice(2);
+  const first = args[0];
+
+  if (first === 'version' || first === '--version') {
+    writeVersion();
+    return 0;
+  }
+
+  if (first === '--preload-binary') {
+    // Called by the npm postinstall step. Never fail the install on a network error,
+    // because a restricted build environment has no business blocking the package.
+    try {
+      await ensureBinary();
+    } catch (error) {
+      process.stderr.write(`[wc3-mcp] binary preload skipped, ${error.message}\n`);
+    }
+    return 0;
+  }
+
+  let exe;
+  try {
+    exe = await ensureBinary();
+  } catch (error) {
+    process.stderr.write(`[wc3-mcp] could not prepare the wc3-mcp binary, ${error.message}\n`);
+    process.stderr.write(`[wc3-mcp] install v${pkg.version} from https://github.com/GodMephisto/wc3-mcp/releases\n`);
+    return 1;
+  }
+
+  // Tells the server it was started through npx, so its own setup can register the
+  // auto-updating npx command in each AI client.
+  process.env.WC3_MCP_NPX = '1';
+
+  const child = spawn(exe, args, { stdio: 'inherit', windowsHide: true });
+
+  child.on('error', (error) => {
+    process.stderr.write(`[wc3-mcp] failed to start ${exe}, ${error.message}\n`);
+    process.exitCode = 1;
+  });
+
+  child.on('exit', (code, signal) => {
+    if (signal) {
+      process.kill(process.pid, signal);
+      return;
+    }
+    process.exitCode = code === null ? 1 : code;
+  });
+}
+
+// process.exitCode rather than process.exit, so pending sockets close cleanly. Calling
+// process.exit() right after a failed fetch trips a libuv handle assertion on Windows.
+main().then((code) => {
+  if (typeof code === 'number') process.exitCode = code;
+}).catch((error) => {
+  process.stderr.write(`[wc3-mcp] unexpected failure, ${error && error.message ? error.message : error}\n`);
+  process.exitCode = 1;
+});

package/lib/ensure-binary.js

@@ -1,182 +1,182 @@
-'use strict';
-
-// Downloads and verifies the matching wc3-mcp.exe and CascLib.dll from a GitHub Release
-// into a per-version cache folder. Per-version folders are the reason an upgrade never
-// hits a Windows file lock on a running wc3-mcp.exe or CascLib.dll.
-//
-// Every status message goes to stderr. MCP stdio transport owns stdout, so nothing here
-// may write to stdout.
-
-const fs = require('fs');
-const os = require('os');
-const path = require('path');
-const crypto = require('crypto');
-const { execFileSync } = require('child_process');
-
-const pkg = require('../package.json');
-
-const REPO = 'GodMephisto/wc3-mcp';
-const EXE_NAME = 'wc3-mcp.exe';
-const CASC_NAME = 'CascLib.dll';
-
-function log(message) {
-  process.stderr.write(`[wc3-mcp] ${message}\n`);
-}
-
-function cacheRoot() {
-  const local = process.env.LOCALAPPDATA || path.join(os.homedir(), 'AppData', 'Local');
-  return path.join(local, 'Programs', 'wc3-mcp', 'versions');
-}
-
-function versionDir(version) {
-  return path.join(cacheRoot(), `v${version}`);
-}
-
-function pathsFor(version) {
-  const dir = versionDir(version);
-  return { dir, exe: path.join(dir, EXE_NAME), casc: path.join(dir, CASC_NAME) };
-}
-
-function isReady(version) {
-  const { exe, casc } = pathsFor(version);
-  return fs.existsSync(exe) && fs.existsSync(casc);
-}
-
-async function download(url) {
-  const response = await fetch(url, { redirect: 'follow' });
-  if (!response.ok) {
-    throw new Error(`download failed with ${response.status} ${response.statusText} for ${url}`);
-  }
-  return Buffer.from(await response.arrayBuffer());
-}
-
-function sha256(buffer) {
-  return crypto.createHash('sha256').update(buffer).digest('hex');
-}
-
-function extract(zipPath, destDir) {
-  fs.mkdirSync(destDir, { recursive: true });
-  try {
-    // tar.exe ships with Windows 10 and 11 and reads zip archives directly.
-    execFileSync('tar.exe', ['-xf', zipPath, '-C', destDir], { stdio: 'ignore' });
-    return;
-  } catch (error) {
-    log(`tar.exe could not unpack the archive (${error.message}), falling back to PowerShell`);
-  }
-  const quotedZip = zipPath.replace(/'/g, "''");
-  const quotedDest = destDir.replace(/'/g, "''");
-  execFileSync('powershell.exe', [
-    '-NoProfile',
-    '-NonInteractive',
-    '-Command',
-    `Expand-Archive -LiteralPath '${quotedZip}' -DestinationPath '${quotedDest}' -Force`,
-  ], { stdio: 'ignore' });
-}
-
-function locateDeployDir(stageDir) {
-  if (fs.existsSync(path.join(stageDir, EXE_NAME))) return stageDir;
-  // Some archives wrap the payload in a single top level folder.
-  for (const entry of fs.readdirSync(stageDir, { withFileTypes: true })) {
-    if (entry.isDirectory() && fs.existsSync(path.join(stageDir, entry.name, EXE_NAME))) {
-      return path.join(stageDir, entry.name);
-    }
-  }
-  return stageDir;
-}
-
-function pruneOldVersions(currentVersion) {
-  const root = cacheRoot();
-  let entries;
-  try {
-    entries = fs.readdirSync(root, { withFileTypes: true });
-  } catch {
-    return;
-  }
-  const dirs = entries
-    .filter((entry) => entry.isDirectory() && /^v\d/.test(entry.name))
-    .map((entry) => {
-      const full = path.join(root, entry.name);
-      let mtime = 0;
-      try { mtime = fs.statSync(full).mtimeMs; } catch { /* keep 0 */ }
-      return { name: entry.name, full, mtime };
-    })
-    .sort((a, b) => b.mtime - a.mtime);
-
-  const keep = new Set([`v${currentVersion}`]);
-  for (const item of dirs) {
-    if (keep.size >= 2) break;
-    keep.add(item.name);
-  }
-
-  for (const item of dirs) {
-    if (keep.has(item.name)) continue;
-    try {
-      fs.rmSync(item.full, { recursive: true, force: true });
-      log(`removed old version ${item.name}`);
-    } catch (error) {
-      // A running client can hold the exe. EBUSY and EPERM are expected and safe to ignore.
-      if (error.code !== 'EBUSY' && error.code !== 'EPERM') {
-        log(`could not remove old version ${item.name}, ${error.message}`);
-      }
-    }
-  }
-}
-
-async function ensureBinary(options = {}) {
-  const version = options.version || pkg.version;
-  const { exe, casc } = pathsFor(version);
-
-  if (isReady(version)) {
-    return exe;
-  }
-
-  const root = cacheRoot();
-  fs.mkdirSync(root, { recursive: true });
-
-  const base = `https://github.com/${REPO}/releases/download/v${version}/wc3-mcp-v${version}-win-x64.zip`;
-  log(`wc3-mcp ${version} is not cached, downloading ${base}`);
-
-  const zipBuffer = await download(base);
-  const shaBuffer = await download(`${base}.sha256`);
-
-  const expected = shaBuffer.toString('utf8').trim().split(/\s+/)[0].toLowerCase();
-  const actual = sha256(zipBuffer);
-  if (expected !== actual) {
-    throw new Error(`checksum mismatch for wc3-mcp ${version}, expected ${expected}, got ${actual}`);
-  }
-
-  const zipPath = path.join(root, `.wc3-mcp-${version}-${process.pid}-${Date.now()}.zip`);
-  fs.writeFileSync(zipPath, zipBuffer);
-
-  const stageDir = path.join(root, `.stage-${process.pid}-${Date.now()}`);
-  const targetDir = versionDir(version);
-  try {
-    extract(zipPath, stageDir);
-    const deployDir = locateDeployDir(stageDir);
-    if (!fs.existsSync(path.join(deployDir, EXE_NAME)) || !fs.existsSync(path.join(deployDir, CASC_NAME))) {
-      throw new Error(`the archive for wc3-mcp ${version} did not contain ${EXE_NAME} and ${CASC_NAME}`);
-    }
-    try {
-      fs.renameSync(deployDir, targetDir);
-    } catch (renameError) {
-      if (renameError.code !== 'EEXIST' && renameError.code !== 'EPERM' && renameError.code !== 'ENOTEMPTY') {
-        throw renameError;
-      }
-      // Another process finished the same install first, or a locked folder sits there.
-      fs.cpSync(deployDir, targetDir, { recursive: true, force: true });
-    }
-  } finally {
-    try { fs.rmSync(stageDir, { recursive: true, force: true }); } catch { /* best effort */ }
-    try { fs.rmSync(zipPath, { force: true }); } catch { /* best effort */ }
-  }
-
-  if (!isReady(version)) {
-    throw new Error(`wc3-mcp ${version} did not install correctly into ${targetDir}`);
-  }
-
-  log(`installed wc3-mcp ${version} into ${targetDir}`);
-  pruneOldVersions(version);
-  return exe;
-}
-
-module.exports = { ensureBinary, cacheRoot, versionDir };
+'use strict';
+
+// Downloads and verifies the matching wc3-mcp.exe and CascLib.dll from a GitHub Release
+// into a per-version cache folder. Per-version folders are the reason an upgrade never
+// hits a Windows file lock on a running wc3-mcp.exe or CascLib.dll.
+//
+// Every status message goes to stderr. MCP stdio transport owns stdout, so nothing here
+// may write to stdout.
+
+const fs = require('fs');
+const os = require('os');
+const path = require('path');
+const crypto = require('crypto');
+const { execFileSync } = require('child_process');
+
+const pkg = require('../package.json');
+
+const REPO = 'GodMephisto/wc3-mcp';
+const EXE_NAME = 'wc3-mcp.exe';
+const CASC_NAME = 'CascLib.dll';
+
+function log(message) {
+  process.stderr.write(`[wc3-mcp] ${message}\n`);
+}
+
+function cacheRoot() {
+  const local = process.env.LOCALAPPDATA || path.join(os.homedir(), 'AppData', 'Local');
+  return path.join(local, 'Programs', 'wc3-mcp', 'versions');
+}
+
+function versionDir(version) {
+  return path.join(cacheRoot(), `v${version}`);
+}
+
+function pathsFor(version) {
+  const dir = versionDir(version);
+  return { dir, exe: path.join(dir, EXE_NAME), casc: path.join(dir, CASC_NAME) };
+}
+
+function isReady(version) {
+  const { exe, casc } = pathsFor(version);
+  return fs.existsSync(exe) && fs.existsSync(casc);
+}
+
+async function download(url) {
+  const response = await fetch(url, { redirect: 'follow' });
+  if (!response.ok) {
+    throw new Error(`download failed with ${response.status} ${response.statusText} for ${url}`);
+  }
+  return Buffer.from(await response.arrayBuffer());
+}
+
+function sha256(buffer) {
+  return crypto.createHash('sha256').update(buffer).digest('hex');
+}
+
+function extract(zipPath, destDir) {
+  fs.mkdirSync(destDir, { recursive: true });
+  try {
+    // tar.exe ships with Windows 10 and 11 and reads zip archives directly.
+    execFileSync('tar.exe', ['-xf', zipPath, '-C', destDir], { stdio: 'ignore' });
+    return;
+  } catch (error) {
+    log(`tar.exe could not unpack the archive (${error.message}), falling back to PowerShell`);
+  }
+  const quotedZip = zipPath.replace(/'/g, "''");
+  const quotedDest = destDir.replace(/'/g, "''");
+  execFileSync('powershell.exe', [
+    '-NoProfile',
+    '-NonInteractive',
+    '-Command',
+    `Expand-Archive -LiteralPath '${quotedZip}' -DestinationPath '${quotedDest}' -Force`,
+  ], { stdio: 'ignore' });
+}
+
+function locateDeployDir(stageDir) {
+  if (fs.existsSync(path.join(stageDir, EXE_NAME))) return stageDir;
+  // Some archives wrap the payload in a single top level folder.
+  for (const entry of fs.readdirSync(stageDir, { withFileTypes: true })) {
+    if (entry.isDirectory() && fs.existsSync(path.join(stageDir, entry.name, EXE_NAME))) {
+      return path.join(stageDir, entry.name);
+    }
+  }
+  return stageDir;
+}
+
+function pruneOldVersions(currentVersion) {
+  const root = cacheRoot();
+  let entries;
+  try {
+    entries = fs.readdirSync(root, { withFileTypes: true });
+  } catch {
+    return;
+  }
+  const dirs = entries
+    .filter((entry) => entry.isDirectory() && /^v\d/.test(entry.name))
+    .map((entry) => {
+      const full = path.join(root, entry.name);
+      let mtime = 0;
+      try { mtime = fs.statSync(full).mtimeMs; } catch { /* keep 0 */ }
+      return { name: entry.name, full, mtime };
+    })
+    .sort((a, b) => b.mtime - a.mtime);
+
+  const keep = new Set([`v${currentVersion}`]);
+  for (const item of dirs) {
+    if (keep.size >= 2) break;
+    keep.add(item.name);
+  }
+
+  for (const item of dirs) {
+    if (keep.has(item.name)) continue;
+    try {
+      fs.rmSync(item.full, { recursive: true, force: true });
+      log(`removed old version ${item.name}`);
+    } catch (error) {
+      // A running client can hold the exe. EBUSY and EPERM are expected and safe to ignore.
+      if (error.code !== 'EBUSY' && error.code !== 'EPERM') {
+        log(`could not remove old version ${item.name}, ${error.message}`);
+      }
+    }
+  }
+}
+
+async function ensureBinary(options = {}) {
+  const version = options.version || pkg.version;
+  const { exe, casc } = pathsFor(version);
+
+  if (isReady(version)) {
+    return exe;
+  }
+
+  const root = cacheRoot();
+  fs.mkdirSync(root, { recursive: true });
+
+  const base = `https://github.com/${REPO}/releases/download/v${version}/wc3-mcp-v${version}-win-x64.zip`;
+  log(`wc3-mcp ${version} is not cached, downloading ${base}`);
+
+  const zipBuffer = await download(base);
+  const shaBuffer = await download(`${base}.sha256`);
+
+  const expected = shaBuffer.toString('utf8').trim().split(/\s+/)[0].toLowerCase();
+  const actual = sha256(zipBuffer);
+  if (expected !== actual) {
+    throw new Error(`checksum mismatch for wc3-mcp ${version}, expected ${expected}, got ${actual}`);
+  }
+
+  const zipPath = path.join(root, `.wc3-mcp-${version}-${process.pid}-${Date.now()}.zip`);
+  fs.writeFileSync(zipPath, zipBuffer);
+
+  const stageDir = path.join(root, `.stage-${process.pid}-${Date.now()}`);
+  const targetDir = versionDir(version);
+  try {
+    extract(zipPath, stageDir);
+    const deployDir = locateDeployDir(stageDir);
+    if (!fs.existsSync(path.join(deployDir, EXE_NAME)) || !fs.existsSync(path.join(deployDir, CASC_NAME))) {
+      throw new Error(`the archive for wc3-mcp ${version} did not contain ${EXE_NAME} and ${CASC_NAME}`);
+    }
+    try {
+      fs.renameSync(deployDir, targetDir);
+    } catch (renameError) {
+      if (renameError.code !== 'EEXIST' && renameError.code !== 'EPERM' && renameError.code !== 'ENOTEMPTY') {
+        throw renameError;
+      }
+      // Another process finished the same install first, or a locked folder sits there.
+      fs.cpSync(deployDir, targetDir, { recursive: true, force: true });
+    }
+  } finally {
+    try { fs.rmSync(stageDir, { recursive: true, force: true }); } catch { /* best effort */ }
+    try { fs.rmSync(zipPath, { force: true }); } catch { /* best effort */ }
+  }
+
+  if (!isReady(version)) {
+    throw new Error(`wc3-mcp ${version} did not install correctly into ${targetDir}`);
+  }
+
+  log(`installed wc3-mcp ${version} into ${targetDir}`);
+  pruneOldVersions(version);
+  return exe;
+}
+
+module.exports = { ensureBinary, cacheRoot, versionDir };

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "wc3-mcp",
-  "version": "0.5.10",
+  "mcpName": "io.github.GodMephisto/wc3-mcp",
+  "version": "0.5.12",
   "description": "MCP server that lets AI assistants read, audit and edit Warcraft III (.w3x and .w3m) maps byte-faithfully",
   "license": "Apache-2.0",
   "repository": {