pokemon-showdown/sim
livid washed 645bca826c
Revamp [Gen 8] Random Battle (#11993)
* Move old setgen system to BDSP file

* Set up the framework so that Gen 7 inherits from Gen 8 inherits from Gen 9 files

* Complete most of setgen

* Final items and stuff

* Final sets file

* Fix tests and other rands formats

* move isDoubles to the end of addMove()

* Fix Gen 1 Hackmons rule support

* Fix a couple things

* A couple more set tweaks

* update /randbats command

* lint

* typo

* Staller protect moves = lefties

* Simplify Psychic STAB enforcement on Sigilyph

* SD Garchomp should get Lum Berry, not Rocky Helmet

* Remove unnecessary remnants from gen 7 code

* Remove redundant status incompatibilities

* Simplify status/tspikes incompatibility

* Fix Dynamax User not generating

* Oops sorry

* Fix Rain Dance + Flip Turn Kingdra

* Ice Fang Dracovish is objectively bad

* improve role name

* let specs jynx exist

* I really need to exempt this

* I really need to exempt this

* Merge branch 'master' into gen8rev; fix merge conflicts
2026-05-04 21:20:08 -06:00
..
examples Update to ESLint 9 (#10926) 2025-02-25 20:03:46 -08:00
tools Implement Mega Stones as {key: value} pairs (#11684) 2026-01-08 14:59:22 -07:00
battle-actions.ts Champions: Fix Piercing Drill and Unseen Fist (#11917) 2026-04-11 23:55:02 -06:00
battle-queue.ts Gen 1: Implement move slot tracking (#11812) 2026-03-21 23:20:38 -07:00
battle-stream.ts Refactor editbattle not to use eval (#11898) 2026-04-07 13:58:01 -07:00
battle.ts Revert floor HP rounding for Smogon formats (#12001) 2026-05-01 12:21:48 -06:00
dex-abilities.ts Support inheritance of ability, item, and move conditions (#11754) 2026-03-19 03:44:48 -07:00
dex-conditions.ts Champions: Fix Piercing Drill and Unseen Fist (#11917) 2026-04-11 23:55:02 -06:00
dex-data.ts Implement Mega Stones as {key: value} pairs (#11684) 2026-01-08 14:59:22 -07:00
dex-formats.ts Move checks for obsolete FormatData fields to loader (#11931) 2026-04-14 13:27:24 -06:00
dex-items.ts Implement Champions (#11910) 2026-04-10 20:29:01 -06:00
dex-moves.ts Gen V: Fix Relic Song interaction with substitutes (#11573) 2026-04-18 19:25:46 -04:00
dex-species.ts Champions: Encore, Mega Sol and validations fixes (#11914) 2026-04-11 10:07:58 -06:00
DEX.md Move packed team docs out of PROTOCOL.md 2021-06-10 15:04:25 -07:00
dex.ts Fix AFD ability modding 2026-04-01 05:29:30 -07:00
field.ts Update to ESLint 9 (#10926) 2025-02-25 20:03:46 -08:00
global-types.ts Revamp [Gen 8] Random Battle (#11993) 2026-05-04 21:20:08 -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 Revert floor HP rounding for Smogon formats (#12001) 2026-05-01 12:21:48 -06: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 Fix Gen 1 multi-turn move interactions with Haze, Metronome and Mirror Move (#11859) 2026-04-05 02:43:15 -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 Finish server-side Champions changes 2026-04-10 20:38:50 -06:00
TEAMS.md Implement Champions (#11910) 2026-04-10 20:29:01 -06:00
teams.ts Implement Champions (#11910) 2026-04-10 20:29:01 -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