wc3-mcp 0.0.0-stage → 0.5.11

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,67 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# 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

@@ -0,0 +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;
+});

package/lib/ensure-binary.js

@@ -0,0 +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 };

package/package.json

@@ -1,6 +1,41 @@
 {
   "name": "wc3-mcp",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.5.11",
+  "description": "MCP server that lets AI assistants read, audit and edit Warcraft III (.w3x and .w3m) maps byte-faithfully",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/GodMephisto/wc3-mcp.git"
+  },
+  "bin": {
+    "wc3-mcp": "./bin/wc3-mcp.js"
+  },
+  "files": [
+    "bin/",
+    "lib/",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "postinstall": "node ./bin/wc3-mcp.js --preload-binary"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "os": [
+    "win32"
+  ],
+  "cpu": [
+    "x64"
+  ],
+  "keywords": [
+    "mcp",
+    "model-context-protocol",
+    "warcraft-3",
+    "wc3",
+    "w3x",
+    "world-editor",
+    "claude",
+    "cursor"
+  ]
+}