@pkmn/engine 0.1.0-dev.545e0ef3 → 0.1.0-dev.5ea92492

package/build/tools/debug.js

@@ -0,0 +1,133 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = exports.display = void 0;
+const fs = __importStar(require("fs"));
+const data_1 = require("@pkmn/data");
+const pkg_1 = require("../pkg");
+const addon = __importStar(require("../pkg/addon"));
+const data_2 = require("../pkg/data");
+const gen1 = __importStar(require("../pkg/gen1"));
+const display_1 = require("../test/display");
+class SpeciesNames {
+    gen;
+    battle;
+    constructor(gen, battle) {
+        this.gen = gen;
+        this.battle = battle;
+    }
+    get p1() {
+        const [p1] = Array.from(this.battle.sides);
+        const team = Array.from(p1.pokemon)
+            .sort((a, b) => a.position - b.position)
+            .map(p => ({ species: p.stored.species }));
+        return new pkg_1.SideInfo(this.gen, { name: 'Player 1', team });
+    }
+    get p2() {
+        const [, p2] = Array.from(this.battle.sides);
+        const team = Array.from(p2.pokemon)
+            .sort((a, b) => a.position - b.position)
+            .map(p => ({ species: p.stored.species }));
+        return new pkg_1.SideInfo(this.gen, { name: 'Player 2', team });
+    }
+}
+function display(gens, data, error, seed) {
+    if (!data.length)
+        throw new Error('Invalid input');
+    const view = data_2.Data.view(data);
+    let offset = 0;
+    const showdown = !!view.getUint8(offset++);
+    const gen = gens.get(view.getUint8(offset++));
+    const lookup = data_2.Lookup.get(gen);
+    const size = data_2.LAYOUT[gen.num - 1].sizes.Battle;
+    const deserialize = (buf) => {
+        // We don't care about the native addon, we just need to load it so other checks don't fail
+        void addon.supports(true);
+        switch (gen.num) {
+            case 1: return new gen1.Battle(lookup, data_2.Data.view(buf), { showdown });
+            default: throw new Error(`Unsupported gen: ${gen.num}`);
+        }
+    };
+    const battle = deserialize(data.subarray(offset, offset += size));
+    const names = new SpeciesNames(gen, battle);
+    const log = new pkg_1.Log(gen, lookup, names);
+    let partial = undefined;
+    const frames = [];
+    while (offset < view.byteLength) {
+        partial = { parsed: [] };
+        const it = log.parse(data_2.Data.view(data.subarray(offset)))[Symbol.iterator]();
+        let r = it.next();
+        while (!r.done) {
+            partial.parsed.push(r.value);
+            r = it.next();
+        }
+        offset += r.value;
+        if (offset >= view.byteLength)
+            break;
+        partial.battle = deserialize(data.subarray(offset, offset += size));
+        if (offset >= view.byteLength)
+            break;
+        partial.result = pkg_1.Result.decode(data[offset++]);
+        if (offset >= view.byteLength)
+            break;
+        partial.c1 = pkg_1.Choice.decode(data[offset++]);
+        if (offset >= view.byteLength)
+            break;
+        partial.c2 = pkg_1.Choice.decode(data[offset++]);
+        frames.push(partial);
+        partial = undefined;
+    }
+    return (0, display_1.render)(gen, showdown, error, seed, frames, partial);
+}
+exports.display = display;
+async function run(gens) {
+    let input;
+    if (process.argv.length > 2) {
+        if (process.argv.length > 3) {
+            console.error('Invalid input');
+            process.exit(1);
+        }
+        input = fs.readFileSync(process.argv[2]);
+    }
+    else {
+        let length = 0;
+        const result = [];
+        for await (const chunk of process.stdin) {
+            result.push(chunk);
+            length += chunk.length;
+        }
+        input = Buffer.concat(result, length);
+    }
+    process.stdout.write(display(gens, input));
+}
+exports.run = run;
+if (require.main === module) {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    run(new data_1.Generations(require('@pkmn/sim').Dex)).catch(err => {
+        console.error(err.message);
+        process.exit(1);
+    });
+}
+//# sourceMappingURL=debug.js.map

