Skip to content

Latest commit

 

History

History
 
 

sim

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
examples
examples
 
 
tools
tools
 
 
DEX.md
DEX.md
 
 
NONSTANDARD.md
NONSTANDARD.md
 
 
README.md
README.md
 
 
SIM-PROTOCOL.md
SIM-PROTOCOL.md
 
 
SIMULATOR.md
SIMULATOR.md
 
 
TEAMS.md
TEAMS.md
 
 
battle-actions.ts
battle-actions.ts
 
 
battle-queue.ts
battle-queue.ts
 
 
battle-stream.ts
battle-stream.ts
 
 
battle.ts
battle.ts
 
 
dex-abilities.ts
dex-abilities.ts
 
 
dex-conditions.ts
dex-conditions.ts
 
 
dex-data.ts
dex-data.ts
 
 
dex-formats.ts
dex-formats.ts
 
 
dex-items.ts
dex-items.ts
 
 
dex-moves.ts
dex-moves.ts
 
 
dex-species.ts
dex-species.ts
 
 
dex.ts
dex.ts
 
 
field.ts
field.ts
 
 
global-types.ts
global-types.ts
 
 
index.ts
index.ts
 
 
pokemon.ts
pokemon.ts
 
 
prng.ts
prng.ts
 
 
side.ts
side.ts
 
 
state.ts
state.ts
 
 
team-validator.ts
team-validator.ts
 
 
teams.ts
teams.ts
 
 
tsconfig.json
tsconfig.json
 
 

README.md

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