@pkmn/engine 0.1.0-dev.63cef311 → 0.1.0-dev.7b099504

package/src/lib/gen1/README.md

@@ -198,7 +198,7 @@ above, PP information isn't strictly necessary in Generation I so is dropped. `M
 a special sentinel value to indicate `null`. Move PP data is only included for testing and is not
 necessary for the actual engine implementation.
 
-In order to workaround various [Pokémon Showdown bugs](#bugs) and to support its protocol in traces,
+In order to workaround various [Pokémon Showdown bugs](#bugs) and to support its protocol in logs,
 additional information is stored in `Move.Data` (`targets`) about what Pokémon Showdown believes the
 `Move.Target` to be (despite the concept of targeting not existing until Generation III when Double
 battles were introduced). More specifically, a move's "targeting" status is required in various
@@ -331,8 +331,10 @@ does not produce an equivalent to Pokémon Showdown's `|request|` protocol messa
 must be gleaned through the `Battle` state). Useful size and offset information can be found in
 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).
+Documentation of the wire protocol used for protocol message logging when `-Dlog` 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.
 
 ### `Battle`
 
@@ -467,7 +469,7 @@ Documentation of the wire protocol used for logging traces when `-Dtrace` is ena
 
 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/threads/rby-tradebacks-bug-report-thread.3524844/#post-5933177):
+Smogon](https://www.smogon.com/forums/posts/5933177/show):
 
 - 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).
@@ -476,12 +478,15 @@ Smogon](https://www.smogon.com/forums/threads/rby-tradebacks-bug-report-thread.3
 - 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
 the pkmn engine, but the following moves have their broken behavior preserved in `-Dshowdown` mode:
 
+- **Counter**: On Pokémon Showdown choices made while sleeping (which should not have been
+  registered) can erroneously cause Counter to trigger Desync Clause Mod behavior.
 - **Leech Seed**: Leech Seed fails to heal its source side if a seeded target faints due to
   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
@@ -490,9 +495,17 @@ the pkmn engine, but the following moves have their broken behavior preserved in
   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
@@ -508,15 +521,21 @@ 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).
+  the RNG). More importantly, these moves should *not* cause the tracked last battle damage to be
+  zeroed, but on Pokémon Showdown they do.
 - **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.
+  maximum HP is evenly divisible by 4). 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. Finally, Pokémon Showdown uses a `subFainted` field to track whether a Substitute was
+  broken in order to know when to nullify a move's effect, only it doesn't get cleared at the end of
+  the turn and can result in incorrect behavior on subsequent turns with the moves Mirror Move and
+  Metronome that invoke `runMove` (which is where `subFainted` gets cleared) on the user but skips
+  calling it for the eventual true target.
 
 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
@@ -550,7 +569,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/threads/gen-3-on-ps-final-fixes.3527268/post-5989318).
+  first](https://www.smogon.com/forums/posts/5989318/show).
 
 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
@@ -571,14 +590,17 @@ 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/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):
-
+[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):
+
+- **Bide**: Bide's damage can overflow if OHKO moves are involved because OHKO moves work by setting
+  the damage to 65535 - Pokémon Showdown doesn't implement this overflow and instead lets Bide's
+  damage grow unbounded. Additionally, if the opponent faints after Bide inflicts damage on Pokémon
+  Showdown residual damage incorrectly still gets applied to Bide's user.
 - **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
   the `Binding` volatile of the opponent. This mistake results in choice locking not being reported
