pokemon-showdown/sim
Yoshiblaze 9c4a4277fb
Add New Pet Mod of the Month: Do Not Use Random Battle (#11413)
* Change Scream Tail's ability

* Balls Random Battle: Initial Commit

* Fix errors

* fix 1 more error

* Team Generator Temp Fix + Add Broadcast

* actually add the broadcast message

* Add new Virus sprite

* Add new Virus sprite for real this time

* September PMOTM Initial Commit

* Fix errors

* Fix error

* Possible error fix + set adjustments

* Remove console.log

* Move Pet Mods to Column 2

* Update config/formats.ts

---------

Co-authored-by: Kris Johnson <11083252+KrisXV@users.noreply.github.com>
2025-08-31 23:38:13 -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 Fix OHKO moves in Gen 3 (#11355) 2025-08-11 14:16:09 -06:00
battle-queue.ts Fix comments for priority in the sim (#11385) 2025-08-24 13:19:27 -07:00
battle-stream.ts TypeScript: Enable noImplicitOverride 2025-02-26 14:38:32 -08:00
battle.ts Directly reference volatile when getting sourceEffect for partiallytrapped damage (#11360) 2025-08-14 11:46:02 -04:00
dex-abilities.ts Support fuzzy searching /dt etc (#11124) 2025-05-23 00:26:23 -07:00
dex-conditions.ts Always allow canceling a switch with Shed Shell (#11365) 2025-08-12 19:57:37 -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 Refactor Let's Go Normal Rules (#11324) 2025-08-04 20:48:27 -06: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 Fix forme tier inheritance 2025-08-09 12:45:16 -04: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 BDSP HOME relearner and fix BDSP event legality (#11374) 2025-08-27 12:15:59 -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 Trace message timing (#11282) 2025-08-13 14:11:49 -04: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 Implement Imprison disabling logic using Test Fight (#11208) 2025-07-22 02:09:45 -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 Add BDSP HOME relearner and fix BDSP event legality (#11374) 2025-08-27 12:15:59 -06:00
TEAMS.md Update packed team Tera Type documentation (#9185) 2022-12-30 13:47:38 -06:00
teams.ts Add New Pet Mod of the Month: Do Not Use Random Battle (#11413) 2025-08-31 23:38:13 -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