package/build/tools/debug.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"debug.js","sourceRoot":"","sources":["../../src/tools/debug.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAAyB;AAEzB,qCAAmD;AAEnD,gCAAmE;AACnE,oDAAsC;AACtC,sCAAiD;AACjD,kDAAoC;AACpC,6CAA8C;AAE9C,MAAM,YAAY;IAChB,GAAG,CAAa;IAChB,MAAM,CAAS;IAEf,YAAY,GAAe,EAAE,MAAc;QACzC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,IAAI,EAAE;QACJ,MAAM,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC3C,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC;aAChC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC;aACvC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAC,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,EAAC,CAAC,CAAC,CAAC;QAC3C,OAAO,IAAI,cAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,EAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAC,CAAC,CAAC;IAC1D,CAAC;IAED,IAAI,EAAE;QACJ,MAAM,CAAC,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC7C,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC;aAChC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC;aACvC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAC,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,EAAC,CAAC,CAAC,CAAC;QAC3C,OAAO,IAAI,cAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,EAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAC,CAAC,CAAC;IAC1D,CAAC;CACF;AAED,SAAgB,OAAO,CAAC,IAAiB,EAAE,IAAY,EAAE,KAAc,EAAE,IAAa;IACpF,IAAI,CAAC,IAAI,CAAC,MAAM;QAAE,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;IAEnD,MAAM,IAAI,GAAG,WAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAE7B,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,MAAM,QAAQ,GAAG,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAC3C,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAE9C,MAAM,MAAM,GAAG,aAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC/B,MAAM,IAAI,GAAG,aAAM,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC;IAC9C,MAAM,WAAW,GAAG,CAAC,GAAW,EAAU,EAAE;QAC1C,2FAA2F;QAC3F,KAAK,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC1B,QAAQ,GAAG,CAAC,GAAG,EAAE;YACjB,KAAK,CAAC,CAAC,CAAC,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,WAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAC,QAAQ,EAAC,CAAC,CAAC;YACnE,OAAO,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC,oBAAoB,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;SACvD;IACH,CAAC,CAAC;IAEF,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC;IAClE,MAAM,KAAK,GAAG,IAAI,YAAY,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAC5C,MAAM,GAAG,GAAG,IAAI,SAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAExC,IAAI,OAAO,GAA+B,SAAS,CAAC;IACpD,MAAM,MAAM,GAAY,EAAE,CAAC;IAC3B,OAAO,MAAM,GAAG,IAAI,CAAC,UAAU,EAAE;QAC/B,OAAO,GAAG,EAAC,MAAM,EAAE,EAAE,EAAC,CAAC;QACvB,MAAM,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,WAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC1E,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC;QAClB,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE;YACd,OAAO,CAAC,MAAO,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YAC9B,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC;SACf;QACD,MAAM,IAAI,CAAC,CAAC,KAAK,CAAC;QAClB,IAAI,MAAM,IAAI,IAAI,CAAC,UAAU;YAAE,MAAM;QAErC,OAAO,CAAC,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC;QACpE,IAAI,MAAM,IAAI,IAAI,CAAC,UAAU;YAAE,MAAM;QAErC,OAAO,CAAC,MAAM,GAAG,YAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC/C,IAAI,MAAM,IAAI,IAAI,CAAC,UAAU;YAAE,MAAM;QAErC,OAAO,CAAC,EAAE,GAAG,YAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC3C,IAAI,MAAM,IAAI,IAAI,CAAC,UAAU;YAAE,MAAM;QAErC,OAAO,CAAC,EAAE,GAAG,YAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAE3C,MAAM,CAAC,IAAI,CAAC,OAAgB,CAAC,CAAC;QAC9B,OAAO,GAAG,SAAS,CAAC;KACrB;IAED,OAAO,IAAA,gBAAM,EAAC,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AAC7D,CAAC;AArDD,0BAqDC;AAEM,KAAK,UAAU,GAAG,CAAC,IAAiB;IACzC,IAAI,KAAK,CAAC;IACV,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;QAC3B,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;YAC3B,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;YAC/B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACjB;QACD,KAAK,GAAG,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;KAC1C;SAAM;QACL,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,MAAM,MAAM,GAAiB,EAAE,CAAC;QAChC,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,OAAO,CAAC,KAAK,EAAE;YACvC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC;SACxB;QACD,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACvC;IACD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;AAC7C,CAAC;AAlBD,kBAkBC;AAED,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE;IAC3B,8DAA8D;IAC9D,GAAG,CAAC,IAAI,kBAAW,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;QACzD,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC3B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;CACJ"}

