@pkmn/engine 0.1.0-dev.0eb29f53 → 0.1.0-dev.1da0f17c

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.
Files changed (17) hide show
  1. package/README.md +17 -17
  2. package/build/pkg/addon.d.ts +1 -1
  3. package/build/pkg/addon.js +4 -4
  4. package/build/pkg/addon.js.map +1 -1
  5. package/build/pkg/index.d.ts +11 -10
  6. package/build/pkg/index.js.map +1 -1
  7. package/build.zig +7 -7
  8. package/package.json +8 -8
  9. package/src/bin/install-pkmn-engine +2 -2
  10. package/src/lib/binding/node.zig +1 -1
  11. package/src/lib/binding/wasm.zig +1 -1
  12. package/src/lib/common/options.zig +3 -3
  13. package/src/lib/common/protocol.zig +38 -38
  14. package/src/lib/gen1/README.md +3 -3
  15. package/src/lib/gen1/data.zig +1 -1
  16. package/src/lib/gen1/mechanics.zig +9 -8
  17. package/src/lib/pkmn.zig +4 -4
package/README.md CHANGED
@@ -54,9 +54,9 @@ build 2560 or greater, though tracks Zig's master branch so this may change in t
54
54
  breaking language changes are introduced:
55
55
 
56
56
  `libpkmn` can be built with `-Dshowdown` to instead produce the Pokémon Showdown compatible
57
- `libpkmn-showdown` library. Furthermore, trace logging can be enabled through `-Dtrace`. The
58
- `libpkmn` and `libpkmn-showdown` objects available in the binary release are compiled with and
59
- without the `-Dtrace` flag respectively.
57
+ `libpkmn-showdown` library. Furthermore, protocol message logging can be enabled through `-Dlog`.
58
+ The `libpkmn` and `libpkmn-showdown` objects available in the binary release are both compiled with
59
+ the `-Dlog` flag by default.
60
60
 
61
61
  ### `@pkmn/engine`
62
62
 
@@ -90,21 +90,21 @@ const pkmn = @import("lib/pkmn/build.zig");
90
90
 
91
91
  pub fn build(b: *std.build.Builder) void {
92
92
  ...
93
- exe.addModule("pkmn", pkmn.module(b, .{ .showdown = true, .trace = true }));
93
+ exe.addModule("pkmn", pkmn.module(b, .{ .showdown = true, .log = true }));
94
94
  ...
95
95
  }
96
96
  ```
97
97
 
98
98
  The engine's `build.zig` exposes a `module` function that takes an options structure to allow for
99
- configuring whether or not Pokémon Showdown compatibility mode or trace logs should be enabled.
100
- Alternatively, you may set options via a `pkmn_options` [root source file
99
+ configuring whether or not Pokémon Showdown compatibility mode or protocol message logging should be
100
+ enabled. Alternatively, you may set options via a `pkmn_options` [root source file
101
101
  declaration](https://ziglang.org/documentation/master/#Root-Source-File). There are several
102
102
  undocumented internal options that can be tweaked as well via build or root options, though these
103
103
  options are not officially supported, affect correctness, and may change meaning or behavior without
104
104
  warning. Use at your own risk.
105
105
 
106
106
  ```zig
107
- pub const pkmn_options = .{ .showdown = true, .trace = true };
107
+ pub const pkmn_options = .{ .showdown = true, .log = true };
108
108
  ```
109
109
 
110
110
  ## Usage
@@ -112,11 +112,11 @@ pub const pkmn_options = .{ .showdown = true, .trace = true };
112
112
  For each Pokémon generation, the engine provides a battle structure with two functions - a function
113
113
  to `update` the battle's state based on both players' choices and a function that defines which
114
114
  `choices` are valid at that decision point (at the beginning of a battle both player's must "pass"
115
- as their first choice in order to switch in the first member of their party). If `-Dtrace` logging
116
- is enabled each update will produce logs which can be decoded into a buffer (`LOGS_SIZE` constants
117
- are provided to make it easy to allocate a buffer of the correct size). Each `update` will return a
118
- result to indicate either that the battle has terminated or which types of choices will be available
119
- for each player.
115
+ as their first choice in order to switch in the first member of their party). If `-Dlog` protocol
116
+ logging is enabled each update will produce logs which can be decoded into a buffer (`LOGS_SIZE`
117
+ constants are provided to make it easy to allocate a buffer of the correct size). Each `update` will
118
+ return a result to indicate either that the battle has terminated or which types of choices will be
119
+ available for each player.
120
120
 
121
121
  Unlike [Pokémon Showdown's
122
122
  SIM-PROTOCOL](https://github.com/smogon/pokemon-showdown/blob/master/sim/SIM-PROTOCOL.md#choice-requests)
@@ -139,7 +139,7 @@ potential logs that may result.
139
139
  ### C
140
140
 
141
141
  [`pkmn.h`](src/include/pkmn.h) exports the C API for `libpkmn`. Symbols are all prefixed with
142
- `pkmn_` to avoid name collisions. If `-Dtrace` is enabled and logging throws an error then the error
142
+ `pkmn_` to avoid name collisions. If `-Dlog` is enabled and logging throws an error then the error
143
143
  will be encoded in the `pkmn_result` and can be checked with `pkmn_error`.
144
144
 
145
145
  ```c
