Skip to content
Pokémon battle simulator.
JavaScript
Latest commit 5e3f1dc Jun 24, 2016 @ascriptmaster ascriptmaster committed with Tests: Update Weather tests for clarity and readability (#2596)
Updated remaining Primal Weathers to the new APIs.

Updated misleading test cases relating to base power of moves in
Desolate Land / Primordial Sea.

Increased coverage on weather tests.
Failed to load latest commit information.
chat-plugins Fix crash in /host Jun 23, 2016
config Remove Doubles suspect test Jun 22, 2016
data Add Expert Belt alias (#2595) Jun 23, 2016
dev-tools Exit process when child process exits Feb 3, 2016
lib Some cleanup in /modlog Dec 9, 2014
logs Replace 'this.sendReply' with 'this.errorReply' in some cases Sep 27, 2015
mods Correct Wonder Guard message Jun 23, 2016
static Improve static files Sep 25, 2015
test Tests: Update Weather tests for clarity and readability (#2596) Jun 24, 2016
tournaments Fix code style a bit Jun 17, 2016
.eslintignore eslint: Manually skip ignored directories May 2, 2016
.eslintrc Lint: don't use config files in parent folders May 2, 2016
.gitattributes Normalize file endings when committing. Dec 31, 2015
.gitignore Modify data and mods files to follow style rules Jan 1, 2016
.travis.yml Revert "CI: Add Node 6" Jun 19, 2016
CONTRIBUTING.md Update CONTRIBUTING.md Mar 24, 2016
LICENSE License: Update copyright year to include 2016 Jan 3, 2016
PROTOCOL.md Update documentation of -ability message protocol Jul 27, 2015
Procfile Make Procfile specify Heroku's desired port May 16, 2012
README.md Update README Feb 21, 2016
app.js Register unhandled rejections in crashlogger May 13, 2016
battle-engine.js Fix Transform interaction with certain Abilities Jun 23, 2016
cidr.js Refactor for more ES6 features Feb 10, 2016
command-parser.js Store async commands being broadcast Jun 3, 2016
commands.js Full support for lock/ban reasons Jun 17, 2016
crashlogger.js Refactor for more ES6 features Feb 10, 2016
dnsbl.js Lint: Add miscellaneous extra rules Apr 25, 2016
ladders-remote.js Convert ladders-remote to the ES6 class syntax Mar 14, 2016
ladders.js Implement /rank for other servers Mar 2, 2016
loginserver.js Remove usage of Date|Function methods implemented by Sugar.js Mar 9, 2016
monitor.js Shim Array#includes May 4, 2016
old-simulator-doc.txt Update "Pokemon" to "Pokémon" in old-simulator-doc.txt file Jun 11, 2015
package.json Test: Dramatically increase coverage of choice parser Jun 16, 2016
pokemon-showdown Remove Object.values external dependency Mar 21, 2016
process-manager.js Split process manager class to its own file Mar 23, 2016
punishments.js Fix namelock and rephrase punishments Jun 23, 2016
repl.js Lint: Add miscellaneous extra rules Apr 26, 2016
room-game.js Follow all player renames in roomgames (#2538) Apr 30, 2016
rooms.js Support multiline /(room|staff)intro May 29, 2016
simulator-doc.txt Refactor types and remove ModifyPokemon Feb 16, 2016
simulator.js Implement partial decisions synchronization Jun 20, 2016
sockets.js Drop client->server messages over 100KB Jun 12, 2016
team-validator.js Fix crash with data searching commands May 26, 2016
tools.js Tools: Add a Tools#installFormat method Jun 17, 2016
users.js Very minor readability refactor in Users Jun 23, 2016
verifier.js Refactor Verifier to use the PM API Mar 23, 2016

README.md

Pokémon Showdown

Navigation: Website | Server repository | Client repository

Build Status Dependency Status devDependency Status

Introduction

This is the source code for the game server of Pokémon Showdown, a website for Pokémon battling. Pokémon Showdown simulates singles, doubles and triples battles in all the games out so far (Generations 1 through 6).

This repository contains the files needed to set up your own Pokémon Showdown server. Note that to set up a server, you'll also need a server computer.

You can use your own computer as a server, but for other people to connect to your computer, you'll need to expose a port (default is 8000 but you can choose a different one) to connect to, which sometimes requires port forwarding (note that this isn't possible on certain internet connections).

Installing

./pokemon-showdown

(Requires Node.js 4+)

Detailed installation instructions

Pokémon Showdown requires you to have Node.js installed, 4.x or later.

Next, obtain a copy of Pokémon Showdown. If you're reading this outside of GitHub, you've probably already done this. If you're reading this in GitHub, there's a "Save" icon button near the top right (next to "Download ZIP"), or if you're really lazy, you can use the "Download ZIP" button. I recommend the Save method - it's more time-consuming to set up, but much easier to update.

Pokémon Showdown is installed and run using a command line. In Mac OS X, open Terminal (it's in Utilities). In Windows, open Command Prompt (type cmd into the Start menu and it should be the first result). Type this into the command line:

cd LOCATION

Replace LOCATION with the location Pokémon Showdown is in (ending up with, for instance, cd "~/Downloads/Pokemon-Showdown" or cd "C:\Users\Bob\Downloads\Pokemon-Showdown\").

This will set your command line's location to Pokémon Showdown's folder. You'll have to do this each time you open a command line to run commands for Pokémon Showdown.

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

Congratulations, you're done setting up Pokémon Showdown.

Now, to start Pokémon Showdown, run the command:

node pokemon-showdown

(If you're not on Windows, we recommend doing ./pokemon-showdown instead.)

You can also specify a port:

node pokemon-showdown 8000

Visit your server at http://SERVER:8000

Replace SERVER with your server domain or IP. Replace 8000 with your port if it's not 8000 (the default port).

Yes, you can test even if you are behind a NAT without port forwarding: http://localhost:8000 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.

You will be redirected to http://SERVER.psim.us. The reason your server is visited through psim.us is to make it more difficult for servers to see a user's password in any form, by handling logins globally. You can embed this in an iframe in your website if the URL is a big deal with you.

If you truly want to host the client yourself, there is a repository for the Pokémon Showdown Client. It's not recommended for beginners, though.

Setting up an Administrator account

Once your server is up, you probably want to make yourself an Administrator (~) on it.

config/usergroups.csv

To become an Administrator, create a file named config/usergroups.csv containing

USER,~

Replace USER with the username that you would like to become an Administrator. Do not put a space between the comma and the tilde.

This username must be registered. If you do not have a registered account, you can create one using the Register button in the settings menu (it looks like a gear) in the upper-right of Pokémon Showdown.

Once you're an administrator, you can promote/demote others easily with the /admin, /leader, /mod, etc commands.

Browser support

Pokémon Showdown currently supports, in order of preference:

  • Chrome
  • Firefox
  • Opera
  • Safari 5+
  • IE11+
  • Chrome/Firefox/Safari for various mobile devices

Pokémon Showdown is usable, but expect degraded performance and certain features not to work in:

  • Safari 4+
  • IE9+

Pokémon Showdown is mostly developed on Chrome, and Chrome or the desktop client is required for certain features like dragging-and-dropping teams from PS to your computer. However, bugs reported on any supported browser will usually be fixed pretty quickly.

Community

PS has a built-in chat service. Join our main server to talk to us!

You can also visit the Pokémon Showdown forums for discussion and help.

License

Pokémon Showdown's server is distributed under the terms of the MIT License.

Credits

Owner

  • Guangcong Luo [Zarel] - Development, Design, Sysadmin

Staff

  • Chris Monsanto [chaos] - Sysadmin
  • Hugh Gordon [V4] - Research (game mechanics), Development
  • Juanma Serrano [Joim] - Development, Sysadmin
  • Leonardo Julca [Slayer95] - Development
  • Mathieu Dias-Martins [Marty-D] - Research (game mechanics), Development
  • [The Immortal] - Development

Retired Staff

  • Bill Meltsner [bmelts] - Development, Sysadmin
  • Cathy J. Fitzpatrick [cathyjf] - Development, Sysadmin

Major Contributors

  • Kevin Lau [Ascriptmaster] - Development, Art (battle animations)
  • Konrad Borowski [xfix] - Development
  • Quinton Lee [sirDonovan] - Development

Contributors

  • Andrew Goodsell [Zracknel] - Art (battle weather backdrops)
  • Bär Halberkamp [bumbadadabum] - Development
  • Ben Davies [Morfent] - Development
  • Ben Frengley [TalkTakesTime] - Development
  • Cody Thompson [Rising_Dusk] - Development
  • Ian Clail [Layell] - Art (battle graphics, sprites)
  • Jacob Zimmer [SolarisFox] - Development
  • Neil Rashbrook [urkerab] - Development
  • Robin Vandenbrande [Quinella] - Development
  • [Ridaz] - Art (battle animations)

Special thanks

Something went wrong with that request. Please try again.