package/build.zig

@@ -1,8 +1,6 @@
 const std = @import("std");
 const builtin = @import("builtin");
 
-const NativeTargetInfo = std.zig.system.NativeTargetInfo;
-
 pub const Options = struct { showdown: ?bool = null, trace: ?bool = null };
 
 pub fn module(b: *std.Build, options: Options) *std.Build.Module {
@@ -29,8 +27,9 @@ 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();
@@ -66,7 +65,7 @@ pub fn build(b: *std.Build) !void {
         lib.linkLibC();
         if (node_import_lib) |il| {
             lib.addObjectFile(il);
-        } else if ((try NativeTargetInfo.detect(target)).target.os.tag == .windows) {
+        } else if ((try std.zig.system.NativeTargetInfo.detect(target)).target.os.tag == .windows) {
             try std.io.getStdErr().writeAll("Must provide --node-import-library path on Windows\n");
             std.process.exit(1);
         }
@@ -74,7 +73,7 @@ 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);
@@ -98,13 +97,10 @@ 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 });
@@ -139,6 +135,7 @@ 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;
+        if (emit_asm) lib.emit_asm = .emit;
         lib.install();
         c = true;
     }
@@ -235,7 +232,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);
 }
@@ -248,7 +245,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",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pkmn/engine",
-  "version": "0.1.0-dev.545e0ef3",
+  "version": "0.1.0-dev.5ea92492",
   "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,54 +39,41 @@
     "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/data": "^0.7.36",
     "@pkmn/protocol": "^0.6.11"
   },
   "devDependencies": {
     "@pkmn/eslint-config": "^3.0.0",
     "@pkmn/img": "^0.2.8",
     "@pkmn/sets": "^5.0.4",
-    "@pkmn/sim": "0.7.35",
+    "@pkmn/sim": "0.7.36",
     "@types/html-minifier": "^4.0.2",
     "@types/jest": "^29.5.0",
     "@types/minimist": "^1.2.2",
@@ -83,12 +92,13 @@
     "vitest": "^0.29.8"
   },
   "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",

package/src/bin/install-pkmn-engine

@@ -15,8 +15,10 @@ 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-${process.version}`, 'include', 'node');
+  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 {
@@ -227,20 +229,28 @@ const downloadHeaders = async () => {
 
   const url = process.release.headersUrl;
   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}`);
-  await download(url, targz);
-  await unpack(targz, dir);
+  log(`Downloading Node headers from ${url} to ${targz}`);
 
-  console.log('Node headers:', dest);
+  try {
+    await download(url, targz);
+    await unpack(targz, dir);
+    fs.renameSync(path.join(unpacked, 'node'), dest);
 
-  return dest;
+    log('Node headers:', dest);
+
+    return dest;
+  } finally {
+    try { fs.rmSync(targz); } catch {}
+    try { fs.rmSync(unpacked, {recursive: true}); } catch {}
+  }
 };
 
 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;
   }
 