@@ -250,10 +250,10 @@ following is a list of known `libpkmn` bindings written by developers outside of
250
250
  organization](https://github.com/pkmn) that may be helpful (though note that these projects may not
251
251
  necessarily be up-to-date/complete/correct - inclusion in this list does not imply endorsement):
252
252
 
253
- | Language | License | URL |
254
- | ---------- | --------- | --------------------------------------- |
255
- | **C++** | `BSL-1.0` | https://github.com/pasyg/engine-wrapper |
256
- | **Python** | `MIT` | https://github.com/AnnikaCodes/PyKMN |
253
+ | Language | License | URL |
254
+ | ---------- | --------- | ------------------------------------ |
255
+ | **C++** | `BSL-1.0` | https://github.com/pasyg/wrapsire |
256
+ | **Python** | `MIT` | https://github.com/AnnikaCodes/PyKMN |
257
257
 
258
258
 
259
259
  #### `pkmn-debug`
package/build/pkg/addon.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { Choice, Player, Result } from '.';
2
2
  export declare function check(showdown: boolean): void;
3
- export declare function supports(showdown: boolean, trace?: boolean): boolean;
3
+ export declare function supports(showdown: boolean, log?: boolean): boolean;
4
4
  export declare function update(index: number, showdown: boolean, battle: ArrayBuffer, c1?: Choice, c2?: Choice, log?: ArrayBuffer): Result;
5
5
  export declare function choices(index: number, showdown: boolean, battle: ArrayBuffer, player: Player, choice: Choice['type'], buf: ArrayBuffer): Choice[];
6
6
  export declare function choose(index: number, showdown: boolean, battle: ArrayBuffer, player: Player, choice: Choice['type'], buf: ArrayBuffer, fn: (n: number) => number): Choice;
package/build/pkg/addon.js CHANGED
@@ -48,7 +48,7 @@ function load() {
48
48
  }
