@pkmn/engine 0.1.0-dev.47feedd9 → 0.1.0-dev.53335a32
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.
- package/README.md +22 -50
- package/build/pkg/data.d.ts +2 -1
- package/build/pkg/data.js +5 -3
- package/build/pkg/data.js.map +1 -1
- package/build/pkg/gen1.d.ts +3 -3
- package/build/pkg/gen1.js +13 -11
- package/build/pkg/gen1.js.map +1 -1
- package/build/pkg/index.d.ts +10 -11
- package/build/pkg/index.js.map +1 -1
- package/build.zig +34 -24
- package/package.json +29 -40
- package/src/bin/install-pkmn-engine +33 -60
- package/src/lib/binding/node.zig +5 -5
- package/src/lib/binding/wasm.zig +3 -3
- package/src/lib/common/debug.zig +0 -1
- package/src/lib/common/options.zig +3 -3
- package/src/lib/common/protocol.zig +38 -38
- package/src/lib/gen1/README.md +33 -48
- package/src/lib/gen1/data.zig +6 -6
- package/src/lib/gen1/helpers.zig +7 -10
- package/src/lib/gen1/mechanics.zig +283 -342
- package/src/lib/gen2/data.zig +4 -4
- package/src/lib/pkmn.zig +7 -7
- package/build/pkg/addon.d.ts +0 -7
- package/build/pkg/addon.js +0 -111
- package/build/pkg/addon.js.map +0 -1
- package/build/test/display.js +0 -396
- package/build/test/display.js.map +0 -1
- package/build/tools/debug.js +0 -133
- package/build/tools/debug.js.map +0 -1
- package/src/bin/pkmn-debug +0 -62
- package/src/test/display/pkmn.html.tmpl +0 -368
|
@@ -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
|
|
10
|
+
const trace = options.trace;
|
|
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 (!
|
|
233
|
+
if (!trace) 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 (!
|
|
256
|
+
if (!trace) 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 (!
|
|
265
|
+
if (!trace) 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 (!
|
|
275
|
+
if (!trace) 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 (!
|
|
285
|
+
if (!trace) 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 (!
|
|
291
|
+
if (!trace) 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 (!
|
|
298
|
+
if (!trace) 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 (!
|
|
307
|
+
if (!trace) 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 (!
|
|
312
|
+
if (!trace) 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 (!
|
|
327
|
+
if (!trace) 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 (!
|
|
340
|
+
if (!trace) 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 (!
|
|
349
|
+
if (!trace) 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 (!
|
|
361
|
+
if (!trace) 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 (!
|
|
372
|
+
if (!trace) 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 (!
|
|
383
|
+
if (!trace) 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 (!
|
|
393
|
+
if (!trace) 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 (!
|
|
404
|
+
if (!trace) 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 (!
|
|
409
|
+
if (!trace) 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 (!
|
|
418
|
+
if (!trace) 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 (!
|
|
423
|
+
if (!trace) 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 (!
|
|
428
|
+
if (!trace) 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 (!
|
|
437
|
+
if (!trace) 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 (!
|
|
442
|
+
if (!trace) 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 (!
|
|
451
|
+
if (!trace) 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 (!
|
|
456
|
+
if (!trace) 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 (!
|
|
466
|
+
if (!trace) 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 (!
|
|
477
|
+
if (!trace) 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 (!
|
|
488
|
+
if (!trace) 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 (!
|
|
497
|
+
if (!trace) 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 (!
|
|
502
|
+
if (!trace) 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 (!
|
|
507
|
+
if (!trace) 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 (!
|
|
512
|
+
if (!trace) 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 (!
|
|
517
|
+
if (!trace) 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 (!
|
|
526
|
+
if (!trace) 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 (!
|
|
535
|
+
if (!trace) 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 (!
|
|
540
|
+
if (!trace) 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 (!
|
|
841
|
+
if (!trace) return;
|
|
842
842
|
const color = color: {
|
|
843
843
|
if (std.process.hasEnvVarConstant("ZIG_DEBUG_COLOR")) {
|
|
844
844
|
break :color true;
|
package/src/lib/gen1/README.md
CHANGED
|
@@ -198,7 +198,7 @@ above, PP information isn't strictly necessary in Generation I so is dropped. `M
|
|
|
198
198
|
a special sentinel value to indicate `null`. Move PP data is only included for testing and is not
|
|
199
199
|
necessary for the actual engine implementation.
|
|
200
200
|
|
|
201
|
-
In order to workaround various [Pokémon Showdown bugs](#bugs) and to support its protocol in
|
|
201
|
+
In order to workaround various [Pokémon Showdown bugs](#bugs) and to support its protocol in traces,
|
|
202
202
|
additional information is stored in `Move.Data` (`targets`) about what Pokémon Showdown believes the
|
|
203
203
|
`Move.Target` to be (despite the concept of targeting not existing until Generation III when Double
|
|
204
204
|
battles were introduced). More specifically, a move's "targeting" status is required in various
|
|
@@ -331,10 +331,8 @@ does not produce an equivalent to Pokémon Showdown's `|request|` protocol messa
|
|
|
331
331
|
must be gleaned through the `Battle` state). Useful size and offset information can be found in
|
|
332
332
|
the [`layout.json`](../../data/layout.json) which exists to simplify writing driver code.
|
|
333
333
|
|
|
334
|
-
Documentation of the wire protocol used for
|
|
335
|
-
|
|
336
|
-
[`pkmn-debug`](../../../README.md#pkmn-debug) tool exists to display the binary protocol and battle
|
|
337
|
-
data in the browser for ease of debugging.
|
|
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
336
|
|
|
339
337
|
### `Battle`
|
|
340
338
|
|
|
@@ -469,7 +467,7 @@ data in the browser for ease of debugging.
|
|
|
469
467
|
|
|
470
468
|
In addition to its alternative [RNG semantics](#rng), Pokémon Showdown's implementation of the first
|
|
471
469
|
generation of Pokémon contains a number bugs, [many of which are known and have been documented on
|
|
472
|
-
Smogon](https://www.smogon.com/forums/
|
|
470
|
+
Smogon](https://www.smogon.com/forums/threads/rby-tradebacks-bug-report-thread.3524844/#post-5933177):
|
|
473
471
|
|
|
474
472
|
- moves on Pokémon Showdown can do 0 damage instead of failing or causing a [division-by-zero
|
|
475
473
|
freeze](https://pkmn.cc/bulba-glitch-1#Division_by_0).
|
|
@@ -478,8 +476,7 @@ Smogon](https://www.smogon.com/forums/posts/5933177/show):
|
|
|
478
476
|
- Confusion self-hits use the wrong damage formula resulting in off-by-one errors (and also fail to
|
|
479
477
|
account for an opponent's Reflect). Furthermore, the confusion self-hit damage will erroneously be
|
|
480
478
|
inflicted to the confused user's substitute if the confused user had been attempting to use a
|
|
481
|
-
self-targeting move.
|
|
482
|
-
damage for the purposes of tracking the battle's last damage.
|
|
479
|
+
self-targeting move.
|
|
483
480
|
|
|
484
481
|
Beyond the general bugs listed above, several move effects are implemented incorrectly by Pokémon
|
|
485
482
|
Showdown. Some of these moves are [too fundamentally broken to be implemented](#unimplementable) by
|
|
@@ -487,27 +484,18 @@ the pkmn engine, but the following moves have their broken behavior preserved in
|
|
|
487
484
|
|
|
488
485
|
- **Bide**: If the opponent faints after Bide inflicts damage on Pokémon Showdown residual damage
|
|
489
486
|
incorrectly still gets applied to Bide's user.
|
|
490
|
-
- **Counter**: On Pokémon Showdown choices made while sleeping (which should not have been
|
|
491
|
-
registered) can erroneously cause Counter to trigger Desync Clause Mod behavior.
|
|
492
487
|
- **Leech Seed**: Leech Seed fails to heal its source side if a seeded target faints due to
|
|
493
|
-
recoil/crash damage on Pokémon Showdown.
|
|
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.
|
|
494
490
|
- **Pay Day**: Pay Day should still scatter coins if it hits (but doesn't break) and opponent's
|
|
495
491
|
Substitute but doesn't on Pokémon Showdown.
|
|
496
492
|
- **Flinch**: Flinching does not get cleared during move selection on Pokémon Showdown and is
|
|
497
493
|
instead cleared in Pokémon Showdown's "residual" phase, meaning the flinch status gets erroneously
|
|
498
494
|
preserved across fainting (as fainting triggers Pokémon Showdown's "instaswitch" behavior which
|
|
499
495
|
skips end-of-turn residuals).
|
|
500
|
-
- **Rage**: Rage boosts should still result in burn/paralysis [stat modification
|
|
501
|
-
errors](https://pkmn.cc/bulba-glitch-1#Stat_modification_errors) but don't on Pokémon Showdown.
|
|
502
|
-
Furthermore, Pokémon Showdown only builds Rage for Disable/Explosion (hit/miss) when attacking
|
|
503
|
-
into a Substitute instead of all moves. Pokémon Showdown also implements the [Rage and Thrash /
|
|
504
|
-
Petal Dance accuracy bug]( https://www.youtube.com/watch?v=NC5gbJeExbs) incorrectly, as the
|
|
505
|
-
accuracy only gets written when the volatile is present which can lead to incorrect accuracy
|
|
506
|
-
values on turns where Rage is used on the same turn as a move which modifies accuracy or evasion.
|
|
507
496
|
- **Thrash** / **Petal Dance**: once a Pokémon is locked into a thrashing move they will lose all
|
|
508
497
|
speed ties on Pokémon Showdown (due to the fact that if they win the speed tie their action will
|
|
509
|
-
then get "changed" and inserted back into the queue after their opponent's action).
|
|
510
|
-
Showdown also implements accuracy incorrectly, as covered above.
|
|
498
|
+
then get "changed" and inserted back into the queue after their opponent's action).
|
|
511
499
|
- **Freeze** / **Sleep**: Pokémon Showdown requires a move to be selected when a Pokémon is frozen
|
|
512
500
|
or sleeping and uses that in the event that the status is removed while on the cartridge no
|
|
513
501
|
selection is possible and no turn exists for the thawed/woken Pokémon to act except in the case of
|
|
@@ -532,8 +520,7 @@ the pkmn engine, but the following moves have their broken behavior preserved in
|
|
|
532
520
|
Pokémon Showdown implementing the health check based on floating point division instead of integer
|
|
533
521
|
divison like on the cartridge (meaning the Substitute 1/4 glitch will only occur if the Pokémon's
|
|
534
522
|
maximum HP is evenly divisible by 4). Finally, Substitute also incorrectly blocks Dream Eater on
|
|
535
|
-
Pokémon Showdown
|
|
536
|
-
damage.
|
|
523
|
+
Pokémon Showdown.
|
|
537
524
|
|
|
538
525
|
In addition to numerous cases where Pokémon Showdown uses the wrong type of message (e.g. `|-fail`
|
|
539
526
|
vs. `|-miss|` vs. `|-immune|`, e.g. in the case of Leech Seed) which are not documented here, Pokémon
|
|
@@ -567,7 +554,7 @@ called out in the `|rule|` section at the beginning of a battle's log):
|
|
|
567
554
|
`|rule|` section** in Generation I (or II) as the actual order of switches here does not have
|
|
568
555
|
competitive implications like it does in Generation III, but it is still contrary to how the games
|
|
569
556
|
work where the [host (Player 1)'s Pokemon would switch
|
|
570
|
-
first](https://www.smogon.com/forums/
|
|
557
|
+
first](https://www.smogon.com/forums/threads/gen-3-on-ps-final-fixes.3527268/post-5989318).
|
|
571
558
|
|
|
572
559
|
Pokémon Showdown enforces several clauses *before* the battle: **Cleric Clause** (all Pokémon must
|
|
573
560
|
have full HP and PP, and not have any status conditions prior to the battle), **Stat Tradeback
|
|
@@ -588,12 +575,13 @@ left up to a client to support.
|
|
|
588
575
|
|
|
589
576
|
Numerous moves on Pokémon Showdown are broken not simply due to local issues in the implementation
|
|
590
577
|
of their effects but instead due to **global issues** related to fundamental mechanics such as
|
|
591
|
-
[broken move
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
the
|
|
578
|
+
[broken move
|
|
579
|
+
selection](https://www.smogon.com/forums/threads/rby-fight-button-simulation-improvements-fix-partial-trapping-improve-counter.3673280/#post-8655897),
|
|
580
|
+
using move name instead of slot to determine move identity, implementing volatile statuses
|
|
581
|
+
incorrectly or not understanding how moves which call other moves work means that it isn't possible
|
|
582
|
+
to completely implement Pokémon Showdown's behavior for the following moves (the pkmn engine
|
|
583
|
+
attempts to reproduce as much of the behavior that can be reproduced without making data structure
|
|
584
|
+
changes or dramatically deviating from the correct control flow):
|
|
597
585
|
|
|
598
586
|
- **Wrap**: Binding moves like Wrap are implemented on Pokémon Showdown with an artificial
|
|
599
587
|
`partialtrappinglock` volatile as opposed to how it works on the cartridge which simply relies on
|
|
@@ -603,9 +591,9 @@ the correct control flow):
|
|
|
603
591
|
still gets a turn under the [trapping sleep
|
|
604
592
|
glitch](https://glitchcity.wiki/Trapping_move_and_sleep_glitch), Wrap does 0 damage against
|
|
605
593
|
Ghost-type Pokémon instead of properly respecting immunity, and binding effects are handled in the
|
|
606
|
-
wrong order in the code
|
|
607
|
-
|
|
608
|
-
|
|
594
|
+
wrong order in the code.
|
|
595
|
+
- **Counter**: On Pokémon Showdown choices made while sleeping (which should not have been
|
|
596
|
+
registered) can erroneously cause Counter to trigger Desync Clause Mod behavior.
|
|
609
597
|
- **Mimic**: Pokémon Showdown checks that the user of Mimic has Mimic in one of their move slots,
|
|
610
598
|
which means Mimic legally called via Metronome or Mirror Move will only work if the user also has
|
|
611
599
|
Mimic (and the moved mimicked by Mimic called via Metronome / Mirror Move will erroneously
|
|
@@ -617,21 +605,15 @@ the correct control flow):
|
|
|
617
605
|
- **Mirror Move**: Binding moves misbehave when used via Mirror Move (though Pokémon Showdown has
|
|
618
606
|
its own weird behavior and does not implement the [partial trapping move Mirror Move
|
|
619
607
|
glitch](https://glitchcity.wiki/Partial_trapping_move_Mirror_Move_link_battle_glitch) that exists
|
|
620
|
-
on the cartridge).
|
|
621
|
-
is Thrashing instead of just on the turn it is actually selected meaning Mirror Move will
|
|
622
|
-
sometimes successfully mirror a Thrashing move when it should fail. Finally, if Mirror Move copies
|
|
623
|
-
Struggle it should not deduct PP but on Pokémon Showdown it does.
|
|
608
|
+
on the cartridge).
|
|
624
609
|
- **Metronome**: In addition to the issues with binding moves, Metronome and Mirror Move cannot
|
|
625
610
|
mutually call each other more than 3 times in a row without causing the Pokémon Showdown simulator
|
|
626
611
|
to crash due to defensive safety checks that do not exist on the cartridge.
|
|
627
|
-
- **Transform**:
|
|
612
|
+
- **Transform**: Transform screws up the effect of Disable, because on Pokémon Showdown, Disable
|
|
628
613
|
prevents moves of a given *name* from being used (e.g. "Water Gun") as opposed to moves in a
|
|
629
614
|
specific *slot* (e.g. the 2nd move slot), and a Pokémon's moves can change after Transform (this
|
|
630
|
-
is not an issue with Disable + Mimic because Mimic happens to replace the same slot).
|
|
631
|
-
|
|
632
|
-
Showdown does not copy unmodified stats, leaving the Transformed Pokémon with inccorect stats.
|
|
633
|
-
Furthermore, transforming and then using Mirror Move / Metronome can result in [glitchy behavior
|
|
634
|
-
and
|
|
615
|
+
is not an issue with Disable + Mimic because Mimic happens to replace the same slot). Furthermore,
|
|
616
|
+
transforming and then using Mirror Move / Metronome can result in [glitchy behavior and
|
|
635
617
|
softlocks](https://pkmn.cc/bulba/Transform_glitches#Transform_.2B_Mirror_Move.2FMetronome_PP_error)
|
|
636
618
|
which Pokémon Showdown does not implement.
|
|
637
619
|
|
|
@@ -688,10 +670,10 @@ compatibility mode, the implications of these differences are outlined below:
|
|
|
688
670
|
Finally, the **initial 10-byte seed for link battles on Pokémon Red cannot include bytes larger than
|
|
689
671
|
the `SERIAL_PREAMBLE_BYTE`**, so must be in the range $\left[0, 252\right]$. This has implications
|
|
690
672
|
on the first 10 random numbers generated during the battle and has [**non-trivial competitive
|
|
691
|
-
implications**](https://www.smogon.com/forums/
|
|
692
|
-
effects become more likely, the ["1/256-miss"
|
|
693
|
-
cannot happen, Player 1 is more likely to win
|
|
694
|
-
replicate due to everything described above.
|
|
673
|
+
implications**](https://www.smogon.com/forums/threads/rby-tradebacks-bug-report-thread.3524844/page-16#post-9068411)
|
|
674
|
+
(at the start of the battle move effects become more likely, the ["1/256-miss"
|
|
675
|
+
glitch](https://glitchcity.wiki/1/256_miss_glitch) cannot happen, Player 1 is more likely to win
|
|
676
|
+
speed ties, etc) that Pokémon Showdown cannot replicate due to everything described above.
|
|
695
677
|
|
|
696
678
|
All of places in the link battle code where randomness is required are outlined below:
|
|
697
679
|
|
|
@@ -790,8 +772,11 @@ The pkmn engine attempts to adhere to certain naming conventions:
|
|
|
790
772
|
## Resources
|
|
791
773
|
|
|
792
774
|
- [pret/pokered](https://github.com/pret/pokered/) disassembly
|
|
793
|
-
- [Gen I Main Battle
|
|
775
|
+
- [Gen I Main Battle
|
|
776
|
+
Function](https://www.smogon.com/forums/threads/past-gens-research-thread.3506992/#post-5878612) -
|
|
777
|
+
Crystal_
|
|
794
778
|
- [Pokemon Showdown!](https://github.com/smogon/pokemon-showdown)
|
|
795
779
|
- [List of glitches (Generation
|
|
796
780
|
I)](https://bulbapedia.bulbagarden.net/wiki/List_of_glitches_(Generation_I))
|
|
797
|
-
- [Pokémon Showdown RBY
|
|
781
|
+
- [Pokémon Showdown RBY
|
|
782
|
+
Bugs](https://www.smogon.com/forums/threads/rby-tradebacks-bug-report-thread.3524844/#post-5933177)
|
package/src/lib/gen1/data.zig
CHANGED
|
@@ -17,16 +17,16 @@ const expectEqual = std.testing.expectEqual;
|
|
|
17
17
|
const expect = std.testing.expect;
|
|
18
18
|
|
|
19
19
|
/// The minimum size in bytes required to hold all Generation I choice options.
|
|
20
|
-
pub const
|
|
20
|
+
pub const MAX_OPTIONS: usize = 9; // move 1..4, switch 2..6
|
|
21
21
|
/// The optimal size in bytes required to hold all Generation I choice options.
|
|
22
|
-
/// At least as large as
|
|
22
|
+
/// At least as large as MAX_OPTIONS.
|
|
23
23
|
pub const MAX_LOGS: usize = 180;
|
|
24
24
|
|
|
25
25
|
/// The maximum number of bytes possibly logged by a single Generation I update.
|
|
26
|
-
pub const
|
|
27
|
-
|
|
26
|
+
pub const OPTIONS_SIZE = if (builtin.mode == .ReleaseSmall)
|
|
27
|
+
MAX_OPTIONS
|
|
28
28
|
else
|
|
29
|
-
std.math.ceilPowerOfTwo(usize,
|
|
29
|
+
std.math.ceilPowerOfTwo(usize, MAX_OPTIONS) catch unreachable;
|
|
30
30
|
/// The optimal size in bytes required to hold the largest amount of log data possible from a
|
|
31
31
|
/// single Generation I update. At least as large as MAX_LOGS.
|
|
32
32
|
pub const LOGS_SIZE = if (builtin.mode == .ReleaseSmall)
|
|
@@ -76,7 +76,7 @@ pub fn Battle(comptime RNG: anytype) type {
|
|
|
76
76
|
}
|
|
77
77
|
|
|
78
78
|
/// Returns the result of applying Player 1's choice `c1` and Player 2's choice `c2` to the
|
|
79
|
-
/// battle, optionally writing protocol
|
|
79
|
+
/// battle, optionally writing protocol logs to `log` if `options.trace` is enabled.
|
|
80
80
|
pub fn update(self: *Self, c1: Choice, c2: Choice, log: anytype) !Result {
|
|
81
81
|
return mechanics.update(self, c1, c2, log);
|
|
82
82
|
}
|
package/src/lib/gen1/helpers.zig
CHANGED
|
@@ -211,19 +211,16 @@ pub const Pokemon = struct {
|
|
|
211
211
|
}
|
|
212
212
|
};
|
|
213
213
|
|
|
214
|
-
//
|
|
215
|
-
// fn blocked(m: Move) bool {
|
|
216
|
-
// // Binding moves are borked but only via Mirror Move / Metronome which are already blocked
|
|
217
|
-
// return switch (m) {
|
|
218
|
-
// .Mimic, .Metronome, .MirrorMove, .Transform => true,
|
|
219
|
-
// else => false,
|
|
220
|
-
// };
|
|
221
|
-
// }
|
|
222
|
-
|
|
214
|
+
// cat src/test/showdown/blocklist.json | jq '."1".moves'
|
|
223
215
|
fn blocked(m: Move) bool {
|
|
224
216
|
if (Move.get(m).effect == .Binding) return true;
|
|
225
217
|
return switch (m) {
|
|
226
|
-
.Counter,
|
|
218
|
+
.Counter,
|
|
219
|
+
.Mimic,
|
|
220
|
+
.Metronome,
|
|
221
|
+
.MirrorMove,
|
|
222
|
+
.Transform,
|
|
223
|
+
=> true,
|
|
227
224
|
else => false,
|
|
228
225
|
};
|
|
229
226
|
}
|