@@ -248,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 {
@@ -260,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 {
@@ -347,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') {
@@ -355,7 +382,7 @@ const downloadImportLib = async () => {
       const ext = process.platform === 'darwin'
         ? 'dylib' : process.platform === 'win32' ? 'dll' : 'so';
       const actual = path.join('build', 'lib', `${prefix}pkmn${suffix}.node.${ext}`);
-      fs.renameSync(actual, artifact);
+      fs.renameSync(path.join(ROOT, actual), path.join(ROOT, artifact));
     }
   }
 })().catch(e => {

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

package/src/lib/gen1/README.md

@@ -332,7 +332,9 @@ must be gleaned through the `Battle` state). Useful size and offset information
 the [`layout.json`](../../data/layout.json) which exists to simplify writing driver code.
 
 Documentation of the wire protocol used for logging traces when `-Dtrace` is enabled can be found in
-[PROTOCOL.md](../../../docs/PROTOCOL.md).
+[PROTOCOL.md](../../../docs/PROTOCOL.md). Note that the
+[`pkmn-debug`](../../../README.md#pkmn-debug) tool exists to display the binary protocol and battle
+data in the browser for ease of debugging.
 
 ### `Battle`
 
@@ -476,7 +478,8 @@ Smogon](https://www.smogon.com/forums/posts/5933177/show):
 - Confusion self-hits use the wrong damage formula resulting in off-by-one errors (and also fail to
   account for an opponent's Reflect). Furthermore, the confusion self-hit damage will erroneously be
   inflicted to the confused user's substitute if the confused user had been attempting to use a
-  self-targeting move.
+  self-targeting move. Finally, Pokémon Showdown erroneously considers the *uncapped* self-hit
+  damage for the purposes of tracking the battle's last damage.
 
 Beyond the general bugs listed above, several move effects are implemented incorrectly by Pokémon
 Showdown. Some of these moves are [too fundamentally broken to be implemented](#unimplementable) by
@@ -486,16 +489,25 @@ the pkmn engine, but the following moves have their broken behavior preserved in
   incorrectly still gets applied to Bide's user.
 - **Leech Seed**: Leech Seed fails to heal its source side if a seeded target faints due to
   recoil/crash damage on Pokémon Showdown. Pokémon Showdown also updates the battle's last damage
-  field with the uncapped Leech Seed damage which has consequences for Bide and Counter.
+  field with the uncapped Leech Seed damage if the residual damage is applied which has consequences
+  for Bide and Counter.
 - **Pay Day**: Pay Day should still scatter coins if it hits (but doesn't break) and opponent's
   Substitute but doesn't on Pokémon Showdown.
 - **Flinch**: Flinching does not get cleared during move selection on Pokémon Showdown and is
   instead cleared in Pokémon Showdown's "residual" phase, meaning the flinch status gets erroneously
   preserved across fainting (as fainting triggers Pokémon Showdown's "instaswitch" behavior which
   skips end-of-turn residuals).
+- **Rage**: Rage boosts should still result in burn/paralysis [stat modification
+  errors](https://pkmn.cc/bulba-glitch-1#Stat_modification_errors) but don't on Pokémon Showdown.
+  Furthermore, Pokémon Showdown only builds Rage for Disable/Explosion (hit/miss) when attacking
+  into a Substitute instead of all moves. Pokémon Showdown also implements the [Rage and Thrash /
+  Petal Dance accuracy bug]( https://www.youtube.com/watch?v=NC5gbJeExbs) incorrectly, as the
+  accuracy only gets written when the volatile is present which can lead to incorrect accuracy
+  values on turns where Rage is used on the same turn as a move which modifies accuracy or evasion.
 - **Thrash** / **Petal Dance**: once a Pokémon is locked into a thrashing move they will lose all
   speed ties on Pokémon Showdown (due to the fact that if they win the speed tie their action will
-  then get "changed" and inserted back into the queue after their opponent's action).
+  then get "changed" and inserted back into the queue after their opponent's action). Pokémon
+  Showdown also implements accuracy incorrectly, as covered above.
 - **Freeze** / **Sleep**: Pokémon Showdown requires a move to be selected when a Pokémon is frozen
   or sleeping and uses that in the event that the status is removed while on the cartridge no
   selection is possible and no turn exists for the thawed/woken Pokémon to act except in the case of
@@ -520,7 +532,8 @@ the pkmn engine, but the following moves have their broken behavior preserved in
   Pokémon Showdown implementing the health check based on floating point division instead of integer
   divison like on the cartridge (meaning the Substitute 1/4 glitch will only occur if the Pokémon's
   maximum HP is evenly divisible by 4). Finally, Substitute also incorrectly blocks Dream Eater on
-  Pokémon Showdown.
+  Pokémon Showdown and will incorrectly still heal 1 HP for any draining moves if the attack does 0
+  damage.
 
 In addition to numerous cases where Pokémon Showdown uses the wrong type of message (e.g. `|-fail`
 vs. `|-miss|` vs. `|-immune|`, e.g. in the case of Leech Seed) which are not documented here, Pokémon