@pkmn/engine 0.1.0-dev.7cd30bd9 → 0.1.0-dev.7f37a47c

package/src/bin/install-pkmn-engine

@@ -10,15 +10,13 @@ const path = require('path');
 const {pipeline} = require('stream/promises');
 const tty = require('tty');
 
-const ZIG_VERSION = {major: 0, minor: 11, patch: 0, dev: 2560};
+const ZIG_VERSION = {major: 0, minor: 11, patch: 0, dev: 2168};
 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) => {
@@ -63,7 +61,7 @@ const unpack7 = (input, output) => new Promise((resolve, reject) => {
     require.resolve('7zip-min');
   } catch (err) {
     if (err.code !== 'MODULE_NOT_FOUND') throw err;
-    log('Installing 7zip-min package locally to unpack the archive...');
+    console.log('Installing 7zip-min package locally to unpack the archive...');
     sh('npm', ['install', '7zip-min', '--no-audit', '--no-save']);
   }
 
@@ -85,7 +83,7 @@ const unpack = async (input, output) => {
       sh('tar', ['xf', input, '-C', output]);
       return;
     } catch {
-      log('tar command not found, falling back to 7z');
+      console.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
@@ -122,10 +120,10 @@ const find = zig => {
         (!ZIG_VERSION.dev || (dev && dev >= ZIG_VERSION.dev)));
 
     if (compatible) {
-      log('Found existing compatible Zig executable:', zig_exe);
+      console.log('Found existing compatible Zig executable:', zig_exe);
       return zig_exe;
     } else {
-      log(`Existing Zig executable is not compatible (${version} < ${VERSION}):`, zig_exe);
+      console.log(`Existing Zig executable is not compatible (${version} < ${VERSION}):`, zig_exe);
     }
   } catch (err) {
     if (err.code !== 'ENOENT') throw err;
@@ -170,11 +168,11 @@ const install = async () => {
   let base = path.basename(url);
   const archive = path.join(dir, path.basename(url));
 
-  log(`Downloading Zig tarball from ${url} to ${archive}`);
+  console.log(`Downloading Zig tarball from ${url} to ${archive}`);
   try {
     await download(url, archive, release.shasum);
 
-    log(`Extracting tarball and installing to ${dir}`);
+    console.log(`Extracting tarball and installing to ${dir}`);
     await unpack(archive, dir);
     if (archive.endsWith('.zip')) {
       base = base.slice(0, -4);
@@ -189,17 +187,17 @@ const install = async () => {
     } catch (err) {
       if (err.code !== 'ENOENT') throw err;
     }
-    log(`Zig${version === 'master' ? '' : ` v${version}`} executable:`, zig,
+    console.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'] : ['', ''];
-    log(
+    console.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 {
-    log(`Cleaning up ${archive}`);
+    console.log(`Cleaning up ${archive}`);
     try { fs.rmSync(archive); } catch {}
   }
 };
@@ -208,17 +206,17 @@ const install = async () => {
 const downloadHeaders = async () => {
   const include = path.resolve(process.execPath, '..', '..', 'include', 'node');
   if (fs.existsSync(path.join(include, 'node.h'))) {
-    log('Node headers:', include);
+    console.log('Node headers:', include);
     return include;
   }
 
   const dir = path.join(ROOT, 'build', 'include');
-  const dest = path.join(dir, 'node');
+  const dest = path.join(dir, `node-${process.version}`, 'include', 'node');
   if (fs.existsSync(path.join(dest, 'node.h'))) {
-    log('Node headers:', dest);
+    console.log('Node headers:', dest);
     return dest;
   } else {
-    log(`Could not find Node headers at ${include}, downloading...`);
+    console.log(`Could not find Node headers at ${include}, downloading...`);
   }
 
   try {
@@ -229,28 +227,20 @@ 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');
 
-  log(`Downloading Node headers from ${url} to ${targz}`);
+  console.log(`Downloading Node headers from ${url} to ${targz}`);
+  await download(url, targz);
+  await unpack(targz, dir);
 
-  try {
-    await download(url, targz);
-    await unpack(targz, dir);
-    fs.renameSync(path.join(unpacked, 'node'), dest);
-
-    log('Node headers:', dest);
+  console.log('Node headers:', dest);
 
-    return dest;
-  } finally {
-    try { fs.rmSync(targz); } catch {}
-    try { fs.rmSync(unpacked, {recursive: true}); } catch {}
-  }
+  return dest;
 };
 
 const downloadImportLib = async () => {
   const library = path.resolve(process.execPath, '..', 'node.lib');
   if (fs.existsSync(path.join(library, 'node.h'))) {
-    log('Node import library:', library);
+    console.log('Node import library:', library);
     return library;
   }
 
@@ -258,10 +248,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))) {
-    log('Node import library:', dest);
+    console.log('Node import library:', dest);
     return dest;
   } else {
-    log(`Could not find Node import library at ${library}, downloading...`);
+    console.log(`Could not find Node import library at ${library}, downloading...`);
   }
 
   try {
@@ -270,41 +260,24 @@ const downloadImportLib = async () => {
     if (err.code !== 'EEXIST') throw err;
   }
 
-  log(`Downloading Node import library from ${url} to ${dest}`);
+  console.log(`Downloading Node import library from ${url} to ${dest}`);
   await download(url, dest);
-  log('Node import library:', dest);
+  console.log('Node import library:', dest);
 
   return dest;
 };
 
 (async () => {
-  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) {
+  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)) {
     console.error('Invalid arguments');
     process.exit(1);
   }
 
   const zig = await install();
-  if (only) process.exit(0);
+  if (process.argv[2] === '--zig') process.exit(0);
 
   let tmp;
   try {
@@ -374,7 +347,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}`);
-    log(`Building ${artifact}${flags}`);
+    console.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') {
@@ -382,7 +355,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(path.join(ROOT, actual), path.join(ROOT, artifact));
+      fs.renameSync(actual, artifact);
     }
   }
 })().catch(e => {

package/src/lib/binding/node.zig

@@ -34,11 +34,11 @@ fn bindings(env: c.napi_env) c.napi_value {
 }
 
 fn bind(env: c.napi_env, gen: anytype) c.napi_value {
-    const choices_size = @intCast(u32, gen.CHOICES_SIZE);
+    const options_size = @intCast(u32, gen.OPTIONS_SIZE);
     const logs_size = @intCast(u32, gen.LOGS_SIZE);
     var object = Object.init(env);
     const properties = [_]c.napi_property_descriptor{
-        Property.init("CHOICES_SIZE", .{ .value = Number.init(env, choices_size) }),
+        Property.init("OPTIONS_SIZE", .{ .value = Number.init(env, options_size) }),
         Property.init("LOGS_SIZE", .{ .value = Number.init(env, logs_size) }),
         Property.init("update", .{ .method = update(gen) }),
         Property.init("choices", .{ .method = choices(gen) }),
@@ -108,10 +108,10 @@ fn choices(gen: anytype) c.napi_callback {
             const request = @intToEnum(pkmn.Choice.Type, Number.get(env, argv[2], u8));
 
             assert(c.napi_get_arraybuffer_info(env, argv[3], &data, &len) == c.napi_ok);
-            assert(len == gen.CHOICES_SIZE);
+            assert(len == gen.OPTIONS_SIZE);
             assert(data != null);
 
-            var out = @ptrCast([*]pkmn.Choice, data.?)[0..gen.CHOICES_SIZE];
+            var out = @ptrCast([*]pkmn.Choice, data.?)[0..gen.OPTIONS_SIZE];
             const n = battle.choices(player, request, out);
             return Number.init(env, @bitCast(u8, n));
         }

package/src/lib/binding/wasm.zig

@@ -4,7 +4,7 @@ const pkmn = @import("../pkmn.zig");
 export const SHOWDOWN = pkmn.options.showdown;
 export const TRACE = pkmn.options.trace;
 
-export const GEN1_CHOICES_SIZE =
-    std.math.ceilPowerOfTwo(u32, @intCast(u32, pkmn.gen1.CHOICES_SIZE)) catch unreachable;
+export const GEN1_OPTIONS_SIZE =
+    std.math.ceilPowerOfTwo(u32, @intCast(u32, pkmn.gen1.OPTIONS_SIZE)) catch unreachable;
 export const GEN1_LOGS_SIZE =
     std.math.ceilPowerOfTwo(u32, @intCast(u32, pkmn.gen1.LOGS_SIZE)) catch unreachable;

package/src/lib/gen1/README.md

@@ -332,9 +332,7 @@ 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). 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.
+[PROTOCOL.md](../../../docs/PROTOCOL.md).
 
 ### `Battle`
 
@@ -469,7 +467,7 @@ data in the browser for ease of debugging.
 
 In addition to its alternative [RNG semantics](#rng), Pokémon Showdown's implementation of the first
 generation of Pokémon contains a number bugs, [many of which are known and have been documented on
-Smogon](https://www.smogon.com/forums/posts/5933177/show):
+Smogon](https://www.smogon.com/forums/threads/rby-tradebacks-bug-report-thread.3524844/#post-5933177):
 
 - moves on Pokémon Showdown can do 0 damage instead of failing or causing a [division-by-zero
   freeze](https://pkmn.cc/bulba-glitch-1#Division_by_0).
@@ -478,36 +476,23 @@ 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. Finally, Pokémon Showdown erroneously considers the *uncapped* self-hit
-  damage for the purposes of tracking the battle's last damage.
+  self-targeting move.
 
 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
 the pkmn engine, but the following moves have their broken behavior preserved in `-Dshowdown` mode:
 
-- **Bide**: If the opponent faints after Bide inflicts damage on Pokémon Showdown residual damage
-  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 if the residual damage is applied which has consequences
-  for Bide and Counter.
+  recoil/crash damage on Pokémon Showdown.
 - **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). Pokémon
-  Showdown also implements accuracy incorrectly, as covered above.
+  then get "changed" and inserted back into the queue after their opponent's action).
 - **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
@@ -523,17 +508,14 @@ the pkmn engine, but the following moves have their broken behavior preserved in
   implement by Pokémon Showdown.
 - **Roar** / **Whirlwind**: these moves can miss on Pokémon Showdown (and advance the RNG when
   checking) which is incorrect (these moves should always fail, but do not check accuracy or advance
-  the RNG). More importantly, these moves should *not* cause the tracked last battle damage to be
-  zeroed, but on Pokémon Showdown they do.
+  the RNG).
 - **Substitute**: in addition to the [Substitute + Confusion
   glitch](https://pkmn.cc/bulba-glitch-1#Substitute_.2B_Confusion_glitch) not being implemented
   correctly (covered above), the [Substitute 1/4
   glitch](https://glitchcity.wiki/Substitute_%C2%BC_HP_glitch) also fails in many cases due to
   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 and will incorrectly still heal 1 HP for any draining moves if the attack does 0
-  damage.
+  maximum HP is evenly divisible by 4).
 
 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
@@ -567,7 +549,7 @@ called out in the `|rule|` section at the beginning of a battle's log):
   `|rule|` section** in Generation I (or II) as the actual order of switches here does not have
   competitive implications like it does in Generation III, but it is still contrary to how the games
   work where the [host (Player 1)'s Pokemon would switch
-  first](https://www.smogon.com/forums/posts/5989318/show).
+  first](https://www.smogon.com/forums/threads/gen-3-on-ps-final-fixes.3527268/post-5989318).
 
 Pokémon Showdown enforces several clauses *before* the battle: **Cleric Clause** (all Pokémon must
 have full HP and PP, and not have any status conditions prior to the battle), **Stat Tradeback
@@ -588,12 +570,13 @@ left up to a client to support.
 
 Numerous moves on Pokémon Showdown are broken not simply due to local issues in the implementation
 of their effects but instead due to **global issues** related to fundamental mechanics such as
-[broken move selection](https://www.smogon.com/forums/posts/8655897/show), using move name instead
-of slot to determine move identity, implementing volatile statuses incorrectly or not understanding
-how moves which call other moves work means that it isn't possible to completely implement Pokémon
-Showdown's behavior for the following moves (the pkmn engine attempts to reproduce as much of the
-behavior that can be reproduced without making data structure changes or dramatically deviating from
-the correct control flow):
+[broken move
+selection](https://www.smogon.com/forums/threads/rby-fight-button-simulation-improvements-fix-partial-trapping-improve-counter.3673280/#post-8655897),
+using move name instead of slot to determine move identity, implementing volatile statuses
+incorrectly or not understanding how moves which call other moves work means that it isn't possible
+to completely implement Pokémon Showdown's behavior for the following moves (the pkmn engine
+attempts to reproduce as much of the behavior that can be reproduced without making data structure
+changes or dramatically deviating from the correct control flow):
 
 - **Wrap**: Binding moves like Wrap are implemented on Pokémon Showdown with an artificial
   `partialtrappinglock` volatile as opposed to how it works on the cartridge which simply relies on
@@ -682,10 +665,10 @@ compatibility mode, the implications of these differences are outlined below:
 Finally, the **initial 10-byte seed for link battles on Pokémon Red cannot include bytes larger than
 the `SERIAL_PREAMBLE_BYTE`**, so must be in the range $\left[0, 252\right]$. This has implications
 on the first 10 random numbers generated during the battle and has [**non-trivial competitive
-implications**](https://www.smogon.com/forums/posts/9068411/show) (at the start of the battle move
-effects become more likely, the ["1/256-miss" glitch](https://glitchcity.wiki/1/256_miss_glitch)
-cannot happen, Player 1 is more likely to win speed ties, etc) that Pokémon Showdown cannot
-replicate due to everything described above.
+implications**](https://www.smogon.com/forums/threads/rby-tradebacks-bug-report-thread.3524844/page-16#post-9068411)
+(at the start of the battle move effects become more likely, the ["1/256-miss"
+glitch](https://glitchcity.wiki/1/256_miss_glitch) cannot happen, Player 1 is more likely to win
+speed ties, etc) that Pokémon Showdown cannot replicate due to everything described above.
 
 All of places in the link battle code where randomness is required are outlined below:
 
@@ -784,8 +767,11 @@ The pkmn engine attempts to adhere to certain naming conventions:
 ## Resources
 
 - [pret/pokered](https://github.com/pret/pokered/) disassembly
-- [Gen I Main Battle Function](https://www.smogon.com/forums/posts/5878612/show) - Crystal_
+- [Gen I Main Battle
+  Function](https://www.smogon.com/forums/threads/past-gens-research-thread.3506992/#post-5878612) -
+  Crystal_
 - [Pokemon Showdown!](https://github.com/smogon/pokemon-showdown)
 - [List of glitches (Generation
   I)](https://bulbapedia.bulbagarden.net/wiki/List_of_glitches_(Generation_I))
-- [Pokémon Showdown RBY Bugs](https://www.smogon.com/forums/posts/5933177/show)
+- [Pokémon Showdown RBY
+  Bugs](https://www.smogon.com/forums/threads/rby-tradebacks-bug-report-thread.3524844/#post-5933177)

package/src/lib/gen1/data.zig

@@ -17,16 +17,16 @@ const expectEqual = std.testing.expectEqual;
 const expect = std.testing.expect;
 
 /// The minimum size in bytes required to hold all Generation I choice options.
-pub const MAX_CHOICES: usize = 9; // move 1..4, switch 2..6
+pub const MAX_OPTIONS: usize = 9; // move 1..4, switch 2..6
 /// The optimal size in bytes required to hold all Generation I choice options.
-/// At least as large as MAX_CHOICES.
+/// At least as large as MAX_OPTIONS.
 pub const MAX_LOGS: usize = 180;
 
 /// The maximum number of bytes possibly logged by a single Generation I update.
-pub const CHOICES_SIZE = if (builtin.mode == .ReleaseSmall)
-    MAX_CHOICES
+pub const OPTIONS_SIZE = if (builtin.mode == .ReleaseSmall)
+    MAX_OPTIONS
 else
-    std.math.ceilPowerOfTwo(usize, MAX_CHOICES) catch unreachable;
+    std.math.ceilPowerOfTwo(usize, MAX_OPTIONS) catch unreachable;
 /// The optimal size in bytes required to hold the largest amount of log data possible from a
 /// single Generation I update. At least as large as MAX_LOGS.
 pub const LOGS_SIZE = if (builtin.mode == .ReleaseSmall)
@@ -272,7 +272,7 @@ pub const Status = enum(u8) {
         return num > 0;
     }
 
-    /// Returns a human-readable representation of the status `num`.
+    /// Retunrns a human-readable representation of the status `num`.
     pub fn name(num: u8) []const u8 {
         if (Status.is(num, .EXT)) return if (num == Status.TOX) "TOX" else "SLF";
         if (Status.is(num, .SLP)) return "SLP";

package/src/lib/gen1/helpers.zig

@@ -216,7 +216,11 @@ fn blocked(m: Move) bool {
     if (Move.get(m).effect == .Binding) return true;
     return switch (m) {
         .Counter,
+        // FIXME: test and see if this can be removed or document
+        .Rage,
         .Mimic,
+        // FIXME: test and see if this can be removed or document
+        .Bide,
         .Metronome,
         .MirrorMove,
         .Transform,