@@ -587,9 +609,9 @@ changes or dramatically deviating from the correct control flow):
   still gets a turn under the [trapping sleep
   glitch](https://glitchcity.wiki/Trapping_move_and_sleep_glitch), Wrap does 0 damage against
   Ghost-type Pokémon instead of properly respecting immunity, and binding effects are handled in the
-  wrong order in the code.
-- **Counter**: On Pokémon Showdown choices made while sleeping (which should not have been
-  registered) can erroneously cause Counter to trigger Desync Clause Mod behavior.
+  wrong order in the code which results in either out of order messaging or, more consequentially,
+  Pokémon using Rage/Bide or Thrashing/Charging moves being incorrectly forced to skip a turn when
+  the Pokémon using the Binding move switches.
 - **Mimic**: Pokémon Showdown checks that the user of Mimic has Mimic in one of their move slots,
   which means Mimic legally called via Metronome or Mirror Move will only work if the user also has
   Mimic (and the moved mimicked by Mimic called via Metronome / Mirror Move will erroneously
@@ -598,18 +620,25 @@ changes or dramatically deviating from the correct control flow):
   the Pokémon already knows, PP deduction for using either the original move of the mimicked move
   will instead deduct PP for whichever appears at the lower move slot index and the PP will be
   allowed to go negative (effectively allowing for infinite PP use).
-- **Mirror Move**: Binding moves misbehave when used via Mirror Move (though Pokémon Showdown has
-  its own weird behavior and does not implement the [partial trapping move Mirror Move
+- **Mirror Move**: As covered above, both Substitute and Binding moves misbehave when used via
+  Mirror Move (though Pokémon Showdown has its own weird behavior and does not implement the
+  [partial trapping move Mirror Move
   glitch](https://glitchcity.wiki/Partial_trapping_move_Mirror_Move_link_battle_glitch) that exists
-  on the cartridge).
-- **Metronome**: In addition to the issues with binding moves, Metronome and Mirror Move cannot
-  mutually call each other more than 3 times in a row without causing the Pokémon Showdown simulator
-  to crash due to defensive safety checks that do not exist on the cartridge.
-- **Transform**:  Transform screws up the effect of Disable, because on Pokémon Showdown, Disable
+  on the cartridge). Additionally, Pokémon Showdown sets the last used move every turn a Pokémon is
+  Thrashing instead of just on the turn it is actually selected meaning Mirror Move will sometimes
+  successfully mirror a Thrashing move when it should fail. Finally, if Mirror Move copies
+  Struggle it should not deduct PP but on Pokémon Showdown it does.
+- **Metronome**: In addition to the issues with binding moves and Substitute, Metronome and Mirror
+  Move cannot mutually call each other more than 3 times in a row without causing the Pokémon
+  Showdown simulator to crash due to defensive safety checks that do not exist on the cartridge.
+- **Transform**: Transform screws up the effect of Disable, because on Pokémon Showdown, Disable
   prevents moves of a given *name* from being used (e.g. "Water Gun") as opposed to moves in a
   specific *slot* (e.g. the 2nd move slot), and a Pokémon's moves can change after Transform (this
-  is not an issue with Disable + Mimic because Mimic happens to replace the same slot). Furthermore,
-  transforming and then using Mirror Move / Metronome can result in [glitchy behavior and
+  is not an issue with Disable + Mimic because Mimic happens to replace the same slot). Transform
+  also has a bad interaction with Pokémon Showdown's buggy Haze implementation, as Haze on Pokémon
+  Showdown does not copy unmodified stats, leaving the Transformed Pokémon with inccorect stats.
+  Furthermore, transforming and then using Mirror Move / Metronome can result in [glitchy behavior
+  and
   softlocks](https://pkmn.cc/bulba/Transform_glitches#Transform_.2B_Mirror_Move.2FMetronome_PP_error)
   which Pokémon Showdown does not implement.
 
@@ -666,10 +695,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/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.
+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.
 
 All of places in the link battle code where randomness is required are outlined below:
 
@@ -768,11 +797,8 @@ 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/threads/past-gens-research-thread.3506992/#post-5878612) -
-  Crystal_
+- [Gen I Main Battle Function](https://www.smogon.com/forums/posts/5878612/show) - 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/threads/rby-tradebacks-bug-report-thread.3524844/#post-5933177)
+- [Pokémon Showdown RBY Bugs](https://www.smogon.com/forums/posts/5933177/show)

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_OPTIONS: usize = 9; // move 1..4, switch 2..6
+pub const MAX_CHOICES: 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_OPTIONS.
+/// At least as large as MAX_CHOICES.
 pub const MAX_LOGS: usize = 180;
 
 /// The maximum number of bytes possibly logged by a single Generation I update.
-pub const OPTIONS_SIZE = if (builtin.mode == .ReleaseSmall)
-    MAX_OPTIONS
+pub const CHOICES_SIZE = if (builtin.mode == .ReleaseSmall)
+    MAX_CHOICES
 else
-    std.math.ceilPowerOfTwo(usize, MAX_OPTIONS) catch unreachable;
+    std.math.ceilPowerOfTwo(usize, MAX_CHOICES) 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)
@@ -76,7 +76,7 @@ pub fn Battle(comptime RNG: anytype) type {
         }
 
         /// Returns the result of applying Player 1's choice `c1` and Player 2's choice `c2` to the
-        /// battle, optionally writing protocol logs to `log` if `options.trace` is enabled.
+        /// battle, optionally writing protocol message logs to `log` if `options.log` is enabled.
         pub fn update(self: *Self, c1: Choice, c2: Choice, log: anytype) !Result {
             return mechanics.update(self, c1, c2, log);
         }

package/src/lib/gen1/helpers.zig

@@ -211,20 +211,19 @@ pub const Pokemon = struct {
     }
 };
 
-// cat src/test/showdown/blocklist.json | jq '."1".moves'
+// TODO: uncomment once integration tests pass
+// fn blocked(m: Move) bool {
+//     // Binding moves are borked but only via Mirror Move / Metronome which are already blocked
+//     return switch (m) {
+//         .Mimic, .Metronome, .MirrorMove, .Transform => true,
+//         else => false,
+//     };
+// }
+
 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,
-        => true,
+        .Counter, .Mimic, .Bide, .Metronome, .MirrorMove, .Transform => true,
         else => false,
     };
 }