Showdown Boilerplate is a template for Pokémon Showdown private servers.
What is a boilerplate? Boilerplate is any text that is or can be reused in new contexts or applications without being greatly changed from the original.
This repository contains the files needed to set up your own Pokémon Showdown server with all the amazing stuff that private Pokémon Showdown servers like Origin, EOS, Frost, Azure or Pandora has.
For more information on Pokémon Showdown, visit the main Pokémon Showdown repository.
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][5]. Note that some internet providers don't let you host a server at all, in which case you'll have to rent a VPS to use as a server.
- Numerous cool commands such as /urbandefine or /poof
- Emoticons in chat and private messages
- Hangman, Profile, and Tells
- Economy (bucks system, shop, tournament winnings)
(Requires Node.js 8+)
$ git clone https://github.com/CreaturePhil/Showdown-Boilerplate.git
$ cd Showdown-Boilerplate && npm install
$ node app.jsPokémon Showdown requires you to have Node.js installed, 8.x or later (7.7 or later can work, but you might as well be on the latest stable).
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 "Clone or download" button near the top right (it's green). I recommend the "Open in Desktop" method - you need to install GitHub Desktop which is more work than "Download ZIP", but it makes it much easier to update in the long run (it lets you use the /updateserver command).
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.
Once your server is up, you probably want to make yourself an Administrator (~) on it.
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 /globaladmin, /globalleader, /globalmod, etc commands.
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.
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.
If you'd like to contribute to programming and don't know where to start, feel free to check out Ideas for New Developers.
Pokémon Showdown's server is distributed under the terms of the MIT License.
Owner
- Guangcong Luo [Zarel] - Development, Design, Sysadmin
Staff
- Chris Monsanto [chaos] - 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
- Hugh Gordon [V4] - Research (game mechanics), Development
- Juanma Serrano [Joim] - Development, Sysadmin
Major Contributors
- Bär Halberkamp [bumbadadabum] - Development
- Kevin Lau [Ascriptmaster] - Development, Art (battle animations)
- Konrad Borowski [xfix] - Development
- Quinton Lee [sirDonovan] - Development
Contributors
- Andrew Goodsell [Zracknel] - Art (battle weather backdrops)
- Avery Zimmer [Lyren, SolarisFox] - Development
- Ben Davies [Morfent] - Development
- Ben Frengley [TalkTakesTime] - Development
- Cody Thompson [Rising_Dusk] - Development
- Ian Clail [Layell] - Art (battle graphics, sprites)
- Jeremy Piemonte [panpawn] - Development
- Kris Johnson [Kris] - Development
- Neil Rashbrook [urkerab] - Development
- Robin Vandenbrande [Quinella] - Development
- [Ridaz] - Art (battle animations)
- Tobias Mann [asgdf] - Development
Special thanks