@pkmn/engine 0.1.0-dev.84cc1a02 → 0.1.0-dev.93b7cb0d

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -58,6 +58,7 @@ fn inspect(value: anytype) void {
58
58
  @compileError(err);
59
59
  },
60
60
  },
61
+ .Optional => stderr.print("{?}", .{value}) catch return,
61
62
  else => stderr.print("{}", .{value}) catch return,
62
63
  }
63
64
  }
@@ -3,7 +3,7 @@ const root = @import("root");
3
3
 
4
4
  pub const Options = struct {
5
5
  showdown: ?bool = null,
6
- trace: ?bool = null,
6
+ log: ?bool = null,
7
7
  advance: ?bool = null,
8
8
  ebc: ?bool = null,
9
9
  internal: ?bool = null,
@@ -11,8 +11,8 @@ pub const Options = struct {
11
11
 
12
12
  /// Whether or not Pokémon Showdown compatibility mode is enabled.
13
13
  pub const showdown = get("showdown", false);
14
- /// Whether or not protocol trace logging is enabled.
15
- pub const trace = get("trace", false);
14
+ /// Whether or not protocol message logging is enabled.
15
+ pub const log = get("log", false);
16
16
 
17
17
  pub const advance = get("advance", true);
18
18
  pub const ebc = get("ebc", true);
@@ -7,7 +7,7 @@ const options = @import("./options.zig");
7
7
  const assert = std.debug.assert;
8
8
  const print = std.debug.print;
9
9
 
10
- const trace = options.trace;
10
+ const enabled = options.log;
11
11
 
12
12
  const Player = data.Player;
13
13
  const ID = data.ID;
@@ -230,7 +230,7 @@ pub fn Log(comptime Writer: type) type {
230
230
  pub const Error = Writer.Error;
231
231
 
232
232
  pub fn move(self: Self, source: ID, m: anytype, target: ID, from: anytype) Error!void {
233
- if (!trace) return;
233
+ if (!enabled) return;
234
234
  assert(m != .None);
235
235
  try self.writer.writeAll(&.{
236
236
  @enumToInt(ArgType.Move),
@@ -253,7 +253,7 @@ pub fn Log(comptime Writer: type) type {
253
253
  }
254
254
 
255
255
  pub fn switched(self: Self, ident: ID, pokemon: anytype) Error!void {
256
- if (!trace) return;
256
+ if (!enabled) return;
257
257
  try self.writer.writeAll(&.{ @enumToInt(ArgType.Switch), @bitCast(u8, ident) });
258
258
  try self.writer.writeAll(&.{ @enumToInt(pokemon.species), pokemon.level });
259
259
  try self.writer.writeIntNative(u16, pokemon.hp);
@@ -262,7 +262,7 @@ pub fn Log(comptime Writer: type) type {
262
262
  }
263
263
 
264
264
  pub fn cant(self: Self, ident: ID, reason: Cant) Error!void {
265
- if (!trace) return;
265
+ if (!enabled) return;
266
266
  assert(reason != .Disable);
267
267
  try self.writer.writeAll(&.{
268
268
  @enumToInt(ArgType.Cant),
@@ -272,7 +272,7 @@ pub fn Log(comptime Writer: type) type {
272
272
  }
273
273
 
274
274
  pub fn disabled(self: Self, ident: ID, m: anytype) Error!void {
275
- if (!trace) return;
275
+ if (!enabled) return;
276
276
  try self.writer.writeAll(&.{
277
277
  @enumToInt(ArgType.Cant),
278
278
  @bitCast(u8, ident),
@@ -282,20 +282,20 @@ pub fn Log(comptime Writer: type) type {
282
282
  }
283
283
 
284
284
  pub fn faint(self: Self, ident: ID, done: bool) Error!void {
285
- if (!trace) return;
285
+ if (!enabled) return;
286
286
  try self.writer.writeAll(&.{ @enumToInt(ArgType.Faint), @bitCast(u8, ident) });
287
287
  if (done) try self.writer.writeByte(@enumToInt(ArgType.None));
288
288
  }
289
289
 
290
290
  pub fn turn(self: Self, num: u16) Error!void {
291
- if (!trace) return;
291
+ if (!enabled) return;
292
292
  try self.writer.writeByte(@enumToInt(ArgType.Turn));
293
293
  try self.writer.writeIntNative(u16, num);
294
294
  try self.writer.writeByte(@enumToInt(ArgType.None));
295
295
  }
296
296
 
297
297
  pub fn win(self: Self, player: Player) Error!void {
298
- if (!trace) return;
298
+ if (!enabled) return;
299
299
  try self.writer.writeAll(&.{
300
300
  @enumToInt(ArgType.Win),
301
301
  @enumToInt(player),
@@ -304,12 +304,12 @@ pub fn Log(comptime Writer: type) type {
304
304
  }
305
305
 
306
306
  pub fn tie(self: Self) Error!void {
307
- if (!trace) return;
307
+ if (!enabled) return;
308
308
  try self.writer.writeAll(&.{ @enumToInt(ArgType.Tie), @enumToInt(ArgType.None) });
309
309
  }
310
310
 
311
311
  pub fn damage(self: Self, ident: ID, pokemon: anytype, reason: Damage) Error!void {
312
- if (!trace) return;
312
+ if (!enabled) return;
313
313
  assert(@enumToInt(reason) <= @enumToInt(Damage.LeechSeed));
314
314
  try self.writer.writeAll(&.{ @enumToInt(ArgType.Damage), @bitCast(u8, ident) });
315
315
  try self.writer.writeIntNative(u16, pokemon.hp);
@@ -324,7 +324,7 @@ pub fn Log(comptime Writer: type) type {
324
324
  reason: Damage,
325
325
  source: ID,
326
326
  ) Error!void {
327
- if (!trace) return;
327
+ if (!enabled) return;
328
328
  assert(@enumToInt(reason) == @enumToInt(Damage.RecoilOf));
329
329
  try self.writer.writeAll(&.{ @enumToInt(ArgType.Damage), @bitCast(u8, ident) });
330
330
  try self.writer.writeIntNative(u16, pokemon.hp);
@@ -337,7 +337,7 @@ pub fn Log(comptime Writer: type) type {
337
337
  }
338
338
 
339
339
  pub fn heal(self: Self, ident: ID, pokemon: anytype, reason: Heal) Error!void {
340
- if (!trace) return;
340
+ if (!enabled) return;
341
341
  assert(reason != .Drain);
342
342
  try self.writer.writeAll(&.{ @enumToInt(ArgType.Heal), @bitCast(u8, ident) });
343
343
  try self.writer.writeIntNative(u16, pokemon.hp);
@@ -346,7 +346,7 @@ pub fn Log(comptime Writer: type) type {
346
346
  }
347
347
 
348
348
  pub fn drain(self: Self, source: ID, pokemon: anytype, target: ID) Error!void {
349
- if (!trace) return;
349
+ if (!enabled) return;
350
350
  try self.writer.writeAll(&.{ @enumToInt(ArgType.Heal), @bitCast(u8, source) });
351
351
  try self.writer.writeIntNative(u16, pokemon.hp);
352
352
  try self.writer.writeIntNative(u16, pokemon.stats.hp);
@@ -358,7 +358,7 @@ pub fn Log(comptime Writer: type) type {
358
358
  }
359
359
 
360
360
  pub fn status(self: Self, ident: ID, value: u8, reason: Status) Error!void {
361
- if (!trace) return;
361
+ if (!enabled) return;
362
362
  assert(reason != .From);
363
363
  try self.writer.writeAll(&.{
364
364
  @enumToInt(ArgType.Status),
@@ -369,7 +369,7 @@ pub fn Log(comptime Writer: type) type {
369
369
  }
370
370
 
371
371
  pub fn statusFrom(self: Self, ident: ID, value: u8, m: anytype) Error!void {
372
- if (!trace) return;
372
+ if (!enabled) return;
373
373
  try self.writer.writeAll(&.{
374
374
  @enumToInt(ArgType.Status),
375
375
  @bitCast(u8, ident),
@@ -380,7 +380,7 @@ pub fn Log(comptime Writer: type) type {
380
380
  }
381
381
 
382
382
  pub fn curestatus(self: Self, ident: ID, value: u8, reason: CureStatus) Error!void {
383
- if (!trace) return;
383
+ if (!enabled) return;
384
384
  try self.writer.writeAll(&.{
385
385
  @enumToInt(ArgType.CureStatus),
386
386
  @bitCast(u8, ident),
@@ -390,7 +390,7 @@ pub fn Log(comptime Writer: type) type {
390
390
  }
391
391
 
392
392
  pub fn boost(self: Self, ident: ID, reason: Boost, num: i8) Error!void {
393
- if (!trace) return;
393
+ if (!enabled) return;
394
394
  assert(num != 0 and (reason != .Rage or num > 0));
395
395
  try self.writer.writeAll(&.{
396
396
  @enumToInt(ArgType.Boost),
@@ -401,12 +401,12 @@ pub fn Log(comptime Writer: type) type {
401
401
  }
402
402
 
403
403
  pub fn clearallboost(self: Self) Error!void {
404
- if (!trace) return;
404
+ if (!enabled) return;
405
405
  try self.writer.writeAll(&.{@enumToInt(ArgType.ClearAllBoost)});
406
406
  }
407
407
 
408
408
  pub fn fail(self: Self, ident: ID, reason: Fail) Error!void {
409
- if (!trace) return;
409
+ if (!enabled) return;
410
410
  try self.writer.writeAll(&.{
411
411
  @enumToInt(ArgType.Fail),
412
412
  @bitCast(u8, ident),
@@ -415,17 +415,17 @@ pub fn Log(comptime Writer: type) type {
415
415
  }
416
416
 
417
417
  pub fn miss(self: Self, source: ID) Error!void {
418
- if (!trace) return;
418
+ if (!enabled) return;
419
419
  try self.writer.writeAll(&.{ @enumToInt(ArgType.Miss), @bitCast(u8, source) });
420
420
  }
421
421
 
422
422
  pub fn hitcount(self: Self, ident: ID, num: u8) Error!void {
423
- if (!trace) return;
423
+ if (!enabled) return;
424
424
  try self.writer.writeAll(&.{ @enumToInt(ArgType.HitCount), @bitCast(u8, ident), num });
425
425
  }
426
426
 
427
427
  pub fn prepare(self: Self, source: ID, m: anytype) Error!void {
428
- if (!trace) return;
428
+ if (!enabled) return;
429
429
  try self.writer.writeAll(&.{
430
430
  @enumToInt(ArgType.Prepare),
431
431
  @bitCast(u8, source),
@@ -434,12 +434,12 @@ pub fn Log(comptime Writer: type) type {
434
434
  }
435
435
 
436
436
  pub fn mustrecharge(self: Self, ident: ID) Error!void {
437
- if (!trace) return;
437
+ if (!enabled) return;
438
438
  try self.writer.writeAll(&.{ @enumToInt(ArgType.MustRecharge), @bitCast(u8, ident) });
439
439
  }
440
440
 
441
441
  pub fn activate(self: Self, ident: ID, reason: Activate) Error!void {
442
- if (!trace) return;
442
+ if (!enabled) return;
443
443
  try self.writer.writeAll(&.{
444
444
  @enumToInt(ArgType.Activate),
445
445
  @bitCast(u8, ident),
@@ -448,12 +448,12 @@ pub fn Log(comptime Writer: type) type {
448
448
  }
449
449
 
450
450
  pub fn fieldactivate(self: Self) Error!void {
451
- if (!trace) return;
451
+ if (!enabled) return;
452
452
  try self.writer.writeAll(&.{@enumToInt(ArgType.FieldActivate)});
453
453
  }
454
454
 
455
455
  pub fn start(self: Self, ident: ID, reason: Start) Error!void {
456
- if (!trace) return;
456
+ if (!enabled) return;
457
457
  assert(@enumToInt(reason) < @enumToInt(Start.TypeChange));
458
458
  try self.writer.writeAll(&.{
459
459
  @enumToInt(ArgType.Start),
@@ -463,7 +463,7 @@ pub fn Log(comptime Writer: type) type {
463
463
  }
464
464
 
465
465
  pub fn typechange(self: Self, source: ID, types: anytype, target: ID) Error!void {
466
- if (!trace) return;
466
+ if (!enabled) return;
467
467
  try self.writer.writeAll(&.{
468
468
  @enumToInt(ArgType.Start),
469
469
  @bitCast(u8, source),
@@ -474,7 +474,7 @@ pub fn Log(comptime Writer: type) type {
474
474
  }
475
475
 
476
476
  pub fn startEffect(self: Self, ident: ID, reason: Start, m: anytype) Error!void {
477
- if (!trace) return;
477
+ if (!enabled) return;
478
478
  assert(@enumToInt(reason) > @enumToInt(Start.TypeChange));
479
479
  try self.writer.writeAll(&.{
480
480
  @enumToInt(ArgType.Start),
@@ -485,7 +485,7 @@ pub fn Log(comptime Writer: type) type {
485
485
  }
486
486
 
487
487
  pub fn end(self: Self, ident: ID, reason: End) Error!void {
488
- if (!trace) return;
488
+ if (!enabled) return;
489
489
  try self.writer.writeAll(&.{
490
490
  @enumToInt(ArgType.End),
491
491
  @bitCast(u8, ident),
@@ -494,27 +494,27 @@ pub fn Log(comptime Writer: type) type {
494
494
  }
495
495
 
496
496
  pub fn ohko(self: Self) Error!void {
497
- if (!trace) return;
497
+ if (!enabled) return;
498
498
  try self.writer.writeAll(&.{@enumToInt(ArgType.OHKO)});
499
499
  }
500
500
 
501
501
  pub fn crit(self: Self, ident: ID) Error!void {
502
- if (!trace) return;
502
+ if (!enabled) return;
503
503
  try self.writer.writeAll(&.{ @enumToInt(ArgType.Crit), @bitCast(u8, ident) });
504
504
  }
505
505
 
506
506
  pub fn supereffective(self: Self, ident: ID) Error!void {
507
- if (!trace) return;
507
+ if (!enabled) return;
508
508
  try self.writer.writeAll(&.{ @enumToInt(ArgType.SuperEffective), @bitCast(u8, ident) });
509
509
  }
510
510
 
511
511
  pub fn resisted(self: Self, ident: ID) Error!void {
512
- if (!trace) return;
512
+ if (!enabled) return;
513
513
  try self.writer.writeAll(&.{ @enumToInt(ArgType.Resisted), @bitCast(u8, ident) });
514
514
  }
515
515
 
516
516
  pub fn immune(self: Self, ident: ID, reason: Immune) Error!void {
517
- if (!trace) return;
517
+ if (!enabled) return;
518
518
  try self.writer.writeAll(&.{
519
519
  @enumToInt(ArgType.Immune),
520
520
  @bitCast(u8, ident),
@@ -523,7 +523,7 @@ pub fn Log(comptime Writer: type) type {
523
523
  }
524
524
 
525
525
  pub fn transform(self: Self, source: ID, target: ID) Error!void {
526
- if (!trace) return;
526
+ if (!enabled) return;
527
527
  try self.writer.writeAll(&.{
528
528
  @enumToInt(ArgType.Transform),
529
529
  @bitCast(u8, source),
@@ -532,12 +532,12 @@ pub fn Log(comptime Writer: type) type {
532
532
  }
533
533
 
534
534
  pub fn laststill(self: Self) Error!void {
535
- if (!trace) return;
535
+ if (!enabled) return;
536
536
  try self.writer.writeAll(&.{@enumToInt(ArgType.LastStill)});
537
537
  }
538
538
 
539
539
  pub fn lastmiss(self: Self) Error!void {
540
- if (!trace) return;
540
+ if (!enabled) return;
541
541
  try self.writer.writeAll(&.{@enumToInt(ArgType.LastMiss)});
542
542
  }
543
543
  };
@@ -838,7 +838,7 @@ pub fn expectLog(
838
838
  actual: []const u8,
839
839
  offset: usize,
840
840
  ) !void {
841
- if (!trace) return;
841
+ if (!enabled) return;
842
842
  const color = color: {
843
843
  if (std.process.hasEnvVarConstant("ZIG_DEBUG_COLOR")) {
844
844
  break :color true;
@@ -28,35 +28,36 @@ list of additional reference [**resources**](#resources).
28
28
 
29
29
  The following information is required to simulate a Generation I Pokémon battle:
30
30
 
31
- | pkmn | Pokémon Red (pret) | Pokémon Showdown |
32
- | ------------------------------------ | ---------------------------------- | -------------------------------------- |
33
- | `battle.seed` | `Random{Add,Sub}` | `battle.seed` |
34
- | `battle.turn` | - | `battle.turn` |
35
- | `battle.last_damage` | `Damage` | `battle.lastDamage` |
36
- | `side.{active,pokemon}` | `PlayerMonNumber`/`BattleMon` | `side.active` |
37
- | `side.team` | `PartyMons` | `side.pokemon` |
38
- | `side.last_used_move` | `PlayerUsedMove` | `pokemon.lastMove` |
39
- | `side.last_selected_move` | `PlayerSelectedMove` | `side.lastSelectedMove` |
40
- | `battle.last_selected_indexes` | `PlayerMoveListIndex` | `side.lastMove` |
41
- | `side.order` | - | `pokemon.position` |
42
- | `{pokemon,active}.moves` | `{party,battle}_struct.{Moves,PP}` | `pokemon.{baseMoveSlots,moveSlots}` |
43
- | `pokemon.hp` | `{party,battle}_struct.HP` | `pokemon.hp` |
44
- | `{pokemon,active}.status` | `{party,battle}_struct.Status` | `pokemon.status` |
45
- | `{pokemon,active}.level` | `PlayerMonUnmodifiedLevel` | `pokemon.level` |
46
- | `pokemon.species` | `party_struct.Species` | `pokemon.baseSpecies` |
47
- | `pokemon.stats` | `box_struct.Stats` | `pokemon.baseStoredStats` |
48
- | `active.stats` | `battle_struct.Stats` | `pokemon.modifiedStats` |
49
- | `volatiles.transform` | `PlayerMonUnmodified*` | `pokemon.storedStats` |
50
- | `active.species` | `battle_struct.Species` | `pokemon.species` |
51
- | `{pokemon,active}.types` | `{party,battle}_struct.Type` | `pokemon.types` |
52
- | `active.boosts` | `PlayerMon*Mod` | `pokemon.boosts` |
53
- | `active.volatiles` | `PlayerBattleStatus{1,2,3}` | `pokemon.volatiles` |
54
- | `volatiles.state` | `PlayerBideAccumulatedDamage` | `volatiles.bide.totalDamage` |
55
- | `volatiles.attacks` | `PlayerNumAttacksLeft` | `volatiles.{bide,lockedmove}.duration` |
56
- | `volatiles.confusion` | `PlayerConfusedCounter` | `volatiles.confusion.duration` |
57
- | `volatiles.toxic` | `PlayerToxicCounter` | `volatiles.residualdmg.counter` |
58
- | `volatiles.substitute` | `PlayerSubstituteHP` | `volatiles.substitute.hp` |
59
- | `volatiles.disabled_{move,duration}` | `PlayerDisabledMove{,Number}` | `volatiles.disable.{move,time}` |
31
+ | pkmn | Pokémon Red (pret) | Pokémon Showdown |
32
+ | --------------------------------------- | ---------------------------------- | -------------------------------------- |
33
+ | `battle.seed` | `Random{Add,Sub}` | `battle.seed` |
34
+ | `battle.turn` | - | `battle.turn` |
35
+ | `battle.last_damage` | `Damage` | `battle.lastDamage` |
36
+ | `side.{active,pokemon}` | `PlayerMonNumber`/`BattleMon` | `side.active` |
37
+ | `side.team` | `PartyMons` | `side.pokemon` |
38
+ | `side.last_used_move` | `PlayerUsedMove` | `pokemon.lastMove` |
39
+ | `side.last_selected_move` | `PlayerSelectedMove` | `side.lastSelectedMove` |
40
+ | `battle.last_moves.{p1,p2}_index` | `PlayerMoveListIndex` | - |
41
+ | `battle.last_moves.{p1,p2}_counterable` | - | `side.lastMove` |
42
+ | `side.order` | - | `pokemon.position` |
43
+ | `{pokemon,active}.moves` | `{party,battle}_struct.{Moves,PP}` | `pokemon.{baseMoveSlots,moveSlots}` |
44
+ | `pokemon.hp` | `{party,battle}_struct.HP` | `pokemon.hp` |
45
+ | `{pokemon,active}.status` | `{party,battle}_struct.Status` | `pokemon.status` |
46
+ | `{pokemon,active}.level` | `PlayerMonUnmodifiedLevel` | `pokemon.level` |
47
+ | `pokemon.species` | `party_struct.Species` | `pokemon.baseSpecies` |
48
+ | `pokemon.stats` | `box_struct.Stats` | `pokemon.baseStoredStats` |
49
+ | `active.stats` | `battle_struct.Stats` | `pokemon.modifiedStats` |
50
+ | `volatiles.transform` | `PlayerMonUnmodified*` | `pokemon.storedStats` |
51
+ | `active.species` | `battle_struct.Species` | `pokemon.species` |
52
+ | `{pokemon,active}.types` | `{party,battle}_struct.Type` | `pokemon.types` |
53
+ | `active.boosts` | `PlayerMon*Mod` | `pokemon.boosts` |
54
+ | `active.volatiles` | `PlayerBattleStatus{1,2,3}` | `pokemon.volatiles` |
55
+ | `volatiles.state` | `PlayerBideAccumulatedDamage` | `volatiles.bide.totalDamage` |
56
+ | `volatiles.attacks` | `PlayerNumAttacksLeft` | `volatiles.{bide,lockedmove}.duration` |
57
+ | `volatiles.confusion` | `PlayerConfusedCounter` | `volatiles.confusion.duration` |
58
+ | `volatiles.toxic` | `PlayerToxicCounter` | `volatiles.residualdmg.counter` |
59
+ | `volatiles.substitute` | `PlayerSubstituteHP` | `volatiles.substitute.hp` |
60
+ | `volatiles.disabled_{move,duration}` | `PlayerDisabledMove{,Number}` | `volatiles.disable.{move,time}` |
60
61
 
61
62
  - Pokémon Showdown [does not implement the correct Generation I RNG](#rng) and as such its `seed` is
62
63
  different
@@ -68,6 +69,9 @@ The following information is required to simulate a Generation I Pokémon battle
68
69
  Counter and is not set and cleared in the correct locations. `Pokemon.lastMove` matches
69
70
  `PlayerUsedMove` more often so is what the engine attempts to model, despite the implications for
70
71
  Counter)
72
+ - `battle.last_moves` doesn't map precisely to cartridge concepts because it is used to track desyncs
73
+ which instead are represented on the cartridge as discrepancies between the two separate battle states
74
+ that exist in the link battle.
71
75
  - Pokémon Showdown does not implement the [partial-trapping move Mirror Move
72
76
  glitch](https://glitchcity.wiki/Partial_trapping_move_Mirror_Move_link_battle_glitch) and as such
73
77
  does not need to keep track of a player's last selected move index (`PlayerMoveListIndex`)
@@ -98,8 +102,8 @@ The following information is required to simulate a Generation I Pokémon battle
98
102
  store general information about the battle. Unlike in Pokémon Showdown there is a distinction
99
103
  between the data structure for the "active" Pokémon and its party members (see below).
100
104
 
101
- Due to layout constraints, the index of the last selected move for a side is stored in what would
102
- otherwise be the padding bytes of`Battle` (the `last_selected_indexes` field) instead of in `Side`.
105
+ Due to layout constraints, details about the last moves for a side are stored in what would
106
+ otherwise be the padding bytes of`Battle` (the `last_moves` field) instead of in `Side`.
103
107
 
104
108
  ### `Pokemon` / `ActivePokemon`
105
109
 
@@ -198,7 +202,7 @@ above, PP information isn't strictly necessary in Generation I so is dropped. `M
198
202
  a special sentinel value to indicate `null`. Move PP data is only included for testing and is not
199
203
  necessary for the actual engine implementation.
200
204
 
201
- In order to workaround various [Pokémon Showdown bugs](#bugs) and to support its protocol in traces,
205
+ In order to workaround various [Pokémon Showdown bugs](#bugs) and to support its protocol in logs,
202
206
  additional information is stored in `Move.Data` (`targets`) about what Pokémon Showdown believes the
203
207
  `Move.Target` to be (despite the concept of targeting not existing until Generation III when Double
204
208
  battles were introduced). More specifically, a move's "targeting" status is required in various
@@ -331,28 +335,33 @@ does not produce an equivalent to Pokémon Showdown's `|request|` protocol messa
331
335
  must be gleaned through the `Battle` state). Useful size and offset information can be found in
332
336
  the [`layout.json`](../../data/layout.json) which exists to simplify writing driver code.
333
337
 
334
- Documentation of the wire protocol used for logging traces when `-Dtrace` is enabled can be found in
335
- [PROTOCOL.md](../../../docs/PROTOCOL.md).
338
+ Documentation of the wire protocol used for protocol message logging when `-Dlog` is enabled can be
339
+ found in [PROTOCOL.md](../../../docs/PROTOCOL.md). Note that the
340
+ [`pkmn-debug`](../../../README.md#pkmn-debug) tool exists to display the binary protocol and battle
341
+ data in the browser for ease of debugging.
336
342
 
337
343
  ### `Battle`
338
344
 
339
- | Start | End | Data | Description |
340
- | ------- | ------- | ----------------------- | ------------------------------------------------------- |
341
- | 0 | 184 | [`sides[0]`](#side) | Player 1's side |
342
- | 184 | 368 | [`sides[1]`](#side) | Player 2's side |
343
- | 368 | 370 | `turn` | The current turn number |
344
- | 370 | 372 | `last_damage` | The last damage dealt by either side |
345
- | 372 | 373-376 | `last_selected_indexes` | The slot index of the last selected moves for each side |
346
- | 373-376 | 384 | `rng` | The RNG state |
345
+ | Start | End | Data | Description |
346
+ | ------- | ------- | ------------------- | ------------------------------------------------------- |
347
+ | 0 | 184 | [`sides[0]`](#side) | Player 1's side |
348
+ | 184 | 368 | [`sides[1]`](#side) | Player 2's side |
349
+ | 368 | 370 | `turn` | The current turn number |
350
+ | 370 | 372 | `last_damage` | The last damage dealt by either side |
351
+ | 372 | 373-376 | `last_moves` | The slot index of the last selected moves for each side |
352
+ | 373-376 | 384 | `rng` | The RNG state |
347
353
 
348
354
  - the current `turn` is 2 bytes, written in native-endianness
349
- - `last_selected_indexes` layout depends on whether or not Pokémon Showdown compatibility mode is
350
- enabled (`-Dshowdown`). In either case it stores a move "slot", where 0 is used as an empty value and
351
- 1-4 represent actual moves:
352
- - if `showdown` is enabled bytes 372 and 373 are used to store the last selected move index of
353
- `side[0]` and bytes 374 and 375 store the last selected move index of `side[1]`
354
- - otherwise byte 372 stores the last selected move index of `side[0]` in its first 4 bits and
355
- `side[1]`'s in its second 4 bits
355
+ - `last_moves` layout depends on whether or not Pokémon Showdown compatibility mode is enabled
356
+ (`-Dshowdown`). In either case it stores the last selected move index and last executed move for
357
+ each player (required to detect desyncs). In the case of the move index, 0 is used as an empty
358
+ value and 1-4 represent actual moves:
359
+ - if `showdown` is enabled byte 372 is used to store the last selected move index of `side[0]` and
360
+ byte 373 is used to store whether or not the side's last executed move would have been considered
361
+ "counterable"; and bytes 374 and 375 store the same information for `side[1]`
362
+ - otherwise the first 3 bits of byte 372 stores the last selected move index of `side[0]` and the
363
+ next bit stores whether that side's last executed move would have been considered "counterable",
364
+ with the same information for `side[1]`'s being stored in the second 4 bits
356
365
  - the `rng` depends on whether or not Pokémon Showdown compatibility mode is enabled (`-Dshowdown`):
357
366
  - if `showdown` is enabled, the RNG state begins on byte 376 and consists of a 64-bit seed,
358
367
  written in native-endianness
@@ -476,26 +485,38 @@ Smogon](https://www.smogon.com/forums/posts/5933177/show):
476
485
  - Confusion self-hits use the wrong damage formula resulting in off-by-one errors (and also fail to
477
486
  account for an opponent's Reflect). Furthermore, the confusion self-hit damage will erroneously be
478
487
  inflicted to the confused user's substitute if the confused user had been attempting to use a
479
- self-targeting move.
488
+ self-targeting move. Finally, Pokémon Showdown erroneously considers the *uncapped* self-hit
489
+ damage for the purposes of tracking the battle's last damage.
480
490
 
481
491
  Beyond the general bugs listed above, several move effects are implemented incorrectly by Pokémon
482
492
  Showdown. Some of these moves are [too fundamentally broken to be implemented](#unimplementable) by
483
493
  the pkmn engine, but the following moves have their broken behavior preserved in `-Dshowdown` mode:
484
494
 
485
- - **Bide**: If the opponent faints after Bide inflicts damage on Pokémon Showdown residual damage
486
- incorrectly still gets applied to Bide's user.
495
+ - **Bide**: Bide's damage can overflow if OHKO moves are involved because OHKO moves work by setting
496
+ the damage to 65535 - Pokémon Showdown doesn't implement this overflow and instead lets Bide's
497
+ damage grow unbounded. Additionally, if the opponent faints after Bide inflicts damage on Pokémon
498
+ Showdown residual damage incorrectly still gets applied to Bide's user.
499
+ - **Counter**: On Pokémon Showdown choices made while sleeping (which should not have been
500
+ registered) can erroneously cause Counter to trigger Desync Clause Mod behavior.
487
501
  - **Leech Seed**: Leech Seed fails to heal its source side if a seeded target faints due to
488
- recoil/crash damage on Pokémon Showdown. Pokémon Showdown also updates the battle's last damage
489
- field with the uncapped Leech Seed damage which has consequences for Bide and Counter.
502
+ recoil/crash damage on Pokémon Showdown.
490
503
  - **Pay Day**: Pay Day should still scatter coins if it hits (but doesn't break) and opponent's
491
504
  Substitute but doesn't on Pokémon Showdown.
492
505
  - **Flinch**: Flinching does not get cleared during move selection on Pokémon Showdown and is
493
506
  instead cleared in Pokémon Showdown's "residual" phase, meaning the flinch status gets erroneously
494
507
  preserved across fainting (as fainting triggers Pokémon Showdown's "instaswitch" behavior which
495
508
  skips end-of-turn residuals).
509
+ - **Rage**: Rage boosts should still result in burn/paralysis [stat modification
510
+ errors](https://pkmn.cc/bulba-glitch-1#Stat_modification_errors) but don't on Pokémon Showdown.
511
+ Furthermore, Pokémon Showdown only builds Rage for Disable/Explosion (hit/miss) when attacking
512
+ into a Substitute instead of all moves. Pokémon Showdown also implements the [Rage and Thrash /
513
+ Petal Dance accuracy bug]( https://www.youtube.com/watch?v=NC5gbJeExbs) incorrectly, as the
514
+ accuracy only gets written when the volatile is present which can lead to incorrect accuracy
515
+ values on turns where Rage is used on the same turn as a move which modifies accuracy or evasion.
496
516
  - **Thrash** / **Petal Dance**: once a Pokémon is locked into a thrashing move they will lose all
497
517
  speed ties on Pokémon Showdown (due to the fact that if they win the speed tie their action will
498
- then get "changed" and inserted back into the queue after their opponent's action).
518
+ then get "changed" and inserted back into the queue after their opponent's action). Pokémon
519
+ Showdown also implements accuracy incorrectly, as covered above.
499
520
  - **Freeze** / **Sleep**: Pokémon Showdown requires a move to be selected when a Pokémon is frozen
500
521
  or sleeping and uses that in the event that the status is removed while on the cartridge no
501
522
  selection is possible and no turn exists for the thawed/woken Pokémon to act except in the case of
@@ -519,8 +540,13 @@ the pkmn engine, but the following moves have their broken behavior preserved in
519
540
  glitch](https://glitchcity.wiki/Substitute_%C2%BC_HP_glitch) also fails in many cases due to
520
541
  Pokémon Showdown implementing the health check based on floating point division instead of integer
521
542
  divison like on the cartridge (meaning the Substitute 1/4 glitch will only occur if the Pokémon's
522
- maximum HP is evenly divisible by 4). Finally, Substitute also incorrectly blocks Dream Eater on
523
- Pokémon Showdown.
543
+ maximum HP is evenly divisible by 4). Substitute also incorrectly blocks Dream Eater on
544
+ Pokémon Showdown and will incorrectly still heal 1 HP for any draining moves if the attack does 0
545
+ damage. Finally, Pokémon Showdown uses a `subFainted` field to track whether a Substitute was
546
+ broken in order to know when to nullify a move's effect, only it doesn't get cleared at the end of
547
+ the turn and can result in incorrect behavior on subsequent turns with the moves Mirror Move and
548
+ Metronome that invoke `runMove` (which is where `subFainted` gets cleared) on the user but skips
549
+ calling it for the eventual true target.
524
550
 
525
551
  In addition to numerous cases where Pokémon Showdown uses the wrong type of message (e.g. `|-fail`
526
552
  vs. `|-miss|` vs. `|-immune|`, e.g. in the case of Leech Seed) which are not documented here, Pokémon
@@ -590,9 +616,9 @@ the correct control flow):
590
616
  still gets a turn under the [trapping sleep
591
617
  glitch](https://glitchcity.wiki/Trapping_move_and_sleep_glitch), Wrap does 0 damage against
592
618
  Ghost-type Pokémon instead of properly respecting immunity, and binding effects are handled in the
593
- wrong order in the code.
594
- - **Counter**: On Pokémon Showdown choices made while sleeping (which should not have been
595
- registered) can erroneously cause Counter to trigger Desync Clause Mod behavior.
619
+ wrong order in the code which results in either out of order messaging or, more consequentially,
620
+ Pokémon using Rage/Bide or Thrashing/Charging moves being incorrectly forced to skip a turn when
621
+ the Pokémon using the Binding move switches.
596
622
  - **Mimic**: Pokémon Showdown checks that the user of Mimic has Mimic in one of their move slots,
597
623
  which means Mimic legally called via Metronome or Mirror Move will only work if the user also has
598
624
  Mimic (and the moved mimicked by Mimic called via Metronome / Mirror Move will erroneously
@@ -600,19 +626,27 @@ the correct control flow):
600
626
  because Pokémon Showdown deducts PP based on a move's name instead of slot, if Mimic copies a move
601
627
  the Pokémon already knows, PP deduction for using either the original move of the mimicked move
602
628
  will instead deduct PP for whichever appears at the lower move slot index and the PP will be
603
- allowed to go negative (effectively allowing for infinite PP use).
604
- - **Mirror Move**: Binding moves misbehave when used via Mirror Move (though Pokémon Showdown has
605
- its own weird behavior and does not implement the [partial trapping move Mirror Move
629
+ allowed to go negative (effectively allowing for infinite PP use). Pokémon Showdown also doesn't
630
+ deduct PP from using Transform if it was copied by Mimic.
631
+ - **Mirror Move**: As covered above, both Substitute and Binding moves misbehave when used via
632
+ Mirror Move (though Pokémon Showdown has its own weird behavior and does not implement the
633
+ [partial trapping move Mirror Move
606
634
  glitch](https://glitchcity.wiki/Partial_trapping_move_Mirror_Move_link_battle_glitch) that exists
607
- on the cartridge).
608
- - **Metronome**: In addition to the issues with binding moves, Metronome and Mirror Move cannot
609
- mutually call each other more than 3 times in a row without causing the Pokémon Showdown simulator
610
- to crash due to defensive safety checks that do not exist on the cartridge.
611
- - **Transform**: Transform screws up the effect of Disable, because on Pokémon Showdown, Disable
635
+ on the cartridge). Additionally, Pokémon Showdown sets the last used move every turn a Pokémon is
636
+ Thrashing instead of just on the turn it is actually selected meaning Mirror Move will sometimes
637
+ successfully mirror a Thrashing move when it should fail. Finally, if Mirror Move copies
638
+ Struggle it should not deduct PP but on Pokémon Showdown it does.
639
+ - **Metronome**: In addition to the issues with binding moves and Substitute, Metronome and Mirror
640
+ Move cannot mutually call each other more than 3 times in a row without causing the Pokémon
641
+ Showdown simulator to crash due to defensive safety checks that do not exist on the cartridge.
642
+ - **Transform**: Transform screws up the effect of Disable, because on Pokémon Showdown, Disable
612
643
  prevents moves of a given *name* from being used (e.g. "Water Gun") as opposed to moves in a
613
644
  specific *slot* (e.g. the 2nd move slot), and a Pokémon's moves can change after Transform (this
614
- is not an issue with Disable + Mimic because Mimic happens to replace the same slot). Furthermore,
615
- transforming and then using Mirror Move / Metronome can result in [glitchy behavior and
645
+ is not an issue with Disable + Mimic because Mimic happens to replace the same slot). Transform
646
+ also has a bad interaction with Pokémon Showdown's buggy Haze implementation, as Haze on Pokémon
647
+ Showdown does not copy unmodified stats, leaving the Transformed Pokémon with incorrect stats.
648
+ Furthermore, transforming and then using Mirror Move / Metronome can result in [glitchy behavior
649
+ and
616
650
  softlocks](https://pkmn.cc/bulba/Transform_glitches#Transform_.2B_Mirror_Move.2FMetronome_PP_error)
617
651
  which Pokémon Showdown does not implement.
618
652