gem-hunter

Navigation: Website | Server repository | Client repository | Dex repository

This is a repository for most of the client code for Pokémon Showdown.

This is what runs play.pokemonshowdown.com.

WARNING: You probably want the Pokémon Showdown server, if you're setting up a server.

Pokémon Showdown currently supports, in order of preference:

• Chrome
• Chromium browsers (Edge, Vivaldi, Brave, Opera...)
• Firefox
• Safari 5+
• IE11+ and Edge
• Chrome/Firefox/Safari for various mobile devices
• any remotely modern browser

Pokémon Showdown is usable, but expect degraded performance and certain features not to work in extremely legacy browsers like:

• Safari 4
• IE9-10

Pokémon Showdown is mostly developed on Chrome, and Chrome or the desktop client is required for certain features like dragging-and-dropping teams from PS to your computer. However, bugs reported on any supported browser will usually be fixed pretty quickly.

Development is proceeding on the client rewrite! The live version is available at https://play.pokemonshowdown.com/beta

Client testing requires a build step! Install the latest Node.js (we require v22 or later) and Git, and run node build (on Windows) or ./build (on other OSes) to build after each change.

(This will do a fast build with no checks. For tests, linting, and typechecking, you'll want to do npm test separately.)

You can make and test client changes simply by building after each change, and opening play.pokemonshowdown.com/testclient-new.html. This will allow you to test changes to the client without setting up your own login server.

For security reasons, browsers don't let other websites control PS, so they can't screw with your account, but it does make it harder to log in on the test client.

If you need a logged-in account, add a config/testclient-key.js file, with the contents:

const POKEMON_SHOWDOWN_TESTCLIENT_KEY = 'sid';

Replace sid with the contents of your actual PS sid cookie. You can quickly grab it from:

https://play.pokemonshowdown.com/testclient-key.php

Make sure to put it in config/ and not play.pokemonshowdown.com/config/.

You can connect to an arbitrary server by navigating to testclient-new.html?~~host:port. For example, to connect to a server running locally on port 8000, you can navigate to testclient-new.html?~~localhost:8000.

NOTE: Certain browsers will convert '?' to '%3F' when reading files off of the local filesystem. As a workaround, try using a different browser or serving the files locally first (ie. run npx http-server from the directory this README is in, then navigate in your browser to http://localhost:8080/testclient-new.html?~~localhost:8000).

Even with a test key, the following things will fail in testclient:

• Registering
• Logging into other accounts (you can still switch to other unregistered accounts and back, though)

Everything else can be tested.

This repository is not "batteries included". It does NOT include instructions to run a full Pokémon Showdown login server, and we will not provide them. Please do not ask for help on this; you will be turned away.

If you make a mistake hosting a login server, your users' passwords can get stolen, so we do not want anyone to host a login server unless they can figure out how to do it without help.

It also doesn't include several resource files (namely, the /audio/ and /sprites/ directories) for size reasons.

On the other hand, as long as you don't want to run your own login server, this repository contains everything you need to test changes to the client; just see the "Testing" section above.

Pokémon Showdown's client is distributed under the terms of the AGPLv3.

The reason is mostly because I don't want low-effort proprietary forks that add bad code that steals everyone's passwords, or something like that.

If you're doing anything else other than forking, especially if you want to some client code files in your own open-source project that you want to release under a more permissive license (like, if you want to make your own multiplayer open-source game client for a different game), please ask at staff@pokemonshowdown.com. I hold all the copyright to the AGPLv3 parts and can relicense them to MIT for you.

WARNING: This is NOT the same license as Pokémon Showdown's server.