49
49
  function check(showdown) {
50
50
  if (!load()[+showdown]) {
51
- const opts = ADDON[+!showdown].options.trace ? ['-Dtrace'] : [];
51
+ const opts = ADDON[+!showdown].options.log ? ['-log'] : [];
52
52
  if (showdown)
53
53
  opts.push('-Dshowdown');
54
54
  throw new Error(`@pkmn/engine has ${showdown ? 'not' : 'only'} been configured to support Pokémon Showdown.` +
@@ -56,12 +56,12 @@ function check(showdown) {
56
56
  }
57
57
  }
58
58
  exports.check = check;
59
- function supports(showdown, trace) {
59
+ function supports(showdown, log) {
60
60
  if (!load()[+showdown])
61
61
  return false;
62
- if (trace === undefined)
62
+ if (log === undefined)
63
63
  return true;
64
- return ADDON[+showdown].options.trace === trace;
64
+ return ADDON[+showdown].options.log === log;
65
65
  }
66
66
  exports.supports = supports;
67
67
  function update(index, showdown, battle, c1, c2, log) {
package/build/pkg/addon.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"addon.js","sourceRoot":"","sources":["../../src/pkg/addon.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAA6B;AAE7B,wBAAyC;AAEzC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAE9C,IAAI,KAAK,GAAoD,SAAS,CAAC;AAcvE,SAAS,IAAI;IACX,IAAI,KAAK;QAAE,OAAO,KAAK,CAAC;IACxB,IAAI,IAAI,GAAgC,SAAS,CAAC;IAClD,IAAI,QAAQ,GAA+B,SAAS,CAAC;IACrD,IAAI;QACF,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,CAAC,CAAoB,CAAC;KACjF;IAAC,MAAM,GAAG;IACX,IAAI;QACF,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,oBAAoB,CAAC,CAAmB,CAAC;KAC7F;IAAC,MAAM,GAAG;IACX,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE;QACtB,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;KAC1F;IACD,OAAO,CAAC,KAAK,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;AACpC,CAAC;AAED,SAAgB,KAAK,CAAC,QAAiB;IACrC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE;QACtB,MAAM,IAAI,GAAG,KAAM,CAAC,CAAC,CAAC,QAAQ,CAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAClE,IAAI,QAAQ;YAAE,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACtC,MAAM,IAAI,KAAK,CACb,oBAAoB,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,+CAA+C;YAC5F,mDAAmD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,0BAA0B,CAC5F,CAAC;KACH;AACH,CAAC;AATD,sBASC;AAED,SAAgB,QAAQ,CAAC,QAAiB,EAAE,KAAe;IACzD,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC;QAAE,OAAO,KAAK,CAAC;IACrC,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IACrC,OAAO,KAAM,CAAC,CAAC,QAAQ,CAAE,CAAC,OAAO,CAAC,KAAK,KAAK,KAAK,CAAC;AACpD,CAAC;AAJD,4BAIC;AAED,SAAgB,MAAM,CACpB,KAAa,EACb,QAAiB,EACjB,MAAmB,EACnB,EAAW,EACX,EAAW,EACX,GAAiB;IAEjB,OAAO,SAAM,CAAC,MAAM,CAAC,KAAM,CAAC,CAAC,QAAQ,CAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;SACpD,MAAM,CAAC,MAAM,EAAE,SAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,SAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;AAChE,CAAC;AAVD,wBAUC;AAED,SAAgB,OAAO,CACrB,KAAa,EACb,QAAiB,EACjB,MAAmB,EACnB,MAAc,EACd,MAAsB,EACtB,GAAgB;IAEhB,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAClE,MAAM,CAAC,GAAG,KAAM,CAAC,CAAC,QAAQ,CAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,KAAK,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;IAC/F,uEAAuE;IACvE,8EAA8E;IAC9E,8EAA8E;IAC9E,oEAAoE;IACpE,0EAA0E;IAC1E,2EAA2E;IAC3E,4EAA4E;IAC5E,8EAA8E;IAC9E,4EAA4E;IAC5E,2EAA2E;IAC3E,uEAAuE;IACvE,8EAA8E;IAC9E,yEAAyE;IACzE,8EAA8E;IAC9E,8EAA8E;IAC9E,0EAA0E;IAC1E,UAAU;IACV,MAAM,OAAO,GAAG,IAAI,KAAK,CAAS,CAAC,CAAC,CAAC;IACrC,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC;IACjC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;QAAE,OAAO,CAAC,CAAC,CAAC,GAAG,SAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAChE,OAAO,OAAO,CAAC;AACjB,CAAC;AA/BD,0BA+BC;AAED,SAAgB,MAAM,CACpB,KAAa,EACb,QAAiB,EACjB,MAAmB,EACnB,MAAc,EACd,MAAsB,EACtB,GAAgB,EAChB,EAAyB;IAEzB,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAClE,MAAM,CAAC,GAAG,KAAM,CAAC,CAAC,QAAQ,CAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,KAAK,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;IAC/F,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC;IACjC,OAAO,SAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACpC,CAAC;AAbD,wBAaC;AAED,SAAgB,IAAI,CAAC,KAAa,EAAE,IAAuB;IACzD,MAAM,QAAQ,GAAG,CAAC,KAAM,CAAC,CAAC,CAAC,IAAI,KAAM,CAAC,CAAC,CAAC,CAAE,CAAC,QAAQ,CAAC,KAAK,CAAE,CAAC;IAC5D,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC;AACtE,CAAC;AAHD,oBAGC"}
1
+ {"version":3,"file":"addon.js","sourceRoot":"","sources":["../../src/pkg/addon.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAA6B;AAE7B,wBAAyC;AAEzC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAE9C,IAAI,KAAK,GAAoD,SAAS,CAAC;AAcvE,SAAS,IAAI;IACX,IAAI,KAAK;QAAE,OAAO,KAAK,CAAC;IACxB,IAAI,IAAI,GAAgC,SAAS,CAAC;IAClD,IAAI,QAAQ,GAA+B,SAAS,CAAC;IACrD,IAAI;QACF,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,CAAC,CAAoB,CAAC;KACjF;IAAC,MAAM,GAAG;IACX,IAAI;QACF,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,oBAAoB,CAAC,CAAmB,CAAC;KAC7F;IAAC,MAAM,GAAG;IACX,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE;QACtB,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;KAC1F;IACD,OAAO,CAAC,KAAK,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;AACpC,CAAC;AAED,SAAgB,KAAK,CAAC,QAAiB;IACrC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE;QACtB,MAAM,IAAI,GAAG,KAAM,CAAC,CAAC,CAAC,QAAQ,CAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7D,IAAI,QAAQ;YAAE,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACtC,MAAM,IAAI,KAAK,CACb,oBAAoB,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,+CAA+C;YAC5F,mDAAmD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,0BAA0B,CAC5F,CAAC;KACH;AACH,CAAC;AATD,sBASC;AAED,SAAgB,QAAQ,CAAC,QAAiB,EAAE,GAAa;IACvD,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC;QAAE,OAAO,KAAK,CAAC;IACrC,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IACnC,OAAO,KAAM,CAAC,CAAC,QAAQ,CAAE,CAAC,OAAO,CAAC,GAAG,KAAK,GAAG,CAAC;AAChD,CAAC;AAJD,4BAIC;AAED,SAAgB,MAAM,CACpB,KAAa,EACb,QAAiB,EACjB,MAAmB,EACnB,EAAW,EACX,EAAW,EACX,GAAiB;IAEjB,OAAO,SAAM,CAAC,MAAM,CAAC,KAAM,CAAC,CAAC,QAAQ,CAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;SACpD,MAAM,CAAC,MAAM,EAAE,SAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,SAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;AAChE,CAAC;AAVD,wBAUC;AAED,SAAgB,OAAO,CACrB,KAAa,EACb,QAAiB,EACjB,MAAmB,EACnB,MAAc,EACd,MAAsB,EACtB,GAAgB;IAEhB,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAClE,MAAM,CAAC,GAAG,KAAM,CAAC,CAAC,QAAQ,CAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,KAAK,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;IAC/F,uEAAuE;IACvE,8EAA8E;IAC9E,8EAA8E;IAC9E,oEAAoE;IACpE,0EAA0E;IAC1E,2EAA2E;IAC3E,4EAA4E;IAC5E,8EAA8E;IAC9E,4EAA4E;IAC5E,2EAA2E;IAC3E,uEAAuE;IACvE,8EAA8E;IAC9E,yEAAyE;IACzE,8EAA8E;IAC9E,8EAA8E;IAC9E,0EAA0E;IAC1E,UAAU;IACV,MAAM,OAAO,GAAG,IAAI,KAAK,CAAS,CAAC,CAAC,CAAC;IACrC,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC;IACjC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;QAAE,OAAO,CAAC,CAAC,CAAC,GAAG,SAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAChE,OAAO,OAAO,CAAC;AACjB,CAAC;AA/BD,0BA+BC;AAED,SAAgB,MAAM,CACpB,KAAa,EACb,QAAiB,EACjB,MAAmB,EACnB,MAAc,EACd,MAAsB,EACtB,GAAgB,EAChB,EAAyB;IAEzB,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAClE,MAAM,CAAC,GAAG,KAAM,CAAC,CAAC,QAAQ,CAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,KAAK,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;IAC/F,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC;IACjC,OAAO,SAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACpC,CAAC;AAbD,wBAaC;AAED,SAAgB,IAAI,CAAC,KAAa,EAAE,IAAuB;IACzD,MAAM,QAAQ,GAAG,CAAC,KAAM,CAAC,CAAC,CAAC,IAAI,KAAM,CAAC,CAAC,CAAC,CAAE,CAAC,QAAQ,CAAC,KAAK,CAAE,CAAC;IAC5D,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC;AACtE,CAAC;AAHD,oBAGC"}
package/build/pkg/index.d.ts CHANGED
@@ -14,8 +14,9 @@ export type MoveSlot = Gen1.MoveSlot;
14
14
  /** Generic API supported by all Generations of Battle. */
15
15
  export interface API {
16
16
  /**
17
- * The most recent buffer of binary protocol trace log data filled by `update`
18
- * if tracing is enabled, otherwise undefined. Meant to be parsed by `Log`.
17
+ * The most recent buffer of binary protocol message log data filled by
18
+ * `update` if logging is enabled, otherwise undefined. Meant to be parsed by
19
+ * `Log`.
19
20
  */
20
21
  log?: DataView;
21
22
  /**
@@ -245,8 +246,8 @@ export type CreateOptions = {
245
246
  /** Player 2's options. */
246
247
  p2: PlayerOptions;
247
248
  /**
248
- * Whether to capture protocol trace logs. Note that if the engine itself was
249
- * not build with trace logging enabled then enabling this will have no
249
+ * Whether to capture protocol message logs. Note that if the engine itself
250
+ * was not build with protocol logging enabled then enabling this will have no
250
251
  * effect.
251
252
  */
252
253
  log: true;
@@ -256,8 +257,8 @@ export type CreateOptions = {
256
257
  /** Player 2's options. */
257
258
  p2: Omit<PlayerOptions, 'name'>;
258
259
  /**
259
- * Whether to capture protocol trace logs. Note that if the engine itself was
260
- * not build with trace logging enabled then enabling this will have no
260
+ * Whether to capture protocol message logs. Note that if the engine itself
261
+ * was not build with protocol logging enabled then enabling this will have no
261
262
  * effect.
262
263
  */
263
264
  log?: false;
@@ -274,8 +275,8 @@ export type RestoreOptions = {
274
275
  */
275
276
  showdown?: boolean;
276
277
  /**
277
- * Whether to capture protocol trace logs. Note that if the engine itself was
278
- * not build with trace logging enabled then enabling this will have no
278
+ * Whether to capture protocol message logs. Note that if the engine itself
279
+ * was not build with protocol logging enabled then enabling this will have no
279
280
  * effect.
280
281
  */
281
282
  log: true;
@@ -286,8 +287,8 @@ export type RestoreOptions = {
286
287
  */
287
288
  showdown?: boolean;
288
289
  /**
289
- * Whether to capture protocol trace logs. Note that if the engine itself was
290
- * not build with trace logging enabled then enabling this will have no
290
+ * Whether to capture protocol message logs. Note that if the engine itself
291
+ * was not build with protocol logging enabled then enabling this will have no
291
292
  * effect.
292
293
  */
293
294
  log?: false;
package/build/pkg/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/pkg/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,+CAAiC;AACjC,iCAA8B;AAC9B,6CAA+B;AA8V/B,2CAA2C;AAC9B,QAAA,MAAM,GAAG,IAAI;IACxB,2EAA2E;IAC3E,MAAM,CAAC,GAAe,EAAE,OAAsB;QAC5C,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAChC,MAAM,MAAM,GAAG,aAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,QAAQ,GAAG,CAAC,GAAG,EAAE;YACjB,KAAK,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;YACxD,OAAO,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC,mBAAmB,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;SACtD;IACH,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,GAAe,EAAE,MAAc,EAAE,OAAuB;QAC9D,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAChC,MAAM,MAAM,GAAG,aAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,QAAQ,GAAG,CAAC,GAAG,EAAE;YACjB,KAAK,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;YACjE,OAAO,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC,mBAAmB,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;SACtD;IACH,CAAC;CACF,CAAC;AAEF,mDAAmD;AACnD,MAAa,MAAM;IACjB,+BAA+B;IAC/B,MAAM,CAAC,KAAK,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAU,CAAC;IAEzC,MAAM,CAAC,IAAI,GAAG,EAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAU,CAAC;IAC/C,MAAM,CAAC,KAAK,GAAG,kDAAkD,CAAC;IAE5E,gBAAuB,CAAC;IAExB,sDAAsD;IACtD,MAAM,CAAC,MAAM,CAAC,IAAY;QACxB,OAAO,EAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,IAAI,CAAC,EAAC,CAAC;IAC5D,CAAC;IAED,oDAAoD;IACpD,MAAM,CAAC,MAAM,CAAC,MAAe;QAC3B,OAAO,CAAC,MAAM;YACZ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACpF,CAAC,CAAC,CAAC,CAAC,CAAC;IACT,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,KAAK,CAAC,MAAc;QACzB,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACpC,IAAI,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,MAAM,GAAG,CAAC,CAAC;QACvD,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAmB,CAAC;QACtD,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QAClC,OAAO,EAAC,IAAI,EAAE,IAAI,EAAC,CAAC;IACtB,CAAC;IAED,2EAA2E;IAC3E,MAAM,CAAC,MAAM,CAAC,MAAc;QAC1B,OAAO,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;IAChF,CAAC;IAED,mCAAmC;IACnC,MAAM,CAAC,IAAI;QACT,OAAO,MAAM,CAAC,IAAI,CAAC;IACrB,CAAC;IAED,wDAAwD;IACxD,MAAM,CAAC,IAAI,CAAC,IAAuB;QACjC,OAAO,EAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAC,CAAC;IAC9B,CAAC;IAED,0DAA0D;IAC1D,MAAM,CAAC,MAAM,CAAC,IAAuB;QACnC,OAAO,EAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAC,CAAC;IAChC,CAAC;;AAnDU,wBAAM;AAsDnB,kDAAkD;AAClD,MAAa,MAAM;IACjB,8BAA8B;IAC9B,MAAM,CAAC,KAAK,GAAG,CAAC,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAU,CAAC;IAEnE,gBAAuB,CAAC;IAExB,wDAAwD;IACxD,MAAM,CAAC,MAAM,CAAC,IAAY;QACxB,OAAO;YACL,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,GAAG,MAAM,CAAC;YACjC,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC;YACpC,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC;SAC5B,CAAC;IACJ,CAAC;;AAbU,wBAAM;AAgBnB,uCAAwE;AAApD,gGAAA,IAAI,OAAA;AAAE,oGAAA,QAAQ,OAAA;AAAe,+FAAA,GAAG,OAAA;AACpD,+BAA8B;AAAtB,8FAAA,MAAM,OAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/pkg/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,+CAAiC;AACjC,iCAA8B;AAC9B,6CAA+B;AA+V/B,2CAA2C;AAC9B,QAAA,MAAM,GAAG,IAAI;IACxB,2EAA2E;IAC3E,MAAM,CAAC,GAAe,EAAE,OAAsB;QAC5C,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAChC,MAAM,MAAM,GAAG,aAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,QAAQ,GAAG,CAAC,GAAG,EAAE;YACjB,KAAK,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;YACxD,OAAO,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC,mBAAmB,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;SACtD;IACH,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,GAAe,EAAE,MAAc,EAAE,OAAuB;QAC9D,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAChC,MAAM,MAAM,GAAG,aAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,QAAQ,GAAG,CAAC,GAAG,EAAE;YACjB,KAAK,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;YACjE,OAAO,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC,mBAAmB,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;SACtD;IACH,CAAC;CACF,CAAC;AAEF,mDAAmD;AACnD,MAAa,MAAM;IACjB,+BAA+B;IAC/B,MAAM,CAAC,KAAK,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAU,CAAC;IAEzC,MAAM,CAAC,IAAI,GAAG,EAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAU,CAAC;IAC/C,MAAM,CAAC,KAAK,GAAG,kDAAkD,CAAC;IAE5E,gBAAuB,CAAC;IAExB,sDAAsD;IACtD,MAAM,CAAC,MAAM,CAAC,IAAY;QACxB,OAAO,EAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,IAAI,CAAC,EAAC,CAAC;IAC5D,CAAC;IAED,oDAAoD;IACpD,MAAM,CAAC,MAAM,CAAC,MAAe;QAC3B,OAAO,CAAC,MAAM;YACZ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACpF,CAAC,CAAC,CAAC,CAAC,CAAC;IACT,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,KAAK,CAAC,MAAc;QACzB,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACpC,IAAI,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,MAAM,GAAG,CAAC,CAAC;QACvD,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAmB,CAAC;QACtD,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QAClC,OAAO,EAAC,IAAI,EAAE,IAAI,EAAC,CAAC;IACtB,CAAC;IAED,2EAA2E;IAC3E,MAAM,CAAC,MAAM,CAAC,MAAc;QAC1B,OAAO,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;IAChF,CAAC;IAED,mCAAmC;IACnC,MAAM,CAAC,IAAI;QACT,OAAO,MAAM,CAAC,IAAI,CAAC;IACrB,CAAC;IAED,wDAAwD;IACxD,MAAM,CAAC,IAAI,CAAC,IAAuB;QACjC,OAAO,EAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAC,CAAC;IAC9B,CAAC;IAED,0DAA0D;IAC1D,MAAM,CAAC,MAAM,CAAC,IAAuB;QACnC,OAAO,EAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAC,CAAC;IAChC,CAAC;;AAnDU,wBAAM;AAsDnB,kDAAkD;AAClD,MAAa,MAAM;IACjB,8BAA8B;IAC9B,MAAM,CAAC,KAAK,GAAG,CAAC,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAU,CAAC;IAEnE,gBAAuB,CAAC;IAExB,wDAAwD;IACxD,MAAM,CAAC,MAAM,CAAC,IAAY;QACxB,OAAO;YACL,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,GAAG,MAAM,CAAC;YACjC,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC;YACpC,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC;SAC5B,CAAC;IACJ,CAAC;;AAbU,wBAAM;AAgBnB,uCAAwE;AAApD,gGAAA,IAAI,OAAA;AAAE,oGAAA,QAAQ,OAAA;AAAe,+FAAA,GAAG,OAAA;AACpD,+BAA8B;AAAtB,8FAAA,MAAM,OAAA"}
package/build.zig CHANGED
@@ -1,13 +1,13 @@
1
1
  const std = @import("std");
2
2
  const builtin = @import("builtin");
3
3
 
4
- pub const Options = struct { showdown: ?bool = null, trace: ?bool = null };
4
+ pub const Options = struct { showdown: ?bool = null, log: ?bool = null };
5
5
 
6
6
  pub fn module(b: *std.Build, options: Options) *std.Build.Module {
7
7
  const dirname = comptime std.fs.path.dirname(@src().file) orelse ".";
8
8
  const build_options = b.addOptions();
9
9
  build_options.addOption(?bool, "showdown", options.showdown);
10
- build_options.addOption(?bool, "trace", options.trace);
10
+ build_options.addOption(?bool, "log", options.log);
11
11
  return b.createModule(.{
12
12
  .source_file = .{ .path = dirname ++ "/src/lib/pkmn.zig" },
13
13
  .dependencies = &.{.{ .name = "build_options", .module = build_options.createModule() }},
@@ -42,11 +42,11 @@ pub fn build(b: *std.Build) !void {
42
42
 
43
43
  const showdown =
44
44
  b.option(bool, "showdown", "Enable Pokémon Showdown compatibility mode") orelse false;
45
- const trace = b.option(bool, "trace", "Enable trace logs") orelse false;
45
+ const log = b.option(bool, "log", "Enable protocol message logging") orelse false;
46
46
 
47
47
  const options = b.addOptions();
48
48
  options.addOption(?bool, "showdown", showdown);
49
- options.addOption(?bool, "trace", trace);
49
+ options.addOption(?bool, "log", log);
50
50
 
51
51
  const name = if (showdown) "pkmn-showdown" else "pkmn";
52
52
 
@@ -185,7 +185,7 @@ pub fn build(b: *std.Build) !void {
185
185
  .general = config,
186
186
  .tool = .{
187
187
  .showdown = showdown,
188
- .trace = trace,
188
+ .log = log,
189
189
  .tests = if (tests.build) tests else null,
190
190
  .exes = &exes,
191
191
  },
@@ -293,7 +293,7 @@ const ToolConfig = struct {
293
293
  general: Config,
294
294
  tool: struct {
295
295
  showdown: bool,
296
- trace: bool,
296
+ log: bool,
297
297
  tests: ?*TestStep,
298
298
  name: ?[]const u8 = null,
299
299
  exes: *std.ArrayList(*std.Build.CompileStep),
@@ -314,7 +314,7 @@ fn tool(b: *std.Build, path: []const u8, config: ToolConfig) *std.Build.RunStep
314
314
  });
315
315
  exe.addModule("pkmn", module(b, .{
316
316
  .showdown = config.tool.showdown,
317
- .trace = config.tool.trace,
317
+ .log = config.tool.log,
318
318
  }));
319
319
  exe.single_threaded = true;
320
320
  if (config.general.pic) exe.force_pic = config.general.pic;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pkmn/engine",
3
- "version": "0.1.0-dev.0eb29f53",
3
+ "version": "0.1.0-dev.1da0f17c",
4
4
  "description": "A minimal, complete, Pokémon battle simulation engine optimized for performance",
5
5
  "repository": "github:pkmn/engine",
6
6
  "license": "MIT",
@@ -66,30 +66,30 @@
66
66
  "access": "public"
67
67
  },
68
68
  "dependencies": {
69
- "@pkmn/data": "^0.7.36",
69
+ "@pkmn/data": "^0.7.37",
70
70
  "@pkmn/protocol": "^0.6.11"
71
71
  },
72
72
  "devDependencies": {
73
73
  "@pkmn/eslint-config": "^3.0.0",
74
74
  "@pkmn/img": "^0.2.8",
75
75
  "@pkmn/sets": "^5.0.4",
76
- "@pkmn/sim": "0.7.36",
76
+ "@pkmn/sim": "0.7.37",
77
77
  "@types/html-minifier": "^4.0.2",
78
78
  "@types/jest": "^29.5.0",
79
79
  "@types/minimist": "^1.2.2",
80
80
  "@types/mustache": "^4.2.2",
81
81
  "@types/node": "^18.15.11",
82
- "@vitest/coverage-c8": "^0.29.8",
82
+ "@vitest/coverage-c8": "^0.30.1",
83
83
  "binaryen": "^112.0.0",
84
- "eslint": "^8.37.0",
84
+ "eslint": "^8.38.0",
85
85
  "html-minifier": "^4.0.0",
86
- "json-stringify-pretty-compact": "3.0.0",
86
+ "json-stringify-pretty-compact": "4.0.0",
87
87
  "minimist": "^1.2.8",
88
88
  "mustache": "^4.2.0",
89
89
  "source-map-support": "^0.5.21",
90
90
  "trakr": "^0.2.0",
91
- "typescript": "^5.0.3",
92
- "vitest": "^0.29.8"
91
+ "typescript": "^5.0.4",
92
+ "vitest": "^0.30.1"
93
93
  },
94
94
  "scripts": {
95
95
  "lint": "eslint --cache src --ext ts,js && eslint src/bin/*",
package/src/bin/install-pkmn-engine CHANGED
@@ -337,13 +337,13 @@ const downloadImportLib = async () => {
337
337
  if (!options) {
338
338
  const addon = require(copy);
339
339
  if (addon.options.showdown) opts.push('-Dshowdown');
340
- if (addon.options.trace) opts.push('-Dtrace');
340
+ if (addon.options.log) opts.push('-Dlog');
341
341
  }
342
342
  } else if (!options) {
343
343
  const addon = await WebAssembly.instantiate(fs.readFileSync(copy));
344
344
  const values = new Uint8Array(addon.instance.exports.memory.buffer);
345
345
  if (values[addon.instance.exports.SHOWDOWN.value]) opts.push('-Dshowdown');
346
- if (values[addon.instance.exports.TRACE.value]) opts.push('-Dtrace');
346
+ if (values[addon.instance.exports.LOG.value]) opts.push('-Dlog');
347
347
  }
348
348
  const key = `${type} ${opts.sort().join(' ')}`;
349
349
  if (!configs.has(key)) configs.set(key, {type, options: opts});
package/src/lib/binding/node.zig CHANGED
@@ -21,7 +21,7 @@ fn options(env: c.napi_env) c.napi_value {
21
21
  var object = Object.init(env);
22
22
  const properties = [_]c.napi_property_descriptor{
23
23
  Property.init("showdown", .{ .value = Boolean.init(env, pkmn.options.showdown) }),
24
- Property.init("trace", .{ .value = Boolean.init(env, pkmn.options.trace) }),
24
+ Property.init("log", .{ .value = Boolean.init(env, pkmn.options.log) }),
25
25
  };
26
26
  assert(c.napi_define_properties(env, object, properties.len, &properties) == c.napi_ok);
27
27
  return object;
package/src/lib/binding/wasm.zig CHANGED
@@ -2,7 +2,7 @@ const std = @import("std");
2
2
  const pkmn = @import("../pkmn.zig");
3
3
 
4
4
  export const SHOWDOWN = pkmn.options.showdown;
5
- export const TRACE = pkmn.options.trace;
5
+ export const LOG = pkmn.options.log;
6
6
 
7
7
  export const GEN1_CHOICES_SIZE =
8
8
  std.math.ceilPowerOfTwo(u32, @intCast(u32, pkmn.gen1.CHOICES_SIZE)) catch unreachable;
package/src/lib/common/options.zig CHANGED
@@ -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);
package/src/lib/common/protocol.zig CHANGED
@@ -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;
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 traces,
201
+ In order to workaround various [Pokémon Showdown bugs](#bugs) and to support its protocol in logs,
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,8 +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 logging traces when `-Dtrace` is enabled can be found in
335
- [PROTOCOL.md](../../../docs/PROTOCOL.md). Note that the
334
+ Documentation of the wire protocol used for protocol message logging when `-Dlog` is enabled can be
335
+ found in [PROTOCOL.md](../../../docs/PROTOCOL.md). Note that the
336
336
  [`pkmn-debug`](../../../README.md#pkmn-debug) tool exists to display the binary protocol and battle
337
337
  data in the browser for ease of debugging.
338
338
 
package/src/lib/gen1/data.zig CHANGED
@@ -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 logs to `log` if `options.trace` is enabled.
79
+ /// battle, optionally writing protocol message logs to `log` if `options.log` 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/mechanics.zig CHANGED
@@ -449,7 +449,7 @@ fn executeMove(
449
449
  return doMove(battle, player, mslot, auto, residual, log);
450
450
  }
451
451
 
452
- const BeforeMove = union(enum) { done, skip_can, skip_pp, ok, err };
452
+ const BeforeMove = enum { done, skip_can, skip_pp, ok, err };
453
453
 
454
454
  fn beforeMove(
455
455
  battle: anytype,
@@ -512,9 +512,10 @@ fn beforeMove(
512
512
  // Pokémon Showdown's disable condition has a single onBeforeMove handler
513
513
  if (showdown and try disabled(side, ident, log)) return .done;
514
514
 
515
- // Pokémon Showdown checks for Flinch *after* instead of before
515
+ // Pokémon Showdown checks for Flinch *after* instead of before... and doesn't clear Flinch
516
+ // until its imaginary "residual" phase, meaning Pokémon can sometimes flinch multiple times
517
+ // from the same original hit
516
518
  if (showdown and volatiles.Flinch) {
517
- volatiles.Flinch = false;
518
519
  try log.cant(ident, .Flinch);
519
520
  return .done;
520
521
  }
@@ -1662,7 +1663,7 @@ pub const Effects = struct {
1662
1663
  side.active.volatiles.Bide = true;
1663
1664
  assert(!side.active.volatiles.Thrashing and !side.active.volatiles.Rage);
1664
1665
  side.active.volatiles.state = 0;
1665
- side.active.volatiles.attacks = Rolls.duration(battle);
1666
+ side.active.volatiles.attacks = Rolls.bideThrashDuration(battle);
1666
1667
 
1667
1668
  try log.start(battle.active(player), .Bide);
1668
1669
  }
@@ -2167,7 +2168,7 @@ pub const Effects = struct {
2167
2168
  }
2168
2169
  foe.active.volatiles.Recharging = false;
2169
2170
 
2170
- foe_stored.status = Status.slp(Rolls.sleep(battle));
2171
+ foe_stored.status = Status.slp(Rolls.sleepDuration(battle));
2171
2172
  try log.statusFrom(foe_ident, foe_stored.status, battle.side(player).last_selected_move);
2172
2173
  }
2173
2174
 
@@ -2220,7 +2221,7 @@ pub const Effects = struct {
2220
2221
  assert(!volatiles.Bide);
2221
2222
 
2222
2223
  volatiles.Thrashing = true;
2223
- volatiles.attacks = Rolls.duration(battle);
2224
+ volatiles.attacks = Rolls.bideThrashDuration(battle);
2224
2225
  }
2225
2226
 
2226
2227
  fn transform(battle: anytype, player: Player, log: anytype) !void {
@@ -2589,7 +2590,7 @@ pub const Rolls = struct {
2589
2590
  return battle.rng.next() < 1 + (if (low) Gen12.percent(20) else Gen12.percent(40));
2590
2591
  }
2591
2592
 
2592
- inline fn sleep(battle: anytype) u3 {
2593
+ inline fn sleepDuration(battle: anytype) u3 {
2593
2594
  if (showdown) return @intCast(u3, battle.rng.range(u8, 1, 8));
2594
2595
  while (true) {
2595
2596
  const r = battle.rng.next() & 7;
@@ -2597,7 +2598,7 @@ pub const Rolls = struct {
2597
2598
  }
2598
2599
  }
2599
2600
 
2600
- inline fn duration(battle: anytype) u3 {
2601
+ inline fn bideThrashDuration(battle: anytype) u3 {
2601
2602
  if (showdown) return @intCast(u3, battle.rng.range(u4, 2, 4));
2602
2603
  return @intCast(u3, (battle.rng.next() & 1) + 2);
2603
2604
  }
package/src/lib/pkmn.zig CHANGED
@@ -25,12 +25,12 @@ pub const Result = @import("common/data.zig").Result;
25
25
  /// Pokémon Showdown's RNG (backed by a Generation V & VI RNG).
26
26
  pub const PSRNG = @import("common/rng.zig").PSRNG;
27
27
 
28
- /// Namespace for helpers related to protocol trace logging.
28
+ /// Namespace for helpers related to protocol message logging.
29
29
  pub const protocol = if (options.internal) struct {
30
30
  pub usingnamespace @import("common/protocol.zig");
31
31
  } else struct {
32
32
  /// Logs protocol information to its `Writer` during a battle update when
33
- /// `options.trace` is enabled.
33
+ /// `options.log` is enabled.
34
34
  pub const Log = @import("common/protocol.zig").Log;
35
35
  /// Stripped down version of `std.io.FixedBufferStream` optimized for
36
36
  /// efficiently writing the individual protocol bytes. Note that the
@@ -41,8 +41,8 @@ pub const protocol = if (options.internal) struct {
41
41
  /// intialized with a `LOGS_SIZE`-sized buffer.
42
42
  pub const FixedLog = @import("common/protocol.zig").FixedLog;
43
43
  /// Null object pattern implementation of `Log` backed by a
44
- /// `std.io.null_writer`. Ignores anything sent to it, though trace logging
45
- /// should addtionally be turned off entirely by using `options.trace`.
44
+ /// `std.io.null_writer`. Ignores anything sent to it, though protocol
45
+ /// logging should additionally be turned off entirely with `options.log`.
46
46
  pub const NULL = @import("common/protocol.zig").NULL;
47
47
  };
48
48