Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 2.22 KB

README.md

File metadata and controls

59 lines (40 loc) · 2.22 KB
Raw

Pokémon Showdown Client

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

This is what runs play.pokemonshowdown.com.

WARNING: You probably want the Pokémon Showdown server.

Testing

You can make and test client changes simply by opening testclient.html. This will allow you to test changes to the client without setting up your own login server.

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

Certain things will fail:

  • Registering
  • Changing name to a registered name other than the one you are currently logged in with (however, changing to an unregistered name will work, and you can even change back to your original registered name afterward)
  • The ladder tab
  • The /ladder command

Everything else can be tested, though.

Warning

This repository is not "batteries included". It does NOT include everything necessary to run a full Pokémon Showdown client.

In particular, it doesn't include a login/authentication server, nor does it include the database abstraction library used by the ladder library (although it's similar enough to mysqli that you can use that with minimal changes).

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

In other words, this repository is incomplete and NOT intended for people who wish to serve their own Pokémon Showdown client (you can, but it'll require you to rewrite some things). Rather, it's intended for people who wish to contribute and submit pull requests to Pokémon Showdown's client.

License

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

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