mirror of https://github.com/smogon/pokemon-showdown.git synced 2026-05-18 03:01:00 -05:00

Pokémon battle simulator.

Go to file

Bill Meltsner eaeb2e8bfd Upgrade rule messages.		2012-03-29 01:22:37 -05:00
config	Report joins/leaves as deltas only:	2012-03-02 08:14:51 -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	Implement Soundproof.	2012-03-28 16:46:32 -05:00
app.js	Forgot a pipe.	2012-03-29 00:50:17 -05:00
chat-commands.js	THIS IS HUGE: Groups are now preserved	2012-03-27 03:47:36 -04:00
doc.txt	Add the new event documentation.	2012-03-26 01:54:25 -04:00
formats.js	Upgrade rule messages.	2012-03-29 01:22:37 -05:00
items.js	Sticky Barb jumping to another Pokemon should not be stopped by Sheer Force (but still stopped by Substitute).	2012-03-25 13:57:55 -05:00
learnsets.js	Implement CAP learnsets correctly	2012-02-08 21:19:57 -05:00
movedex.js	Flag punching moves so that they get boosted by Iron Fist.	2012-03-28 22:25:13 -05:00
old-doc.txt	Add the new event documentation.	2012-03-26 01:54:25 -04: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	Mention singles only in README	2012-03-28 23:32:43 -04:00
scripts.js	Correct location of pipe in move kwargs	2012-03-29 01:57:56 -04:00
simulator.js	remove hardcoded side IDs	2012-03-29 01:22:37 -05:00
statuses.js	Confusion is ???-type.	2012-03-25 20:40:59 -05:00
tiers.js	Rename the "Limbo" tier to "NFE", and re-tier its Pokemon to match Smogon's data.	2012-03-25 14:53:26 -05:00
tools.js	A first attempt at an implementation of Fling.	2012-03-22 01:00:42 -04:00
typechart.js	Give Steel a type immunity to the 'poisoned' status	2012-02-24 02:17:32 -05:00
users.js	Prevent users from changing their nicknames while participating in a rated battle.	2012-03-28 03:43:41 -05:00

README.md

Showdown

Showdown is a simulator of Pokemon battles. It currently only supports singles battles in 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

You can also specify a port:

node app.js 8000

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. Some browser setups might prevent this sort of connection, however (NoScript, for instance). If you can't get connecting locally to work in Firefox, try Chrome.

The reason your server is visited through play.pokemonshowdown.com is to make it more difficult for servers to see a user's password in any form, by handling logins globally. I realize that you might want your own login server and client hosted outside the pokemonshowdown.com domain, and I'll look more deeply into how to facilitate that when we're closer to leaving beta.

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.