mirror of https://github.com/smogon/pokemon-showdown.git synced 2026-05-17 18:51:43 -05:00

Pokémon battle simulator.

Go to file

Guangcong Luo 4a7ca97ea0 Fix Assist failing way more often than it should		2012-02-21 18:35:16 -05:00
config	Add crash guard setting	2012-02-18 07:31:40 -05:00
logs	Convert logging.md to use CRLFs so Notepad can open it.	2012-02-11 02:16:25 -05:00
.gitignore	remove the node_modules folder from the repository and use package.json to define dependencies	2012-02-11 12:59:19 -05:00
abilities.js	Fix Magic Bounce and Magic Coat to bounce confusion-inducing moves	2012-02-13 10:43:50 -05:00
app.js	Add crash guard setting	2012-02-18 07:31:40 -05:00
chat-commands.js	Give mods (%) the ability to use /ip	2012-02-20 21:19:15 -05:00
doc.txt	Everything I did before moving to Git	2011-12-22 23:53:05 -05:00
formats.js	Add some ruleset legalities to Crobat	2012-02-14 22:28:47 -05:00
items.js	Fix White Herb and Simple interacting incorrectly	2012-02-13 10:41:42 -05:00
learnsets.js	Implement CAP learnsets correctly	2012-02-08 21:19:57 -05:00
movedex.js	Fix Assist failing way more often than it should	2012-02-21 18:35:16 -05:00
package.json	remove the node_modules folder from the repository and use package.json to define dependencies	2012-02-11 12:59:19 -05:00
pokedex.js	Commit entirety of pokedex.js	2012-02-16 15:19:18 -05:00
README.md	remove the node_modules folder from the repository and use package.json to define dependencies	2012-02-11 12:59:19 -05:00
scripts.js	Fix a crash from invalid template	2012-02-18 07:28:37 -05:00
simulator.js	Add .ban() to users	2012-02-15 17:03:29 -05:00
statuses.js	Make Fire moves thaw target, and certain moves thaw user	2012-02-18 07:29:25 -05:00
tiers.js	Update formats and tiers to put gen 4 and gen 5 CAPmons in separate tiers (and add Necturna's tier).	2012-02-04 15:57:30 -05:00
tools.js	Really make prevo move checking work correctly	2012-02-19 19:58:51 -05:00
typechart.js	Everything I did before moving to Git	2011-12-22 23:53:05 -05:00
users.js	Moderators can no longer alt check administrators' alts, and so on	2012-02-19 20:05:35 -05:00

README.md

Showdown

Showdown is a simulator of Pokemon battles. It currently only supports Generation 5 (Pokemon Black and Pokemon White).

Installing

Showdown requires Node.js and npm (which is installed by default with Node.js since v0.6.3).

Run npm install to install all necessary dependencies.

Copy config/config-example.js into config/config.js, and edit as you please.

After this, start Node:

cd <location of PS>
node app.js

Visit your server at http://play.pokemonshowdown.com/~~SERVER:PORT/

Replace SERVER with your server domain or IP, and PORT with the server's port. You can leave off :PORT if it is 8000 (the default).

Yes, you can test even if you are behind a NAT without port forwarding: http://play.pokemonshowdown.com/~~localhost/ will connect to your local machine.

Currently, this workflow works for testing Pokemon Showdown and testing your patches before submitting pull requests, but it ends up with somewhat ugly URLs. I'll make it easier to host your own server in the future, when we're closer to leaving beta.

The reason your server is visited through play.pokemonshowdown.com is to ensure that your server itself will not see any user's password in any form.

Browser support

Showdown currently supports, in order of preference:

Chrome
Firefox 4+
Safari
Safari for iPhone/iPod/iPad
Firefox for Android
IE9+

The built-in Android browser is not supported because of socket.io bug 651, but will be when that bug is fixed. In the meantime, Firefox for Android works.

IE8 has a few teambuilder issues that will be worked out when I have time.

I haven't looked into Opera much, but support for that is planned as long as it doesn't turn out to be too difficult.

As for older browsers (Firefox 3.6, IE7), I won't go out of my way to support them, but if there's a simple fix, you can suggest it to me and I'll implement it.