pokemon-showdown/sim
Karthik Bandagonda d3d834c91a
Allow Picked Team Size to be used without Team Preview (#11224)
* Add Pick Team rule

* Make Team Preview and Pick Team mutually exclusive

* Automatically apply rule if Picked Team Size exists without preview

* Remove mutually exclusive part

* Move teamsize to start action
2025-07-01 01:20:57 -06:00
..
examples Update to ESLint 9 (#10926) 2025-02-25 20:03:46 -08:00
tools Fix random typos (#11020) 2025-04-13 23:59:36 -07:00
battle-actions.ts Remove unused code (#11215) 2025-06-22 08:21:19 -07:00
battle-queue.ts Update to ESLint 9 (#10926) 2025-02-25 20:03:46 -08:00
battle-stream.ts TypeScript: Enable noImplicitOverride 2025-02-26 14:38:32 -08:00
battle.ts Allow Picked Team Size to be used without Team Preview (#11224) 2025-07-01 01:20:57 -06:00
dex-abilities.ts Support fuzzy searching /dt etc (#11124) 2025-05-23 00:26:23 -07:00
dex-conditions.ts Gen 3: Fix Magnet Pull not trapping allies (#11207) 2025-06-24 23:51:48 -04:00
dex-data.ts Dex: Update isName signature to match expected inputs (#11172) 2025-06-03 15:22:05 -07:00
dex-formats.ts Support fuzzy searching /dt etc (#11124) 2025-05-23 00:26:23 -07:00
dex-items.ts Support fuzzy searching /dt etc (#11124) 2025-05-23 00:26:23 -07:00
dex-moves.ts Remove unused code (#11215) 2025-06-22 08:21:19 -07:00
dex-species.ts Support fuzzy searching /dt etc (#11124) 2025-05-23 00:26:23 -07:00
DEX.md Move packed team docs out of PROTOCOL.md 2021-06-10 15:04:25 -07:00
dex.ts Add forme names as fuzzy matches 2025-05-30 19:54:00 -07:00
field.ts Update to ESLint 9 (#10926) 2025-02-25 20:03:46 -08:00
global-types.ts Add July 2025 rotational formats 2025-07-01 01:15:44 -06:00
index.ts Update to ESLint 9 (#10926) 2025-02-25 20:03:46 -08:00
NONSTANDARD.md Move packed team docs out of PROTOCOL.md 2021-06-10 15:04:25 -07:00
pokemon.ts Fix HP bar percentages and colours (#11213) 2025-06-25 14:14:46 -07:00
prng.ts Correctly support Node 18 2025-02-26 21:42:14 -08:00
README.md Slightly improve documentation 2021-11-13 14:17:47 -05:00
side.ts Sim: Emit requests after updates (#11105) 2025-05-15 20:30:02 -07:00
SIM-PROTOCOL.md SIM-PROTOCOL: Update for clarity 2025-05-13 13:29:53 -07:00
SIMULATOR.md Slightly improve sim docs for stdio usage 2024-01-17 21:23:20 -08:00
state.ts Remove useless spreads (#11132) 2025-05-24 16:19:48 -07:00
team-validator.ts Validator: Check if Smeargle is nonstandard instead of its tier (#11107) 2025-05-14 08:33:10 -07:00
TEAMS.md Update packed team Tera Type documentation (#9185) 2022-12-30 13:47:38 -06:00
teams.ts Add June Pet Mod of the Season: Fusion Evolution Random Battle (#11153) 2025-06-01 01:55:07 -06:00
tsconfig.json Migrate to esbuild for compilation (#9203) 2022-12-22 15:19:29 -06:00

Node.js package

Pokémon Showdown has a Node.js API. It currently only works in Node, not browsers, although we're working on unifying it to work in browsers.

You can install it with the usual:

npm install pokemon-showdown

And you can use it to do the following things:

Simulating battles

See: sim/SIMULATOR.md

Also available as a command-line API!

Validating, generating, and converting teams

See: sim/TEAMS.md

Also available as a command-line API!

Getting Pokédex information

See: sim/DEX.md

Undocumented APIs

Pokémon Showdown's Node.js package has TypeScript definitions for everything it exports, including a lot of undocumented APIs.

Please be aware that any undocumented API is unstable and should not be relied upon not to change. We do not follow semver for undocumented APIs. If you really want to use an undocumented API, remember to pin the exact PS version in your dependencies. You probably also want to follow the API update channel in the Discord server: https://psim.us/devdiscord