@pkmn/engine 0.1.0-dev.00879b8b

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 (60) hide show
  1. package/LICENSE +18 -0
  2. package/README.md +368 -0
  3. package/build/pkg/addon.d.ts +7 -0
  4. package/build/pkg/addon.js +111 -0
  5. package/build/pkg/addon.js.map +1 -0
  6. package/build/pkg/data/ids.json +240 -0
  7. package/build/pkg/data/layout.json +108 -0
  8. package/build/pkg/data/protocol.json +230 -0
  9. package/build/pkg/data.d.ts +91 -0
  10. package/build/pkg/data.js +150 -0
  11. package/build/pkg/data.js.map +1 -0
  12. package/build/pkg/gen1.d.ts +110 -0
  13. package/build/pkg/gen1.js +684 -0
  14. package/build/pkg/gen1.js.map +1 -0
  15. package/build/pkg/index.d.ts +387 -0
  16. package/build/pkg/index.js +122 -0
  17. package/build/pkg/index.js.map +1 -0
  18. package/build/pkg/protocol.d.ts +73 -0
  19. package/build/pkg/protocol.js +473 -0
  20. package/build/pkg/protocol.js.map +1 -0
  21. package/build/test/display.js +400 -0
  22. package/build/test/display.js.map +1 -0
  23. package/build/tools/debug.js +134 -0
  24. package/build/tools/debug.js.map +1 -0
  25. package/build.zig +363 -0
  26. package/package.json +232 -0
  27. package/src/bin/install-pkmn-engine +404 -0
  28. package/src/bin/pkmn-debug +62 -0
  29. package/src/lib/common/battle.zig +17 -0
  30. package/src/lib/common/data.zig +117 -0
  31. package/src/lib/common/debug.zig +74 -0
  32. package/src/lib/common/js.zig +118 -0
  33. package/src/lib/common/optional.zig +67 -0
  34. package/src/lib/common/options.zig +51 -0
  35. package/src/lib/common/protocol.zig +1836 -0
  36. package/src/lib/common/rational.zig +357 -0
  37. package/src/lib/common/rng.zig +243 -0
  38. package/src/lib/common/util.zig +12 -0
  39. package/src/lib/gen1/calc.zig +507 -0
  40. package/src/lib/gen1/chance.zig +1063 -0
  41. package/src/lib/gen1/data/moves.zig +1866 -0
  42. package/src/lib/gen1/data/species.zig +1105 -0
  43. package/src/lib/gen1/data/types.zig +131 -0
  44. package/src/lib/gen1/data.zig +634 -0
  45. package/src/lib/gen1/helpers.zig +866 -0
  46. package/src/lib/gen1/mechanics.zig +3156 -0
  47. package/src/lib/gen2/calc.zig +143 -0
  48. package/src/lib/gen2/chance.zig +1315 -0
  49. package/src/lib/gen2/data/items.zig +230 -0
  50. package/src/lib/gen2/data/moves.zig +2878 -0
  51. package/src/lib/gen2/data/species.zig +1798 -0
  52. package/src/lib/gen2/data/types.zig +226 -0
  53. package/src/lib/gen2/data.zig +463 -0
  54. package/src/lib/gen2/generated.zig +806 -0
  55. package/src/lib/gen2/helpers.zig +249 -0
  56. package/src/lib/gen2/mechanics.zig +3632 -0
  57. package/src/lib/node.zig +131 -0
  58. package/src/lib/pkmn.zig +128 -0
  59. package/src/lib/wasm.zig +13 -0
  60. package/src/test/display/pkmn.html.tmpl +368 -0
