10bb83bf3c
- Method `this.runBroadcast()` has been split from `this.canBroadcast()`. It's now the only method handling command-usage and intended as the main API for synchronous commands. Async commands will execute both separately. Note that the `suppressMessage` parameter is now passed to `runBroadcast`. - The semantics of `broadcasting` have been similarly split. `this,broadcastMessage` will be set to a truthy value when `this.canBroadcast` is run. `this,broadcasting` will only be set to `true` once `this.runBroadcast` is executed. |
||
|---|---|---|
| chat-plugins | ||
| config | ||
| data | ||
| dev-tools | ||
| lib | ||
| logs | ||
| mods | ||
| static | ||
| test | ||
| tournaments | ||
| .eslintignore | ||
| .eslintrc | ||
| .gitattributes | ||
| .gitignore | ||
| .travis.yml | ||
| app.js | ||
| battle-engine.js | ||
| cidr.js | ||
| command-parser.js | ||
| commands.js | ||
| CONTRIBUTING.md | ||
| crashlogger.js | ||
| dnsbl.js | ||
| ladders-remote.js | ||
| ladders.js | ||
| LICENSE | ||
| loginserver.js | ||
| monitor.js | ||
| old-simulator-doc.txt | ||
| package.json | ||
| pokemon-showdown | ||
| process-manager.js | ||
| Procfile | ||
| PROTOCOL.md | ||
| README.md | ||
| repl.js | ||
| room-game.js | ||
| rooms.js | ||
| simulator-doc.txt | ||
| simulator.js | ||
| sockets-nocluster.js | ||
| sockets.js | ||
| team-validator.js | ||
| tools.js | ||
| users.js | ||
| verifier.js | ||
Pokémon Showdown
Navigation: Website | Server repository | Client repository
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