mirror of https://github.com/smogon/pokemon-showdown.git synced 2026-05-31 21:02:23 -05:00

Pokémon battle simulator.

Go to file

Guangcong Luo a2c5a431e6 Fix infinite loop when trying to Trace Trace.		2012-02-12 06:42:47 -05:00
config	Add four new configuration options to prevent lag on large servers:	2012-02-08 18:22:49 -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 infinite loop when trying to Trace Trace.	2012-02-12 06:42:47 -05:00
app.js	Overhaul the battle timeout system.	2012-02-11 07:00:32 -05:00
chat-commands.js	Make moderated chat apply only to the lobby	2012-02-11 18:35:47 -05:00
doc.txt	Everything I did before moving to Git	2011-12-22 23:53:05 -05:00
formats.js	Remove '(ALPHA)' from Debug Mode's name, it's been beta like the rest of PS for a while now.	2012-02-05 17:47:15 -05:00
items.js	Make Red Card only activate for contact moves	2012-02-04 15:54:17 -05:00
learnsets.js	Implement CAP learnsets correctly	2012-02-08 21:19:57 -05:00
movedex.js	Overhaul Natural Gift to work properly (i.e. remove the berry) when the move misses or the target is immune.	2012-02-08 20:58:08 -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	Remove Delibird's sets - Delibird is only allowed in its holiday set during Christmas season.	2012-02-08 20:57:26 -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	CAP pokemon are now correctly level 74 instead of level 90.	2012-02-08 17:53:11 -05:00
simulator.js	Make Ingrain and Suction Cups prevent drag-out	2012-02-11 18:37:34 -05:00
statuses.js	Everything I did before moving to Git	2011-12-22 23:53:05 -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	DW Lucario got released, apparently	2012-02-10 23:49:34 -05:00
typechart.js	Everything I did before moving to Git	2011-12-22 23:53:05 -05:00
users.js	Some default avatars (todo: some way to save these longer-term)	2012-02-10 23:13:38 -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.