package/LICENSE ADDED
@@ -0,0 +1,18 @@
1
+ Copyright (c) 2021-2024 pkmn contributors
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining a copy of
4
+ this software and associated documentation files (the "Software"), to deal in
5
+ the Software without restriction, including without limitation the rights to
6
+ use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
7
+ the Software, and to permit persons to whom the Software is furnished to do so,
8
+ subject to the following conditions:
9
+
10
+ The above copyright notice and this permission notice shall be included in all
11
+ copies or substantial portions of the Software.
12
+
13
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
15
+ FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
16
+ COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
17
+ IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
18
+ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,368 @@
1
+ <p align="center">
2
+ <img alt="pkmn/engine" width="192" height="192" src="https://pkmn.cc/engine.svg" />
3
+ <br />
4
+ <br />
5
+ <a href="https://github.com/pkmn/engine/actions/workflows/test.yml">
6
+ <img alt="Test Status" src="https://github.com/pkmn/engine/actions/workflows/test.yml/badge.svg" />
7
+ </a>
8
+ <a href="#status">
9
+ <img alt="WIP" src="https://img.shields.io/badge/status-WIP-red.svg" />
10
+ </a>
11
+ <a href="https://github.com/pkmn/engine/blob/master/LICENSE">
12
+ <img alt="License" src="https://img.shields.io/badge/License-MIT-blue.svg" />
13
+ </a>
14
+ </p>
15
+
16
+ > [!WARNING]
17
+ > **This project is under heavy development** and currently the `main` branch contains numerous breaking
18
+ > changes which may not work and which are not fully documented. Please **wait for the forthcoming
19
+ > initial v0.1 release** before depending on this project (code from the
20
+ > [`old`](https://github.com/pkmn/engine/releases/tag/old) tag can also be used to experiment with a
21
+ > more stable version of the codebase).
22
+
23
+ <hr />
24
+
25
+ A minimal, complete, Pokémon battle simulation engine optimized for performance and
26
+ [designed](docs/DESIGN.md) for tooling, embedded systems, and [artificial
27
+ intelligence](https://github.com/pkmn/0-ERROR) use cases. This engine aims to be a frame-accurate and
28
+ [bug-for-bug compatible](http://www.catb.org/jargon/html/B/bug-for-bug-compatible.html)
29
+ implementation of both Pokémon battles as defined by the original game code and the [Pokémon
30
+ Showdown](https://pokemonshowdown.com/)[^1] simulator which represents Pokémon battling as practically
31
+ interpreted online.
32
+
33
+ The pkmn engine is [**more than 1000× faster**](docs/TESTING.md#results) than the
34
+ [patched](docs/TESTING.md#patches) [Pokémon Showdown simulator
35
+ code](https://github.com/smogon/pokemon-showdown) when playing out supported formats in
36
+ compatibility mode and is extensively [tested](docs/TESTING.md) and [documented](docs). Note,
37
+ however, that the engine is **not a fully featured simulator** but is instead a low-level library
38
+ which can be used as a building block for more advanced use cases.
39
+
40
+ ## Installation
41
+
42
+ This repository hosts both the engine code (written in [Zig](https://ziglang.org/)) and the
43
+ reference driver code (written in [TypeScript](https://www.typescriptlang.org/)).
44
+
45
+ ### `libpkmn`
46
+
47
+ Binaries of the engine code can be downloaded from the
48
+ [releases](https://github.com/pkmn/engine/releases) tab on GitHub, or you can [download the source
49
+ code](https://github.com/pkmn/engine/archive/refs/heads/main.zip) directly and build it with the
50
+ latest `zig` compiler, see `zig build --help` for build options:
51
+
52
+ ```sh
53
+ $ curl https://github.com/pkmn/engine/archive/refs/heads/main.zip -o engine.zip
54
+ $ unzip engine.zip
55
+ $ cd engine
56
+ $ zig build --prefix /usr/local -Doptimize=ReleaseFast
57
+ ```
58
+
59
+ The Zig website has [installation instructions](https://ziglang.org/learn/getting-started/) which
60
+ walk through how to install Zig on each platform - the engine code should work on Zig v0.13.0,
61
+ though tracks Zig's master branch so this may change in the future if breaking language changes are
62
+ introduced.
63
+
64
+ `libpkmn` can be built with `-Dshowdown` to instead produce the Pokémon Showdown compatible
65
+ `libpkmn-showdown` library. Furthermore, protocol message logging can be enabled through `-Dlog`.
66
+ The `libpkmn` and `libpkmn-showdown` objects available in the binary release are both compiled with
67
+ the `-Dlog` flag by default.
68
+
69
+ ### `@pkmn/engine`
70
+
71
+ The driver code can be installed from [npm](https://www.npmjs.com/package/@pkmn/engine):
72
+
73
+ ```sh
74
+ $ npm install @pkmn/engine
75
+ ```
76
+
77
+ The driver depends on being able to find compiled Node/WASM addons in
78
+ `node_modules/@pkmn/engine/build/lib` to be useful. When you install the package a [`postinstall`
79
+ lifecycle script](https://docs.npmjs.com/cli/v8/using-npm/scripts) runs
80
+ [`install-pkmn-engine`](src/bin/install-pkmn-engine) which checks for a compatible `zig` compiler
81
+ (see earlier regarding minimum version) and download one to `node_module/@pkmn/engine/build/bin` if
82
+ it can't find one, as well as looking for (and downloading, if necessary) the required Node headers
83
+ needed to successfully build the addons natively.
84
+
85
+ **If you have configured `npm` to `--ignore-scripts` you must either run `npx install-pkmn-engine`
86
+ directly or build the addons manually and place the artifacts in the expected paths.**
87
+
88
+ ### `pkmn`
89
+
90
+ To include `pkmn`, add it as a dependency in your project's
91
+ [`build.zig.zon`](https://github.com/ziglang/zig/blob/master/doc/build.zig.zon.md) using [Zig's
92
+ Package Management
93
+ system](https://ziglang.org/download/0.11.0/release-notes.html#Package-Management):
94
+
95
+
96
+ ```zig
97
+ .dependencies = .{
98
+ .pkmn = .{
99
+ .url = "https://github.com/pkmn/engine/archive/RELEASE.tar.gz",
100
+ },
101
+ },
102
+ ```
103
+
104
+ Replace `RELEASE` with the tag for the [release](https://github.com/pkmn/engine/releases) you wish
105
+ to use (e.g. `0.1.0` or `nightly`) or the specific hash of any commit. Next, run `zig build` and
106
+ copy the expected hash from the error message into your `build.zig.zon` alongside the `.url`:
107
+
108
+ ```sh
109
+ $ zig build
110
+ error: dependency is missing hash field
111
+ .url = "https://github.com/pkmn/engine/archive/nightly.tar.gz",
112
+ ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
113
+ note: expected .hash = "122056b93b403033cb7d9bed96a02c2eb8cc1275515976167726ada6eb4207e8ef8a",
114
+ ```
115
+
116
+ Note that this hash is **not** going to be the same as the commit hash. After adding the hash to
117
+ your `build.zig.zon` you will be able to import the `pkmn` package's build helpers into your
118
+ `build.zig`:
119
+
120
+ ```zig
121
+ const std = @import("std");
122
+
123
+ pub fn build(b: *std.Build) void {
124
+ ...
125
+ const pkmn = b.dependency("pkmn", .{ .showdown = true, .log = true });
126
+ exe.root_module.addImport("pkmn", pkmn.module("pkmn"));
127
+ ...
128
+ }
129
+ ```
130
+
131
+ The `pkmn` package can be configured with various options such as whether or not Pokémon Showdown
132
+ compatibility mode or protocol message logging should be enabled. Alternatively, you may set options
133
+ via a `pkmn_options` [root source file
134
+ declaration](https://ziglang.org/documentation/master/#Root-Source-File). There are several
135
+ undocumented internal options that can be tweaked as well via build or root options, though these
136
+ options aren't officially supported, affect correctness, and may change meaning or behavior without
137
+ warning. Use at your own risk.
138
+
139
+ ```zig
140
+ pub const pkmn_options = .{ .showdown = true, .log = true };
141
+ ```
142
+
143
+ ## Usage
144
+
145
+ For each Pokémon generation, the engine provides a battle structure with two functions - a function
146
+ to `update` the battle's state based on both players' choices and a function that defines which
147
+ `choices` are valid at that decision point (at the beginning of a battle both player's must "pass"
148
+ as their first choice to switch in the first member of their party). If `-Dlog` protocol logging is
149
+ enabled each update produces logs which can be decoded into a buffer (`LOGS_SIZE` constants are
150
+ provided to make it easy to allocate a buffer of the correct size). Each `update` returns a result
151
+ to indicate either that the battle has terminated or which types of choices are available for each
152
+ player.
153
+
154
+ Unlike [Pokémon Showdown's
155
+ SIM-PROTOCOL](https://github.com/smogon/pokemon-showdown/blob/master/sim/SIM-PROTOCOL.md#choice-requests)
156
+ which provides a rich request object at each decision point, the pkmn engine computes the possible
157
+ choices on demand based on the result of the previous `update` and the battle state (`CHOICES_SIZE`
158
+ is a good size to initialize the buffer passed to `choices`). **Attempting to update the battle with
159
+ a choice not present in the options returned by `choices` is undefined behavior and may corrupt
160
+ state or cause the engine to crash.**
161
+
162
+ Battles may be played out from any point but to freshly initialize a battle which is yet to start
163
+ the turn count and active Pokémon should be zeroed out (driver code should handle this for you).
164
+ Most driver code should also provide helpers to make initializing battle convenient - check the
165
+ respective documentation and examples for the bindings being used. The engine's [protocol
166
+ documentation](docs/PROTOCOL.md) goes into greater detail on the specifics of updates and the
167
+ potential logs that may result.
168
+
169
+ *The snippets below are meant to merely illustrate in broad strokes how the pkmn engine can be used
170
+ \- the [`examples`](examples) directory contains fully commented and runnable code.*
171
+
172
+ ### C
173
+
174
+ [`pkmn.h`](src/include/pkmn.h) exports the C API for `libpkmn`. Symbols are all prefixed with
175
+ `pkmn_` to avoid name collisions. If `-Dlog` is enabled and logging throws an error then the error
176
+ is encoded in the `pkmn_result` and can be checked with `pkmn_error`.
177
+
178
+ ```c
179
+ #include <pkmn.h>
180
+
181
+ pkmn_battle_options options;
182
+ pkmn_gen1_battle_options_set(&options, ...);
183
+ pkmn_battle battle = ...;
184
+
185
+ pkmn_result result;
186
+ pkmn_choice c1 = 0, c2 = 0;
187
+ while (!pkmn_result_type(result = pkmn_battle_update(&battle, c1, c2, &options))) {
188
+ c1 = choose(PKMN_PLAYER_P1, pkmn_result_p1(result));
189
+ c2 = choose(PKMN_PLAYER_P2, pkmn_result_p2(result));
190
+ pkmn_gen1_battle_options_set(&options, ...);
191
+ }
192
+ if (pkmn_error(result)) exit(1);
193
+ ```
194
+
195
+ [(full code)](examples/c/example.c)
196
+
197
+ The C API doesn't export any helpers for creating or accessing the opaque battle objects - it's
198
+ instead intended to be used as the foundation for more ergonomic bindings in [other
199
+ languages](#other) (the lack of namespaces and bit fields having an implementation-defined layout in
200
+ C are the main contributing factors to the sparseness of what `libpkmn` chooses to expose).
201
+
202
+ ### JavaScript / TypeScript
203
+
204
+ `@pkmn/engine` depends on the [`@pkmn/data`](https://www.npmjs.com/package/@pkmn/data) package which
205
+ requires a `Dex` implementation to be provided as well. The `Battle.create` function can be used to
206
+ initialize a `Battle` from the beginning, or `Battle.restore` can be used to re-instantiate a battle
207
+ which is already in progress. If logging is enabled the output can be turned into Pokémon Showdown
208
+ protocol via `Log.parse`.
209
+
210
+ ```ts
211
+ import {Dex} from '@pkmn/dex';
212
+ import {Generations} from '@pkmn/data';
213
+ import {Battle} from '@pkmn/engine';
214
+
215
+ const gens = new Generations(Dex);
216
+ const battle = Battle.create(...);
217
+
218
+ const choose = (n: number) => Math.random() * n;
219
+
220
+ let result: Result;
221
+ let c1: Choice, c2: Choice;
222
+ while (!(result = battle.update(c1, c2)).type) {
223
+ c1 = battle.choose('p1', result, choose);
224
+ c2 = battle.choose('p2', result, choose);
225
+ }
226
+
227
+ console.log(result);
228
+ ```
229
+
230
+ [(full code)](examples/js/example.ts)
231
+
232
+ By default, the `@pkmn/engine` package compiles the engine with `-Dshowdown`, though by running
233
+ `install-pkmn-engine` directly and passing in `--options` you can override this default and build
234
+ different configurations of the extension for the driver to use. The driver can support
235
+ configurations both with and without Pokémon Showdown compatibility simultaneously if present. On
236
+ update, the post-install script attempts to rebuild whichever extensions it finds with the same
237
+ configuration parameters that were originally used meaning updating to the newest version of the
238
+ library should be seamless.
239
+
240
+ Despite relying on the native engine code, the `@pkmn/engine` code is designed to also work in
241
+ browsers which support [WebAssembly](https://webassembly.org/). Running `npm run start:web` from the
242
+ [`examples`](examples/js) directory starts a server that can be used to demonstrate the engine
243
+ running in the browser.
244
+
245
+ ### Zig
246
+
247
+ The `pkmn` Zig package exposes helper methods to simplify state instantiation and any `Writer` can
248
+ be used when logging is enabled to allow for easily printing e.g. to standard out or a buffer.
249
+
250
+ ```zig
251
+ const std = @import("std");
252
+ const pkmn = @import("pkmn");
253
+
254
+ var random = std.Random.DefaultPrng.init(seed).random();
255
+ var choices: [pkmn.CHOICES_SIZE]pkmn.Choice = undefined;
256
+
257
+ var battle = ...
258
+ var options = pkmn.battle.options(...);
259
+
260
+ var c1 = pkmn.Choice{};
261
+ var c2 = pkmn.Choice{};
262
+
263
+ var result = try battle.update(c1, c2, &options);
264
+ while (result.type == .None) : (result = try battle.update(c1, c2, &options)) {
265
+ c1 = choices[random.uintLessThan(u8, battle.choices(.P1, result.p1, &choices))];
266
+ c2 = choices[random.uintLessThan(u8, battle.choices(.P2, result.p2, &choices))];
267
+ }
268
+
269
+ std.debug.print("{}\n", .{result.type});
270
+ ```
271
+
272
+ [(full code)](examples/zig/example.zig)
273
+
274
+ The Zig package also supports some APIs which are difficult to expose elsewhere such as the
275
+ `FixedRNG` which allows you to fully specify the exact RNG frames (which can be useful for ensuring
276
+ certain outcomes/effects always occur) for a battle, though doing so changes the size of the
277
+ `Battle` object.
278
+
279
+ ### Other
280
+
281
+ Developers who wish to use the engine in other languages should find writing bindings against
282
+ [`libpkmn`](#libpkmn) relatively straightforward based on the existing documentation, though to
283
+ simplify the process even further [`src/data`](src/data) contains JSON dumps of all of the Pokémon
284
+ data, structure sizes and offsets, and protocol information used by the reference driver code. The
285
+ following is a list of known `libpkmn` bindings written by developers outside of the [pkmn
286
+ organization](https://github.com/pkmn) that may be helpful (though note that these projects may not
287
+ necessarily be up-to-date/complete/correct - inclusion in this list doesn't imply endorsement):
288
+
289
+ | Language | License | URL |
290
+ | ---------- | --------- | ------------------------------------ |
291
+ | **C++** | `BSL-1.0` | https://github.com/pasyg/wrapsire |
292
+ | **Python** | `MIT` | https://github.com/AnnikaCodes/PyKMN |
293
+
294
+
295
+ #### `pkmn-debug`
296
+
297
+ The [`@pkmn/engine`](#pkmnengine) package ships with a `pkmn-debug` tool which exists to decode the
298
+ binary data structures and protocols used by the engine and to output a [standalone
299
+ webpage](https://pkmn.cc/debug.html) that can be used for debugging. To use this tool in a folder
300
+ that has the `@pkmn/engine` package installed locally you can use `npx pkmn-debug`, though you may
301
+ also wish to install the package globally to be able to use this tool anywhere without
302
+ [`npx`](https://docs.npmjs.com/cli/v7/commands/npx):
303
+
304
+ ```sh
305
+ $ npm install --global @pkmn/engine
306
+ ```
307
+
308
+ By default, `pkmn-debug` expects to read [binary debug protocol](docs/PROTOCOL.md#debugging) from
309
+ [standard input](https://en.wikipedia.org/wiki/Standard_streams) and output HTML to standard output:
310
+
311
+ ```sh
312
+ $ <cmd> | pkmn-debug > index.html
313
+ ```
314
+
315
+ Alternatively, if a single filename argument is passed to the `pkmn-debug` it reads from that
316
+ instead:
317
+
318
+ ```sh
319
+ $ pkmn-debug <file> > index.html
320
+ ```
321
+
322
+ ## Status
323
+
324
+ The engine is currently expected to be developed over multiple stages:
325
+
326
+ | Stage | Deliverables |
327
+ | ------- | ----------------------------------------------- |
328
+ | **0** | documentation, integration, benchmark, protocol |
329
+ | **1** | RBY & GSC |
330
+ | **2** | ADV & DPP |
331
+ | ***3*** | *modern generations* |
332
+
333
+ Currently, most of the foundational work from stage 0 is done:
334
+
335
+ - [benchmark and integration testing](src/test) infrastructure
336
+ - [documentation](docs) about design, research, methodology, etc
337
+ - definition and implementation of the [protocol](docs/PROTOCOL.md) that's used by the engine
338
+
339
+ **Stage 1 is currently in progress** and involves the implementation of the actual Generation I & II
340
+ battle engines, followed by Generation III & IV in stage 2. The implementation of further Pokémon
341
+ generations is in scope for the project but shouldn't be considered part of the immediate roadmap
342
+ (i.e. exploring the options for broadening support for old generation APIs is given higher priority
343
+ than implementing more modern generations). Furthermore, implementation of modern generations is
344
+ soft-blocked on the [availability of high quality
345
+ decompilations](https://github.com/orgs/pret/repositories) of the original games in question.
346
+
347
+ Certain features will always be deemed **out of scope**:
348
+
349
+ - team/set validation or custom rule ("format") enforcement
350
+ - first-class support for "mods" to core Pokémon data and mechanics
351
+ - [battle variants](https://bulbapedia.bulbagarden.net/wiki/Pok%C3%A9mon_battle#Battle_variants)
352
+ other than single (full) or double battles
353
+ - code for exposing the engine to users (input validation, game socket server, etc)
354
+
355
+ ## License
356
+
357
+ The pkmn engine is distributed under the terms of the [MIT License](LICENSE).
358
+
359
+ [^1]: In the case of Pokémon Showdown, only bugs which stem from a misimplementation of specific
360
+ effects are reproduced in the engine, bugs which are the result of a misunderstanding of the
361
+ fundamental mechanics of Pokémon or which simply arise due to specific Pokémon Showdown
362
+ implementation details that aren't replicable without making the same (incorrect) architectural
363
+ choices aren't. Furthermore, the "Pokémon Showdown" code referenced by this project includes
364
+ several [patches](docs/TESTING.md#patches) to improve accuracy and smooth over some of the more
365
+ egregious implementation issues. In practical terms, the vast majority of games played out in the
366
+ pkmn engine's compatibility mode and on this patched Pokémon Showdown simulator are the same,
367
+ it's only in a well defined and documented set of circumstances where the two implementations
368
+ diverge.
@@ -0,0 +1,7 @@
1
+ import { Choice, Player, Result } from '.';
2
+ export declare function check(showdown: boolean): void;
3
+ export declare function supports(showdown: boolean, log?: boolean): boolean;
4
+ export declare function update(index: number, showdown: boolean, battle: ArrayBuffer, c1?: Choice, c2?: Choice, log?: ArrayBuffer): Result;
5
+ export declare function choices(index: number, showdown: boolean, battle: ArrayBuffer, player: Player, choice: Choice['type'], buf: ArrayBuffer): Choice[];
6
+ export declare function choose(index: number, showdown: boolean, battle: ArrayBuffer, player: Player, choice: Choice['type'], buf: ArrayBuffer, fn: (n: number) => number): Choice;
7
+ export declare function size(index: number, type: 'choices' | 'log'): number;
@@ -0,0 +1,111 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __importStar = (this && this.__importStar) || function (mod) {
19
+ if (mod && mod.__esModule) return mod;
20
+ var result = {};
21
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
+ __setModuleDefault(result, mod);
23
+ return result;
24
+ };
25
+ Object.defineProperty(exports, "__esModule", { value: true });
26
+ exports.check = check;
27
+ exports.supports = supports;
28
+ exports.update = update;
29
+ exports.choices = choices;
30
+ exports.choose = choose;
31
+ exports.size = size;
32
+ const path = __importStar(require("path"));
33
+ const _1 = require(".");
34
+ const ROOT = path.join(__dirname, '..', '..');
35
+ let ADDON = undefined;
36
+ function load() {
37
+ if (ADDON)
38
+ return ADDON;
39
+ let pkmn = undefined;
40
+ let showdown = undefined;
41
+ try {
42
+ pkmn = require(path.join(ROOT, 'build', 'lib', 'pkmn.node')).engine;
43
+ }
44
+ catch { }
45
+ try {
46
+ showdown =
47
+ require(path.join(ROOT, 'build', 'lib', 'pkmn-showdown.node')).engine;
48
+ }
49
+ catch { }
50
+ if (!pkmn && !showdown) {
51
+ throw new Error('Could not find native addons - did you run `npx install-pkmn-engine`?');
52
+ }
53
+ return (ADDON = [pkmn, showdown]);
54
+ }
55
+ function check(showdown) {
56
+ if (!load()[+showdown]) {
57
+ const opts = ADDON[+!showdown].options.log ? ['-log'] : [];
58
+ if (showdown)
59
+ opts.push('-Dshowdown');
60
+ throw new Error(`@pkmn/engine has ${showdown ? 'not' : 'only'} been configured to support Pokémon Showdown.` +
61
+ `\n(running \`npx install-pkmn-engine --options='${opts.join(' ')}'\` can fix this issue).`);
62
+ }
63
+ }
64
+ function supports(showdown, log) {
65
+ if (!load()[+showdown])
66
+ return false;
67
+ if (log === undefined)
68
+ return true;
69
+ return ADDON[+showdown].options.log === log;
70
+ }
71
+ function update(index, showdown, battle, c1, c2, log) {
72
+ return _1.Result.decode(ADDON[+showdown].bindings[index]
73
+ .update(battle, _1.Choice.encode(c1), _1.Choice.encode(c2), log));
74
+ }
75
+ function choices(index, showdown, battle, player, choice, buf) {
76
+ const request = choice[0] === 'p' ? 0 : choice[0] === 'm' ? 1 : 2;
77
+ const n = ADDON[+showdown].bindings[index].choices(battle, +(player !== 'p1'), request, buf);
78
+ // The top-level API signature means our hands our tied with respect to
79
+ // writing really fast bindings here. The simplest approach would be to return
80
+ // the ArrayBuffer the bindings populate as well as its size and only decode a
81
+ // Choice after the selection. However, given that we need to return
82
+ // `Choices[]` we need to decode all of them even if they're not all being
83
+ // used which is wasteful. This shouldn't be *that* bad as its a very small
84
+ // list, but its still wasted work. Switching the top-level API to return an
85
+ // Iterable<Choice> doesn't help as we need both the length and the ability to
86
+ // randomly access it, so the best way to make the current API fast would be
87
+ // to have the Zig bindings create Choice objects directly, only that won't
88
+ // scale well as it would require us to basically rewrite the low-level
89
+ // choices function for each generation within node.zig. We could do something
90
+ // really galaxy-brained and return some sort of frankenstein subclass of
91
+ // Array backed by ArrayBuffer which would lazily decode the Choice on access,
92
+ // but thats ultimately not worth the effort. You can't have both a high-level
93
+ // idiomatic API and performance here, hence why the choose function below
94
+ // exists.
95
+ const options = new Array(n);
96
+ const data = new Uint8Array(buf);
97
+ for (let i = 0; i < n; i++)
98
+ options[i] = _1.Choice.decode(data[i]);
99
+ return options;
100
+ }
101
+ function choose(index, showdown, battle, player, choice, buf, fn) {
102
+ const request = choice[0] === 'p' ? 0 : choice[0] === 'm' ? 1 : 2;
103
+ const n = ADDON[+showdown].bindings[index].choices(battle, +(player !== 'p1'), request, buf);
104
+ const data = new Uint8Array(buf);
105
+ return _1.Choice.decode(data[fn(n)]);
106
+ }
107
+ function size(index, type) {
108
+ const bindings = (ADDON[1] ?? ADDON[0]).bindings[index];
109
+ return type[0] === 'c' ? bindings.CHOICES_SIZE : bindings.LOGS_SIZE;
110
+ }
111
+ //# sourceMappingURL=addon.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"addon.js","sourceRoot":"","sources":["../../src/pkg/addon.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAqCA,sBASC;AAED,4BAIC;AAED,wBAUC;AAED,0BA+BC;AAED,wBAaC;AAED,oBAGC;AArHD,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,CAAC;QACH,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,MAAyB,CAAC;IACzF,CAAC;IAAC,MAAM,CAAC,CAAC,CAAC;IACX,IAAI,CAAC;QACH,QAAQ;YACN,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,oBAAoB,CAAC,CAAC,CAAC,MAAwB,CAAC;IAC5F,CAAC;IAAC,MAAM,CAAC,CAAC,CAAC;IACX,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;IAC3F,CAAC;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,CAAC;QACvB,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;IACJ,CAAC;AACH,CAAC;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;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;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;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;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,CAAC,CAAC;IAC3D,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC;AACtE,CAAC"}