|
Some checks are pending
Node.js CI / build (18.x) (push) Waiting to run
* Make "All Pokemon" rules more convenient Previously, "+All Pokemon" did nothing except override "-All Pokemon", which switched from a default-allow to default-deny system. They still do that, but they now also override all previous pokemon bans/unbans. This makes it easier to replace a banlist/whitelist from an inherited ruleset without needing to reverse every previous ban/unban. This also adds an error if you use `+All Pokemon` in a ruleset where it doesn't do anything. Fixes #10772 |
||
|---|---|---|
| .. | ||
| examples | ||
| tools | ||
| battle-actions.ts | ||
| battle-queue.ts | ||
| battle-stream.ts | ||
| battle.ts | ||
| dex-abilities.ts | ||
| dex-conditions.ts | ||
| dex-data.ts | ||
| dex-formats.ts | ||
| dex-items.ts | ||
| dex-moves.ts | ||
| dex-species.ts | ||
| DEX.md | ||
| dex.ts | ||
| field.ts | ||
| global-types.ts | ||
| index.ts | ||
| NONSTANDARD.md | ||
| pokemon.ts | ||
| prng.ts | ||
| README.md | ||
| side.ts | ||
| SIM-PROTOCOL.md | ||
| SIMULATOR.md | ||
| state.ts | ||
| team-validator.ts | ||
| TEAMS.md | ||
| teams.ts | ||
| tsconfig.json | ||
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