@pkmn/engine 0.1.0-dev.84cc1a02 → 0.1.0-dev.942dbfa4

package/build.zig

@@ -1,13 +1,13 @@
 const std = @import("std");
 const builtin = @import("builtin");
 
-pub const Options = struct { showdown: ?bool = null, trace: ?bool = null };
+pub const Options = struct { showdown: ?bool = null, log: ?bool = null };
 
 pub fn module(b: *std.Build, options: Options) *std.Build.Module {
     const dirname = comptime std.fs.path.dirname(@src().file) orelse ".";
     const build_options = b.addOptions();
     build_options.addOption(?bool, "showdown", options.showdown);
-    build_options.addOption(?bool, "trace", options.trace);
+    build_options.addOption(?bool, "log", options.log);
     return b.createModule(.{
         .source_file = .{ .path = dirname ++ "/src/lib/pkmn.zig" },
         .dependencies = &.{.{ .name = "build_options", .module = build_options.createModule() }},
@@ -27,25 +27,25 @@ pub fn build(b: *std.Build) !void {
     const dynamic = b.option(bool, "dynamic", "Build a dynamic library") orelse false;
     const strip = b.option(bool, "strip", "Strip debugging symbols from binary") orelse false;
     const pic = b.option(bool, "pic", "Force position independent code") orelse false;
+    const emit_asm = b.option(bool, "emit-asm", "Output .s (assembly code)") orelse false;
 
-    const cmd = b.findProgram(&[_][]const u8{"strip"}, &[_][]const u8{}) catch null;
+    const cmd = b.findProgram(&.{"strip"}, &.{}) catch null;
 
-    var parser = std.json.Parser.init(b.allocator, false);
-    defer parser.deinit();
-    var tree = try parser.parse(@embedFile("package.json"));
-    defer tree.deinit();
-    const version = tree.root.Object.get("version").?.String;
-    const description = tree.root.Object.get("description").?.String;
-    var repository = std.mem.split(u8, tree.root.Object.get("repository").?.String, ":");
+    const json = @embedFile("package.json");
+    var parsed = try std.json.parseFromSlice(std.json.Value, b.allocator, json, .{});
+    defer parsed.deinit();
+    const version = parsed.value.object.get("version").?.string;
+    const description = parsed.value.object.get("description").?.string;
+    var repository = std.mem.split(u8, parsed.value.object.get("repository").?.string, ":");
     std.debug.assert(std.mem.eql(u8, repository.first(), "github"));
 
     const showdown =
         b.option(bool, "showdown", "Enable Pokémon Showdown compatibility mode") orelse false;
-    const trace = b.option(bool, "trace", "Enable trace logs") orelse false;
+    const log = b.option(bool, "log", "Enable protocol message logging") orelse false;
 
     const options = b.addOptions();
     options.addOption(?bool, "showdown", showdown);
-    options.addOption(?bool, "trace", trace);
+    options.addOption(?bool, "log", log);
 
     const name = if (showdown) "pkmn-showdown" else "pkmn";
 
@@ -72,14 +72,14 @@ pub fn build(b: *std.Build) !void {
         maybeStrip(b, lib, b.getInstallStep(), strip, cmd);
         if (pic) lib.force_pic = pic;
         // Always emit to build/lib because this is where the driver code expects to find it
-        // TODO(ziglang/zig#2231): using the following used to work (though be hacky):
+        // TODO(ziglang/zig#2231): using the following used to work (though was hacky):
         //
         //    lib.emit_bin = .{ .emit_to = b.fmt("build/lib/{s}", .{addon}) };
         //    b.getInstallStep().dependOn(&lib.step);
         //
         // But ziglang/zig#14647 broke this so we now need to do an install() and then manually
         // rename the file ourself in install-pkmn-engine
-        lib.install();
+        b.installArtifact(lib);
     } else if (wasm) {
         const lib = b.addSharedLibrary(.{
             .name = name,
@@ -96,24 +96,21 @@ pub fn build(b: *std.Build) !void {
         lib.rdynamic = true;
         lib.strip = strip;
         if (pic) lib.force_pic = pic;
-        const opt = b.findProgram(
-            &[_][]const u8{"wasm-opt"},
-            &[_][]const u8{"./node_modules/.bin"},
-        ) catch null;
+        const opt = b.findProgram(&.{"wasm-opt"}, &.{"./node_modules/.bin"}) catch null;
         if (optimize != .Debug and opt != null) {
             const out = b.fmt("build/lib/{s}.wasm", .{name});
-            const sh = b.addSystemCommand(&[_][]const u8{ opt.?, "-O4" });
+            const sh = b.addSystemCommand(&.{ opt.?, "-O4" });
             sh.addArtifactArg(lib);
             sh.addArg("-o");
             sh.addFileSourceArg(.{ .path = out });
             b.getInstallStep().dependOn(&sh.step);
         }
-        lib.install();
+        b.installArtifact(lib);
     } else if (dynamic) {
         const lib = b.addSharedLibrary(.{
             .name = name,
             .root_source_file = .{ .path = "src/lib/binding/c.zig" },
-            .version = try std.builtin.Version.parse(version),
+            .version = try std.SemanticVersion.parse(version),
             .optimize = optimize,
             .target = target,
         });
@@ -122,7 +119,7 @@ pub fn build(b: *std.Build) !void {
         lib.addIncludePath("src/include");
         maybeStrip(b, lib, b.getInstallStep(), strip, cmd);
         if (pic) lib.force_pic = pic;
-        lib.install();
+        b.installArtifact(lib);
         c = true;
     } else {
         const lib = b.addStaticLibrary(.{
@@ -137,7 +134,8 @@ pub fn build(b: *std.Build) !void {
         lib.bundle_compiler_rt = true;
         maybeStrip(b, lib, b.getInstallStep(), strip, cmd);
         if (pic) lib.force_pic = pic;
-        lib.install();
+        if (emit_asm) lib.emit_asm = .emit;
+        b.installArtifact(lib);
         c = true;
     }
 
@@ -186,7 +184,7 @@ pub fn build(b: *std.Build) !void {
         .general = config,
         .tool = .{
             .showdown = showdown,
-            .trace = trace,
+            .log = log,
             .tests = if (tests.build) tests else null,
             .exes = &exes,
         },
@@ -208,7 +206,7 @@ pub fn build(b: *std.Build) !void {
     const lint_exe =
         b.addExecutable(.{ .name = "lint", .root_source_file = .{ .path = "src/tools/lint.zig" } });
     if (tests.build) tests.step.dependOn(&lint_exe.step);
-    const lint = lint_exe.run();
+    const lint = b.addRunArtifact(lint_exe);
 
     b.step("benchmark", "Run benchmark code").dependOn(&benchmark.step);
     b.step("fuzz", "Run fuzz tester").dependOn(&fuzz.step);
@@ -233,7 +231,7 @@ fn maybeStrip(
     if (mac and artifact.isDynamicLibrary()) return;
     // Assuming GNU strip, which complains "illegal pathname found in archive member"...
     if (!mac and artifact.isStaticLibrary()) return;
-    const sh = b.addSystemCommand(&[_][]const u8{ cmd.?, if (mac) "-x" else "-s" });
+    const sh = b.addSystemCommand(&.{ cmd.?, if (mac) "-x" else "-s" });
     sh.addArtifactArg(artifact);
     step.dependOn(&sh.step);
 }
@@ -246,7 +244,7 @@ const Config = struct {
     cmd: ?[]const u8,
 };
 
-const TESTS = [_][]const u8{
+const TESTS = .{
     "src/lib/common/test.zig",
     "src/lib/gen1/test.zig",
     "src/lib/gen2/test.zig",
@@ -259,11 +257,8 @@ const TestStep = struct {
     pub fn create(b: *std.Build, options: *std.Build.OptionsStep, config: Config) *TestStep {
         const coverage = b.option([]const u8, "test-coverage", "Generate test coverage");
         const test_file = b.option([]const u8, "test-file", "Input file for test");
-        const test_bin = b.option([]const u8, "test-bin", "Emit test binary to");
         const test_filter =
             b.option([]const u8, "test-filter", "Skip tests that do not match filter");
-        const test_no_exec =
-            b.option(bool, "test-no-exec", "Compiles test binary without running it") orelse false;
 
         const self = b.allocator.create(TestStep) catch @panic("OOM");
         const step = std.Build.Step.init(.{ .id = .custom, .name = "Run all tests", .owner = b });
@@ -277,21 +272,17 @@ const TestStep = struct {
                 .root_source_file = .{ .path = path },
                 .optimize = config.optimize,
                 .target = config.target,
+                .filter = test_filter,
             });
             tests.setMainPkgPath("./");
-            tests.setFilter(test_filter);
             tests.addOptions("build_options", options);
             tests.single_threaded = true;
             maybeStrip(b, tests, &tests.step, config.strip, config.cmd);
             if (config.pic) tests.force_pic = config.pic;
-            if (test_bin) |bin| {
-                tests.name = std.fs.path.basename(bin);
-                if (std.fs.path.dirname(bin)) |dir| tests.setOutputDir(dir);
-            }
             if (coverage) |c| {
                 tests.setExecCmd(&.{ "kcov", "--include-pattern=src/lib", c, null });
             }
-            self.step.dependOn(if (test_no_exec) &tests.step else &tests.run().step);
+            self.step.dependOn(&b.addRunArtifact(tests).step);
         }
         return self;
     }
@@ -301,7 +292,7 @@ const ToolConfig = struct {
     general: Config,
     tool: struct {
         showdown: bool,
-        trace: bool,
+        log: bool,
         tests: ?*TestStep,
         name: ?[]const u8 = null,
         exes: *std.ArrayList(*std.Build.CompileStep),
@@ -322,14 +313,14 @@ fn tool(b: *std.Build, path: []const u8, config: ToolConfig) *std.Build.RunStep
     });
     exe.addModule("pkmn", module(b, .{
         .showdown = config.tool.showdown,
-        .trace = config.tool.trace,
+        .log = config.tool.log,
     }));
     exe.single_threaded = true;
     if (config.general.pic) exe.force_pic = config.general.pic;
     if (config.tool.tests) |ts| ts.step.dependOn(&exe.step);
     config.tool.exes.append(exe) catch @panic("OOM");
 
-    const run = exe.run();
+    const run = b.addRunArtifact(exe);
     maybeStrip(b, exe, &run.step, config.general.strip, config.general.cmd);
     if (b.args) |args| run.addArgs(args);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pkmn/engine",
-  "version": "0.1.0-dev.84cc1a02",
+  "version": "0.1.0-dev.942dbfa4",
   "description": "A minimal, complete, Pokémon battle simulation engine optimized for performance",
   "repository": "github:pkmn/engine",
   "license": "MIT",
@@ -9,6 +9,28 @@
   "types": "build/pkg/index.d.ts",
   "files": [
     "build.zig",
+    "build/pkg/data.d.ts",
+    "build/pkg/data.js.map",
+    "build/pkg/addon.d.ts",
+    "build/pkg/addon.js.map",
+    "build/pkg/addon.js",
+    "build/pkg/data.js",
+    "build/pkg/data/ids.json",
+    "build/pkg/data/layout.json",
+    "build/pkg/data/protocol.json",
+    "build/pkg/gen1.d.ts",
+    "build/pkg/gen1.js.map",
+    "build/pkg/gen1.js",
+    "build/pkg/index.d.ts",
+    "build/pkg/index.js.map",
+    "build/pkg/index.js",
+    "build/pkg/protocol.d.ts",
+    "build/pkg/protocol.js.map",
+    "build/pkg/protocol.js",
+    "build/test/display.js.map",
+    "build/test/display.js",
+    "build/tools/debug.js.map",
+    "build/tools/debug.js",
     "src/bin/install-pkmn-engine",
     "src/lib/binding/node.zig",
     "src/lib/binding/wasm.zig",
@@ -17,78 +39,66 @@
     "src/lib/common/options.zig",
     "src/lib/common/protocol.zig",
     "src/lib/common/rng.zig",
+    "src/lib/gen1/data.zig",
     "src/lib/gen1/data/moves.zig",
     "src/lib/gen1/data/species.zig",
     "src/lib/gen1/data/types.zig",
-    "src/lib/gen1/data.zig",
     "src/lib/gen1/helpers.zig",
     "src/lib/gen1/mechanics.zig",
+    "src/lib/gen2/data.zig",
     "src/lib/gen2/data/items.zig",
     "src/lib/gen2/data/moves.zig",
     "src/lib/gen2/data/species.zig",
     "src/lib/gen2/data/types.zig",
-    "src/lib/gen2/data.zig",
     "src/lib/gen2/helpers.zig",
     "src/lib/gen2/mechanics.zig",
     "src/lib/pkmn.zig",
-    "build/pkg/data/ids.json",
-    "build/pkg/data/layout.json",
-    "build/pkg/data/protocol.json",
-    "build/pkg/data.d.ts",
-    "build/pkg/data.js",
-    "build/pkg/data.js.map",
-    "build/pkg/gen1.d.ts",
-    "build/pkg/gen1.js",
-    "build/pkg/gen1.js.map",
-    "build/pkg/index.d.ts",
-    "build/pkg/index.js",
-    "build/pkg/index.js.map",
-    "build/pkg/protocol.d.ts",
-    "build/pkg/protocol.js",
-    "build/pkg/protocol.js.map"
+    "src/test/display/pkmn.html.tmpl"
   ],
   "engines": {
     "node": ">=16.0.0"
   },
   "bin": {
-    "install-pkmn-engine": "src/bin/install-pkmn-engine"
+    "install-pkmn-engine": "src/bin/install-pkmn-engine",
+    "pkmn-debug": "src/bin/pkmn-debug"
   },
   "publishConfig": {
     "access": "public"
   },
   "dependencies": {
-    "@pkmn/data": "^0.7.35",
-    "@pkmn/protocol": "^0.6.11"
+    "@pkmn/data": "^0.7.43",
+    "@pkmn/protocol": "^0.6.12"
   },
   "devDependencies": {
-    "@pkmn/eslint-config": "^3.0.0",
-    "@pkmn/img": "^0.2.8",
+    "@pkmn/eslint-config": "^3.2.0",
+    "@pkmn/img": "^0.2.11",
     "@pkmn/sets": "^5.0.4",
-    "@pkmn/sim": "0.7.35",
+    "@pkmn/sim": "0.7.43",
     "@types/html-minifier": "^4.0.2",
-    "@types/jest": "^29.5.0",
+    "@types/jest": "^29.5.2",
     "@types/minimist": "^1.2.2",
     "@types/mustache": "^4.2.2",
-    "@types/node": "^18.15.11",
-    "@vitest/coverage-c8": "^0.29.8",
-    "binaryen": "^112.0.0",
-    "eslint": "^8.37.0",
+    "@types/node": "^20.3.1",
+    "@vitest/coverage-c8": "^0.32.2",
+    "binaryen": "^113.0.0",
+    "eslint": "^8.43.0",
     "html-minifier": "^4.0.0",
     "json-stringify-pretty-compact": "3.0.0",
     "minimist": "^1.2.8",
     "mustache": "^4.2.0",
     "source-map-support": "^0.5.21",
     "trakr": "^0.2.0",
-    "typescript": "^5.0.3",
-    "vitest": "^0.29.8"
+    "typescript": "^5.1.3",
+    "vitest": "^0.32.2"
   },
   "scripts": {
-    "lint": "eslint --cache src --ext ts,js && eslint src/bin/install-pkmn-engine",
-    "fix": "eslint --fix src --ext ts,js && eslint --fix src/bin/install-pkmn-engine",
+    "lint": "eslint --cache src --ext ts,js && eslint src/bin/*",
+    "fix": "eslint --fix src --ext ts,js && eslint --fix src/bin/*",
     "compile": "tsc -p .",
     "build": "npm run compile",
     "test": "vitest src/pkg",
     "test:integration": "vitest src/test",
+    "debug": "npm run compile && node build/tools/debug",
     "fuzz": "npm run compile && node build/test/fuzz",
     "generate": "npm run compile && node build/tools/generate",
     "release": "npm run compile && node build/tools/release",
@@ -151,7 +161,8 @@
       },
       {
         "files": [
-          "src/test/*.test.ts"
+          "src/test/*.test.ts",
+          "src/test/regression/*.test.ts"
         ],
         "rules": {
           "jest/no-standalone-expect": "off"

package/src/bin/install-pkmn-engine

@@ -10,13 +10,15 @@ const path = require('path');
 const {pipeline} = require('stream/promises');
 const tty = require('tty');
 
-const ZIG_VERSION = {major: 0, minor: 11, patch: 0, dev: 2168};
+const ZIG_VERSION = {major: 0, minor: 11, patch: 0, dev: 3737};
 const DEV = ZIG_VERSION.dev ? `-dev.${ZIG_VERSION.dev}` : '';
 const VERSION = `${ZIG_VERSION.major}.${ZIG_VERSION.minor}.${ZIG_VERSION.patch}${DEV}`;
 const INDEX = 'https://ziglang.org/download/index.json';
 const ROOT = path.resolve(__dirname, '..', '..');
+let SILENT = false;
 
 const sh = (cmd, args) => execFileSync(cmd, args, {encoding: 'utf8', cwd: ROOT});
+const log = (...args) => { if (!SILENT) console.log(...args); };
 
 // This is hardly the browser fetch API, but it works for our primitive needs
 const fetch = url => new Promise((resolve, reject) => {
@@ -61,7 +63,7 @@ const unpack7 = (input, output) => new Promise((resolve, reject) => {
     require.resolve('7zip-min');
   } catch (err) {
     if (err.code !== 'MODULE_NOT_FOUND') throw err;
-    console.log('Installing 7zip-min package locally to unpack the archive...');
+    log('Installing 7zip-min package locally to unpack the archive...');
     sh('npm', ['install', '7zip-min', '--no-audit', '--no-save']);
   }
 
@@ -83,7 +85,7 @@ const unpack = async (input, output) => {
       sh('tar', ['xf', input, '-C', output]);
       return;
     } catch {
-      console.log('tar command not found, falling back to 7z');
+      log('tar command not found, falling back to 7z');
     }
   }
   // Try to use a 7z binary if we can, and only install 7zip-min as a last resort
@@ -120,10 +122,10 @@ const find = zig => {
         (!ZIG_VERSION.dev || (dev && dev >= ZIG_VERSION.dev)));
 
     if (compatible) {
-      console.log('Found existing compatible Zig executable:', zig_exe);
+      log('Found existing compatible Zig executable:', zig_exe);
       return zig_exe;
     } else {
-      console.log(`Existing Zig executable is not compatible (${version} < ${VERSION}):`, zig_exe);
+      log(`Existing Zig executable is not compatible (${version} < ${VERSION}):`, zig_exe);
     }
   } catch (err) {
     if (err.code !== 'ENOENT') throw err;
@@ -168,11 +170,11 @@ const install = async () => {
   let base = path.basename(url);
   const archive = path.join(dir, path.basename(url));
 
-  console.log(`Downloading Zig tarball from ${url} to ${archive}`);
+  log(`Downloading Zig tarball from ${url} to ${archive}`);
   try {
     await download(url, archive, release.shasum);
 
-    console.log(`Extracting tarball and installing to ${dir}`);
+    log(`Extracting tarball and installing to ${dir}`);
     await unpack(archive, dir);
     if (archive.endsWith('.zip')) {
       base = base.slice(0, -4);
@@ -187,17 +189,17 @@ const install = async () => {
     } catch (err) {
       if (err.code !== 'ENOENT') throw err;
     }
-    console.log(`Zig${version === 'master' ? '' : ` v${version}`} executable:`, zig,
+    log(`Zig${version === 'master' ? '' : ` v${version}`} executable:`, zig,
       '(this version of Zig will be retained to speed up future updates)');
     const [pre, post] = tty.isatty(1) ? ['\x1b[1m\x1b[35m', '\x1b[0m'] : ['', ''];
-    console.log(
+    log(
       `${pre}Consider moving the ${path.dirname(zig)} directory and adding it to your PATH`,
       `to use Zig on other projects, or delete this if you wish to save space.${post}`
     );
 
     return zig;
   } finally {
-    console.log(`Cleaning up ${archive}`);
+    log(`Cleaning up ${archive}`);
     try { fs.rmSync(archive); } catch {}
   }
 };
@@ -206,17 +208,17 @@ const install = async () => {
 const downloadHeaders = async () => {
   const include = path.resolve(process.execPath, '..', '..', 'include', 'node');
   if (fs.existsSync(path.join(include, 'node.h'))) {
-    console.log('Node headers:', include);
+    log('Node headers:', include);
     return include;
   }
 
   const dir = path.join(ROOT, 'build', 'include');
   const dest = path.join(dir, 'node');
   if (fs.existsSync(path.join(dest, 'node.h'))) {
-    console.log('Node headers:', dest);
+    log('Node headers:', dest);
     return dest;
   } else {
-    console.log(`Could not find Node headers at ${include}, downloading...`);
+    log(`Could not find Node headers at ${include}, downloading...`);
   }
 
   try {
@@ -229,14 +231,14 @@ const downloadHeaders = async () => {
   const targz = path.join(dir, path.basename(url));
   const unpacked = path.join(dir, `node-${process.version}`, 'include');
 
-  console.log(`Downloading Node headers from ${url} to ${targz}`);
+  log(`Downloading Node headers from ${url} to ${targz}`);
 
   try {
     await download(url, targz);
     await unpack(targz, dir);
     fs.renameSync(path.join(unpacked, 'node'), dest);
 
-    console.log('Node headers:', dest);
+    log('Node headers:', dest);
 
     return dest;
   } finally {
@@ -248,7 +250,7 @@ const downloadHeaders = async () => {
 const downloadImportLib = async () => {
   const library = path.resolve(process.execPath, '..', 'node.lib');
   if (fs.existsSync(path.join(library, 'node.h'))) {
-    console.log('Node import library:', library);
+    log('Node import library:', library);
     return library;
   }
 
@@ -256,10 +258,10 @@ const downloadImportLib = async () => {
   const url = new URL('./win-x64/node.lib', process.release.headersUrl).href;
   const dest = path.join(dir, path.basename(url));
   if (fs.existsSync(path.join(dest))) {
-    console.log('Node import library:', dest);
+    log('Node import library:', dest);
     return dest;
   } else {
-    console.log(`Could not find Node import library at ${library}, downloading...`);
+    log(`Could not find Node import library at ${library}, downloading...`);
   }
 
   try {
@@ -268,24 +270,41 @@ const downloadImportLib = async () => {
     if (err.code !== 'EEXIST') throw err;
   }
 
-  console.log(`Downloading Node import library from ${url} to ${dest}`);
+  log(`Downloading Node import library from ${url} to ${dest}`);
   await download(url, dest);
-  console.log('Node import library:', dest);
+  log('Node import library:', dest);
 
   return dest;
 };
 
 (async () => {
-  const options = (process.argv[2] || '').startsWith('--options=')
-    ? process.argv[2].slice(10).split(' ') : undefined;
-  if (process.argv.length > 3 ||
-    process.argv.length === 3 && !(process.argv[2] === '--zig' || options)) {
+  let only = false;
+  let options = undefined;
+  let error = false;
+  for (let i = 2; i < process.argv.length; i++) {
+    switch (process.argv[i]) {
+    case "--silent": {
+      SILENT = true;
+      break;
+    }
+    case "--zig": {
+      if (options || only) error = true;
+      only = true;
+      break;
+    }
+    default: {
+      if (options || only || !process.argv[i].startsWith('--options=')) error = true;
+      options = process.argv[i].slice(10).split(' ');
+    }
+    }
+  }
+  if (error) {
     console.error('Invalid arguments');
     process.exit(1);
   }
 
   const zig = await install();
-  if (process.argv[2] === '--zig') process.exit(0);
+  if (only) process.exit(0);
 
   let tmp;
   try {
@@ -318,13 +337,13 @@ const downloadImportLib = async () => {
         if (!options) {
           const addon = require(copy);
           if (addon.options.showdown) opts.push('-Dshowdown');
-          if (addon.options.trace) opts.push('-Dtrace');
+          if (addon.options.log) opts.push('-Dlog');
         }
       } else if (!options) {
         const addon = await WebAssembly.instantiate(fs.readFileSync(copy));
         const values = new Uint8Array(addon.instance.exports.memory.buffer);
         if (values[addon.instance.exports.SHOWDOWN.value]) opts.push('-Dshowdown');
-        if (values[addon.instance.exports.TRACE.value]) opts.push('-Dtrace');
+        if (values[addon.instance.exports.LOG.value]) opts.push('-Dlog');
       }
       const key = `${type} ${opts.sort().join(' ')}`;
       if (!configs.has(key)) configs.set(key, {type, options: opts});
@@ -355,7 +374,7 @@ const downloadImportLib = async () => {
       opts.includes('-Dshowdown') || opts.includes('-Dshowdown=true') ? '-showdown' : '';
     const flags = opts.length ? ` (${opts.join(' ')})` : '';
     const artifact = path.join('build', 'lib', `pkmn${suffix}.${config.type}`);
-    console.log(`Building ${artifact}${flags}`);
+    log(`Building ${artifact}${flags}`);
     sh(zig, args);
     // TODO: ziglang/zig#14647 broke emit_to so we get to rename the file ourselves...
     if (config.type === 'node') {

package/src/bin/pkmn-debug

@@ -0,0 +1,62 @@
+#!/usr/bin/env node
+'use strict';
+
+try {
+  require('source-map-support').install();
+} catch (err) {
+  if (err.code !== 'MODULE_NOT_FOUND') throw err;
+}
+
+const {execFileSync} = require('child_process');
+const {readFileSync} = require('fs');
+const {join, resolve} = require('path');
+
+const ROOT = resolve(__dirname, '..', '..');
+const packageJSON = JSON.parse(readFileSync(join(ROOT, 'package.json'), 'utf8'));
+
+const missing = [];
+for (const dep of ['@pkmn/img', 'html-minifier', 'mustache']) {
+  try {
+    require.resolve(dep);
+  } catch (e) {
+    if (e.code !== 'MODULE_NOT_FOUND') throw e;
+    missing.push(`${dep}@${packageJSON.devDependencies[dep]}`);
+  }
+}
+
+let Dex = undefined;
+try {
+  Dex = require('@pkmn/sim').Dex;
+} catch (err) {
+  if (err.code !== 'MODULE_NOT_FOUND') throw err;
+  try {
+    Dex = require('@pkmn/dex').Dex;
+  } catch (e) {
+    if (e.code !== 'MODULE_NOT_FOUND') throw e;
+    missing.push(`@pkmn/dex@${packageJSON.dependencies['@pkmn/data']}`);
+  }
+}
+
+if (missing.length) {
+  if (+/^v(\d+)/.exec(process.version)[1] < 16) {
+    console.error('pkmn-debug requires Node v16+');
+    process.exit(1);
+  }
+
+  execFileSync('npm', ['install', ...missing, '--global'], {encoding: 'utf8'});
+
+  const node_modules = execFileSync('npm', ['root', '--global'], {encoding: 'utf8'}).trim();
+  if (!process.env.NODE_PATH || !process.env.NODE_PATH.includes(node_modules)) {
+    console.error(`NODE_PATH must include npm's global node_modules directory: '${node_modules}'`);
+    process.exit(1);
+  }
+}
+
+const {Generations} = require('@pkmn/data');
+
+const {run} = require('../../build/tools/debug');
+
+run(new Generations(Dex)).catch(err => {
+  console.error(err.message);
+  process.exit(1);
+});