63f50f5b64
This required a new architecture for serving replays from inside the client repository, because that seems like a better call than introducing yet another PS repository. (Experience gives me the impression that separating repositories wasn't a good idea, and we should be working to make PS more mono-repo-like, rather than less.) License for replay code is tentatively AGPLv3, although feel free to ask for a more permissive license if you have plans to use it in an open-source project that requires it. |
||
|---|---|---|
| build-tools | ||
| config | ||
| data | ||
| desktop | ||
| fx | ||
| graphics-src | ||
| js | ||
| lib | ||
| replays | ||
| src | ||
| style | ||
| swf | ||
| test | ||
| .babelrc | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .gitignore | ||
| .htaccess | ||
| .npmrc | ||
| .travis.yml | ||
| action.php | ||
| ads.txt | ||
| apple-touch-icon.png | ||
| build | ||
| cache.manifest | ||
| composer.json | ||
| CONTRIBUTING.md | ||
| crossdomain.php | ||
| crossprotocol.html | ||
| customcss.php | ||
| favicon-16.png | ||
| favicon-32.png | ||
| favicon-48.png | ||
| favicon-128.png | ||
| favicon-192.png | ||
| favicon-256.png | ||
| favicon-notify.ico | ||
| favicon.ico | ||
| index.template.html | ||
| ladder.php | ||
| LICENSE | ||
| manifest.json | ||
| news-embed.php | ||
| package.json | ||
| pokemonshowdown.png | ||
| pokemonshowdown.psd | ||
| pokemonshowdownbeta.png | ||
| pokemonshowdownbeta@2x.png | ||
| preactalpha.template.html | ||
| README.md | ||
| recoverteams.html | ||
| robots.txt | ||
| showdown.crx | ||
| showdown.webapp | ||
| testclient-beta.html | ||
| testclient.html | ||
| tsconfig.json | ||
| tslint.json | ||
Pokémon Showdown Client
Navigation: Website | Server repository | Client repository | Dex repository
Introduction
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.
Testing
Client testing now requires a build step! Install the latest Node.js (we
require v10 or later), and run node build (on Windows) or ./build (on
other OSes) to build.
You can make and test client changes simply by building after each change,
and 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.
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.html?~~localhost:8000).
The following things will fail in testclient.html:
- 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)
Everything else can be tested, though.
Warning
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.
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.