pokemon-showdown-client/README.md
2013-01-23 16:39:14 -08:00

1.4 KiB

Pokemon Showdown Client

This is a repository for some of the client code for Pokemon Showdown.

This is what runs play.pokemonshowdown.com.

WARNING: You probably want the Pokemon Showdown server.

Setup

This repository is not "batteries included". It does NOT include everything necessary to run a Pokemon 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 Pokemon 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 Pokemon Showdown's client.

License

Pokemon Showdown's client is distributed under the terms of the AGPLv3.